com.ibm.security.pkcs9
Class LocalKeyId

java.lang.Object
  |
  +--com.ibm.security.pkcsutil.PKCSDerObject
        |
        +--com.ibm.security.pkcs9.PKCS9DerObject
              |
              +--com.ibm.security.pkcs9.LocalKeyId

public final class LocalKeyId
extends PKCS9DerObject
implements Cloneable

Implements the ASN.1 LocalKeyId type.

A LocalKeyId attribute must have a single attribute value.

LocalKeyId ::= OCTET STRING

LocalKeyId objects are immutable; they cannot be changed once created.


Fields inherited from class com.ibm.security.pkcsutil.PKCSDerObject
provider
 
Constructor Summary
LocalKeyId(byte[] der)
          Create a LocalKeyId object with a DER byte array.
LocalKeyId(byte[] der, String provider)
          Create a LocalKeyId object with a DER byte array.
LocalKeyId(String filename, boolean base64)
          Create a LocalKeyId with the filename of the DER-encoded or BASE64-encoded object.
LocalKeyId(String filename, boolean base64, String provider)
          Create a LocalKeyId with the filename of the DER-encoded or BASE64-encoded object.
 
Method Summary
 Object clone()
          Creates a clone of this LocalKeyId object.
protected  void decode(com.ibm.security.pkcs9.DerValue encoding)
          Initializes a LocalKeyId object from a DerValue.
 void encode(OutputStream os)
          Encodes this object to an OutputStream.
 boolean equals(Object obj)
          Determines if this LocalKeyId object is equivalent to the input object.
 String getAttributeName()
          Returns a String indicating the name of the attribute.
 byte[] getLocalKeyId()
          Returns a copy of the Local Key Identifier as a byte array.
 ObjectIdentifier getObjectIdentifier()
          Returns the ObjectIdentifer for the LocalKeyId attribute.
 Object getValue()
          Calls the getLocalKeyId method.
 boolean isSingleValued()
          Returns true.
 boolean isTagValid(byte tag)
          Returns a boolean indicating if the tag is valid for this object.
 String toString()
          Returns a string representation of this LocalKeyId object.
 
Methods inherited from class com.ibm.security.pkcs9.PKCS9DerObject
getName, getOID, getPKCSAttribute
 
Methods inherited from class com.ibm.security.pkcsutil.PKCSDerObject
decode, decode, encode, hashCode, read, readBASE64, write, write, writeBASE64
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LocalKeyId

public LocalKeyId(byte[] der)
           throws IOException
Create a LocalKeyId object with a DER byte array.
Parameters:
der - a DER byte array of a LocalKeyId object.
Throws:
IOException - on decoding errors.

LocalKeyId

public LocalKeyId(byte[] der,
                  String provider)
           throws IOException
Create a LocalKeyId object with a DER byte array.
Parameters:
der - a DER byte array of a LocalKeyId object.
provider - the provider to be used.
Throws:
IOException - on decoding errors.

LocalKeyId

public LocalKeyId(String filename,
                  boolean base64)
           throws IOException
Create a LocalKeyId with the filename of the DER-encoded or BASE64-encoded object.
Parameters:
filename - name of the DER-encoded or base64-encoded object
base64 - true if BASE64-encoded, false if DER-encoded
Throws:
IOException - on decoding errors.

LocalKeyId

public LocalKeyId(String filename,
                  boolean base64,
                  String provider)
           throws IOException
Create a LocalKeyId with the filename of the DER-encoded or BASE64-encoded object.
Parameters:
filename - name of the DER-encoded or base64-encoded object
base64 - true if BASE64-encoded, false if DER-encoded
provider - the provider to be used
Throws:
IOException - on decoding errors.
Method Detail

clone

public Object clone()
Creates a clone of this LocalKeyId object.
Overrides:
clone in class Object
Returns:
clone of this LocalKeyId object.

equals

public boolean equals(Object obj)
Determines if this LocalKeyId object is equivalent to the input object.
Overrides:
equals in class PKCSDerObject
Parameters:
other - the object to compare this one to.
Returns:
true, if the two objects are equivalent, false otherwise.

getObjectIdentifier

public ObjectIdentifier getObjectIdentifier()
Returns the ObjectIdentifer for the LocalKeyId attribute.
Overrides:
getObjectIdentifier in class PKCSDerObject
Returns:
the ObjectIdentifer for the LocalKeyId attribute.

encode

public void encode(OutputStream os)
            throws IOException
Encodes this object to an OutputStream.
Overrides:
encode in class PKCSDerObject
Parameters:
os - the OutputStream to write the encoded data to.
Throws:
IOException - on encoding errors.

getLocalKeyId

public byte[] getLocalKeyId()
Returns a copy of the Local Key Identifier as a byte array.
Returns:
byte[] the local key identifier.

getValue

public Object getValue()
Calls the getLocalKeyId method. Standard method to access the value of the PKCS #9 object.
Overrides:
getValue in class PKCS9DerObject

isTagValid

public boolean isTagValid(byte tag)
Returns a boolean indicating if the tag is valid for this object.
Overrides:
isTagValid in class PKCS9DerObject
Returns:
true if tag_IA5String, false otherwise.

isSingleValued

public boolean isSingleValued()
Returns true. LocalKeyId must have a single attribute value.
Overrides:
isSingleValued in class PKCS9DerObject
Returns:
true.

getAttributeName

public String getAttributeName()
Returns a String indicating the name of the attribute.
Overrides:
getAttributeName in class PKCS9DerObject
Returns:
name of the LocalKeyId attribute.

toString

public String toString()
Returns a string representation of this LocalKeyId object.
Overrides:
toString in class PKCSDerObject
Returns:
a string representation of this object.

decode

protected void decode(com.ibm.security.pkcs9.DerValue encoding)
               throws IOException
Initializes a LocalKeyId object from a DerValue. The DER encoding must be in the format specified by the LocalKeyId ASN.1 notation.
Overrides:
decode in class PKCS9DerObject
Parameters:
encoding - a DER-encoded LocalKeyId object.
Throws:
IOException - on parsing error.