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

    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

    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()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • 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:
      9
      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.