EncodedKeySpec

public abstract class EncodedKeySpec
extends Object implements KeySpec

java.lang.Object
   ↳ java.security.spec.EncodedKeySpec


This class represents a public or private key in encoded format.

Summary

Public constructors

EncodedKeySpec(byte[] encodedKey)

Creates a new EncodedKeySpec with the given encoded key.

Protected constructors

EncodedKeySpec(byte[] encodedKey, String algorithm)

Creates a new EncodedKeySpec with the given encoded key.

Public methods

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.

Inherited methods

Public constructors

EncodedKeySpec

Added in API level 1
public EncodedKeySpec (byte[] encodedKey)

Creates a new EncodedKeySpec with the given encoded key.

Parameters
encodedKey byte: the encoded key. The contents of the array are copied to protect against subsequent modification.

Throws
NullPointerException if encodedKey is null.

Protected constructors

EncodedKeySpec

Added in API level 35
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 byte: the encoded key. The contents of the array are copied to protect against subsequent modification.

algorithm String: 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 if encodedKey or algorithm is null.
IllegalArgumentException if algorithm is the empty string ""

Public methods

getAlgorithm

Added in API level 35
public String getAlgorithm ()

Returns the name of the algorithm of the encoded key.

Returns
String the name of the algorithm, or null if not specified

getEncoded

Added in API level 1
public byte[] getEncoded ()

Returns the encoded key.

Returns
byte[] the encoded key. Returns a new array each time this method is called.

getFormat

Added in API level 1
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
String a string representation of the encoding format.