EncodedKeySpec (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • java.security.spec.EncodedKeySpec

• All Implemented Interfaces:
  KeySpec
  Direct Known Subclasses:
  PKCS8EncodedKeySpec, X509EncodedKeySpec

public abstract class EncodedKeySpec
extends Object
implements KeySpec
This class represents a public or private key in encoded format.
Since:
1.2
See Also:
Key, KeyFactory, KeySpec, X509EncodedKeySpec, PKCS8EncodedKeySpec

• • Constructor Summary

  Constructors

  Constructor	Description
  EncodedKeySpec(byte[] encodedKey)	Creates a new EncodedKeySpec with the given encoded key.

  • Method Summary

  All Methods Instance Methods Abstract Methods Concrete Methods

  Modifier and Type	Method	Description
  byte[]	getEncoded()	Returns the encoded key.
  abstract String	getFormat()	Returns the name of the encoding format associated with this key specification.

     * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../java/lang/Object.html#clone--), [equals](../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [hashCode](../../../java/lang/Object.html#hashCode--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [toString](../../../java/lang/Object.html#toString--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### EncodedKeySpec  
     public EncodedKeySpec(byte[] encodedKey)  
     Creates a new EncodedKeySpec with the given encoded key.  
     Parameters:  
     `encodedKey` \- the encoded key. The contents of the array are copied to protect against subsequent modification.  
     Throws:  
     `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if `encodedKey` is null.  

  • Method Detail

    * #### getEncoded  
    public byte[] getEncoded()  
    Returns the encoded key.  
    Returns:  
    the encoded key. Returns a new array each time this method is called.  
    * #### getFormat  
    public abstract [String](../../../java/lang/String.html "class in java.lang") getFormat()  
    Returns the name of the encoding format associated with this key specification.  
    If the opaque representation of a key (see [Key](../../../java/security/Key.html "interface in java.security")) can be transformed (see [KeyFactory](../../../java/security/KeyFactory.html "class in java.security")) into this key specification (or a subclass of it),`getFormat` called on the opaque key returns the same value as the`getFormat` method of this key specification.  
    Returns:  
    a string representation of the encoding format.

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, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.