EncodedKeySpec
abstract class EncodedKeySpec : KeySpec
| kotlin.Any | |
| ↳ | java.security.spec.EncodedKeySpec |
This class represents a public or private key in encoded format.
Summary
| Public constructors | |
|---|---|
EncodedKeySpec(encodedKey: ByteArray!)Creates a new |
|
| Protected constructors | |
|---|---|
EncodedKeySpec(encodedKey: ByteArray!, algorithm: String!)Creates a new |
|
| Public methods | |
|---|---|
| open String! |
Returns the name of the algorithm of the encoded key. |
| open ByteArray! |
Returns the encoded key. |
| abstract String! |
Returns the name of the encoding format associated with this key specification. |
Public constructors
EncodedKeySpec
EncodedKeySpec(encodedKey: ByteArray!)
Creates a new EncodedKeySpec with the given encoded key.
| Parameters | |
|---|---|
encodedKey |
ByteArray!: the encoded key. The contents of the array are copied to protect against subsequent modification. |
| Exceptions | |
|---|---|
java.lang.NullPointerException |
if encodedKey is null. |
Protected constructors
EncodedKeySpec
protected EncodedKeySpec(
encodedKey: ByteArray!,
algorithm: String!)
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 |
ByteArray!: 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. |
| Exceptions | |
|---|---|
java.lang.NullPointerException |
if encodedKey or algorithm is null. |
java.lang.IllegalArgumentException |
if algorithm is the empty string "" |
Public methods
getAlgorithm
open fun getAlgorithm(): String!
Returns the name of the algorithm of the encoded key.
| Return | |
|---|---|
String! |
the name of the algorithm, or null if not specified |
getEncoded
open fun getEncoded(): ByteArray!
Returns the encoded key.
| Return | |
|---|---|
ByteArray! |
the encoded key. Returns a new array each time this method is called. |
getFormat
abstract fun getFormat(): String!
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.
| Return | |
|---|---|
String! |
a string representation of the encoding format. |