Class EncodedKeySpec

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:

Constructor Summary

EncodedKeySpec(byte[] encodedKey)

EncodedKeySpec(byte[] encodedKey,
 String algorithm)

Modifier	Constructor	Description
	Creates a new `EncodedKeySpec` with the given encoded key.
`protected`	Creates a new `EncodedKeySpec` with the given encoded key.

Method Summary

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 declared in class Object

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

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()`	Returns a string representation of the object.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

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 - if encodedKey is null.

EncodedKeySpec

protected EncodedKeySpec(byte[] encodedKey, String 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 AsymmetricKey Algorithms section in the Java Security Standard Algorithm Names Specification for information about standard asymmetric key algorithm names.

Throws:

NullPointerException - if encodedKey or algorithm is null.

IllegalArgumentException - if algorithm is the empty string ""

Since:

External Specifications

Method Details

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 (see KeyFactory) 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.

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.