com.ibm.security.pkcs9
Class UnstructuredName

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

public final class UnstructuredName
extends PKCS9DerObject
implements Cloneable

Implements the ASN.1 UnstructuredName type.

An UnstructuredName attribute can have multiple attribute values.

UnstructuredName ::= IA5String

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


Fields inherited from class com.ibm.security.pkcsutil.PKCSDerObject
provider
 
Constructor Summary
UnstructuredName(byte[] der)
          Create an UnstructuredName object with a DER byte array.
UnstructuredName(byte[] der, String provider)
          Create an UnstructuredName object with a DER byte array.
UnstructuredName(String[] unstructurednames)
          Create an UnstructuredName object with an array of Strings.
UnstructuredName(String[] unstructurednames, String provider)
          Create an UnstructuredName object with an array of Strings.
UnstructuredName(String filename, boolean base64)
          Create an UnstructuredName with the filename of the DER-encoded or BASE64-encoded object.
UnstructuredName(String filename, boolean base64, String provider)
          Create an UnstructuredName with the filename of the DER-encoded or BASE64-encoded object.
 
Method Summary
 Object clone()
          Creates a clone of this UnstructuredName object.
protected  void decode(com.ibm.security.pkcs9.DerValue encoding)
          Initializes an UnstructuredName object from a DerValue.
 void encode(OutputStream os)
          Encodes this object to an OutputStream.
 boolean equals(Object obj)
          Determines if this UnstructuredName object is equivalent to the input object.
 String getAttributeName()
          Returns a String indicating the name of the attribute.
 ObjectIdentifier getObjectIdentifier()
          Returns the ObjectIdentifer for the UnstructuredName attribute.
 String[] getUnstructuredNames()
          Returns a copy of the string array of unstructured names.
 Object getValue()
          Calls the getUnstructuredNames method.
 boolean isSingleValued()
          Returns false.
 boolean isTagValid(byte tag)
          Returns a boolean indicating if the tag is valid for this object.
 String toString()
          Returns a string representation of this UnstructuredName 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

UnstructuredName

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

UnstructuredName

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

UnstructuredName

public UnstructuredName(String[] unstructurednames)
Create an UnstructuredName object with an array of Strings.
Parameters:
unstructurednames - String array of unstructured names.

UnstructuredName

public UnstructuredName(String[] unstructurednames,
                        String provider)
Create an UnstructuredName object with an array of Strings.
Parameters:
unstructurednames - String array of unstructured names.
unstructurednames - String array of unstructured names.

UnstructuredName

public UnstructuredName(String filename,
                        boolean base64)
                 throws IOException
Create an UnstructuredName 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.

UnstructuredName

public UnstructuredName(String filename,
                        boolean base64,
                        String provider)
                 throws IOException
Create an UnstructuredName 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 UnstructuredName object.
Overrides:
clone in class Object
Returns:
clone of this UnstructuredName object.

equals

public boolean equals(Object obj)
Determines if this UnstructuredName 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 UnstructuredName attribute.
Overrides:
getObjectIdentifier in class PKCSDerObject
Returns:
the ObjectIdentifer for the UnstructuredName 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.

getUnstructuredNames

public String[] getUnstructuredNames()
Returns a copy of the string array of unstructured names.
Returns:
String array of unstructured names.

getValue

public Object getValue()
Calls the getUnstructuredNames 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 false. UnstructuredName allows multiple attribute values.
Overrides:
isSingleValued in class PKCS9DerObject
Returns:
false

getAttributeName

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

toString

public String toString()
Returns a string representation of this UnstructuredName 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 an UnstructuredName object from a DerValue. The DER encoding must be in the format specified by the UnstructuredName ASN.1 notation.
Overrides:
decode in class PKCS9DerObject
Parameters:
encoding - a DER-encoded UnstructuredName object.
Throws:
IOException - on parsing error.