KeyStore.SecretKeyEntry (Java Platform SE 8 )
Keywords: java.security.KeyStore.SecretKeyEntry class
Date: 2017-01-22

compact1, compact2, compact3
java.security

## Class KeyStore.SecretKeyEntry

- java.lang.Object
- - java.security.KeyStore.SecretKeyEntry

- All Implemented Interfaces:
    KeyStore.Entry
  Enclosing class:
    KeyStore

      public static final class KeyStore.SecretKeyEntry
      extends Object
      implements KeyStore.Entry

  A `KeyStore` entry that holds a `SecretKey`.
  Since:
    1.5

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from interface java.security.KeyStore.Entry

      `KeyStore.Entry.Attribute`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `SecretKeyEntry(SecretKey secretKey)` Constructs a `SecretKeyEntry` with a `SecretKey`.
    `SecretKeyEntry(SecretKey secretKey, Set<KeyStore.Entry.Attribute> attributes)` Constructs a `SecretKeyEntry` with a `SecretKey` and associated entry attributes.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `Set<KeyStore.Entry.Attribute>` | `getAttributes()` Retrieves the attributes associated with an entry.
    `SecretKey` | `getSecretKey()` Gets the `SecretKey` from this entry.
    `String` | `toString()` Returns a string representation of this SecretKeyEntry.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### SecretKeyEntry

          public SecretKeyEntry(SecretKey secretKey)

      Constructs a `SecretKeyEntry` with a `SecretKey`.
      Parameters:
        `secretKey` - the `SecretKey`
      Throws:
        `NullPointerException` - if `secretKey` is `null`

    - #### SecretKeyEntry

          public SecretKeyEntry(SecretKey secretKey,
                                Set<KeyStore.Entry.Attribute> attributes)

      Constructs a `SecretKeyEntry` with a `SecretKey` and associated entry attributes.

      The specified `attributes` is cloned before it is stored in the new `SecretKeyEntry` object.

      Parameters:
        `secretKey` - the `SecretKey`
        `attributes` - the attributes
      Throws:
        `NullPointerException` - if `secretKey` or `attributes` is `null`
      Since:
        1.8

  - ### Method Detail

    - #### getSecretKey

          public SecretKey getSecretKey()

      Gets the `SecretKey` from this entry.
      Returns:
        the `SecretKey` from this entry

    - #### getAttributes

          public Set<KeyStore.Entry.Attribute> getAttributes()

      Retrieves the attributes associated with an entry.

      Specified by:
        `getAttributes` in interface `KeyStore.Entry`
      Returns:
        an unmodifiable `Set` of attributes, possibly empty
      Since:
        1.8

    - #### toString

          public String toString()

      Returns a string representation of this SecretKeyEntry.
      Overrides:
        `toString` in class `Object`
      Returns:
        a string representation of this SecretKeyEntry.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.