EncodedKeySpec (Java SE 10 & JDK 10 )
- 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 Modifier Constructor Description EncodedKeySpec(byte[] encodedKey)Creates a new
EncodedKeySpecwith the given encoded key.protectedEncodedKeySpec(byte[] encodedKey, String algorithm)Creates a new
EncodedKeySpecwith the given encoded key.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description StringgetAlgorithm()Returns the name of the algorithm of the encoded key.
byte[]getEncoded()Returns the encoded key.
abstract StringgetFormat()Returns the name of the encoding format associated with this key specification.
-
-
-
Constructor Detail
-
EncodedKeySpec
public EncodedKeySpec(byte[] encodedKey)
Creates a new
EncodedKeySpecwith the given encoded key.- Parameters:
encodedKey- the encoded key. The contents of the array are copied to protect against subsequent modification.- Throws:
NullPointerException- ifencodedKeyis null.
-
EncodedKeySpec
protected EncodedKeySpec(byte[] encodedKey, String algorithm)Creates a new
EncodedKeySpecwith the given encoded key. This constructor is useful when subsequent callers of theEncodedKeySpecobject 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 for information about standard algorithm names.- Throws:
NullPointerException- ifencodedKeyoralgorithmis null.IllegalArgumentException- ifalgorithmis the empty string""- Since:
- 9
-
-
Method Detail
-
getAlgorithm
public String 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 getFormat()
Returns the name of the encoding format associated with this key specification.
If the opaque representation of a key (see
Key) can be transformed (seeKeyFactory) into this key specification (or a subclass of it),getFormatcalled on the opaque key returns the same value as thegetFormatmethod 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, 2018, 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.