EncodedKeySpec (Java SE 9 & JDK 9 ) (original) (raw)

• java.lang.Object

• • java.security.spec.EncodedKeySpec

• All Implemented Interfaces:
  [KeySpec](../../../java/security/spec/KeySpec.html "interface in java.security.spec")
  Direct Known Subclasses:
  [PKCS8EncodedKeySpec](../../../java/security/spec/PKCS8EncodedKeySpec.html "class in java.security.spec"), [X509EncodedKeySpec](../../../java/security/spec/X509EncodedKeySpec.html "class in java.security.spec")

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

  Modifier	Constructor	Description
  	EncodedKeySpec​(byte[] encodedKey)	Creates a new EncodedKeySpec with the given encoded key.
  protected	EncodedKeySpec​(byte[] encodedKey,String algorithm)	Creates a new EncodedKeySpec with the given encoded key.

  • Method Summary

  All Methods Instance Methods Abstract Methods Concrete Methods

  Modifier and Type	Method	Description
  String	getAlgorithm​()	Returns the name of the algorithm of the encoded key.
  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.  
     * #### EncodedKeySpec  
     protected EncodedKeySpec​(byte[] encodedKey,  
                              [String](../../../java/lang/String.html "class in java.lang") algorithm)  
     Creates a new `EncodedKeySpec` with the given encoded key. This constructor is useful when subsequent callers of the`EncodedKeySpec` object might not know the algorithm of the key.  
     Parameters:  
     `encodedKey` \- the encoded key. The contents of the array are copied to protect against subsequent modification.  
     `algorithm` \- the algorithm name of the encoded key See the KeyFactory section in the [ Java Security Standard Algorithm Names Specification](../../../../specs/security/standard-names.html#keyfactory-algorithms) for information about standard algorithm names.  
     Throws:  
     `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if `encodedKey` or `algorithm` is null.  
     `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `algorithm` is the empty string `""`  
     Since:  
     9  

  • Method Detail

    * #### getAlgorithm  
    public [String](../../../java/lang/String.html "class in java.lang") getAlgorithm​()  
    Returns the name of the algorithm of the encoded key.  
    Returns:  
    the name of the algorithm, or null if not specified  
    Since:  
    9  
    * #### 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.

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.