com.ibm.security.pkcs12
Class SafeContentsBag

java.lang.Object
  |
  +--com.ibm.security.pkcsutil.PKCSDerObject
        |
        +--com.ibm.security.pkcs12.SafeContentsBag

public final class SafeContentsBag
extends PKCSDerObject
implements Bag, Cloneable

Implements a PKCS #12 SafeBag of type safeContentsBag.

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


Fields inherited from class com.ibm.security.pkcsutil.PKCSDerObject
provider
 
Constructor Summary
SafeContentsBag(byte[] der)
          Create a SafeContentsBag with a DER byte array.
SafeContentsBag(byte[] der, String provider)
          Create a SafeContentsBag with a DER byte array.
SafeContentsBag(SafeContents contents)
          Create a SafeContentsBag with the input SafeContents.
SafeContentsBag(SafeContents contents, String provider)
          Create a SafeContentsBag with the input SafeContents.
SafeContentsBag(String filename, boolean base64)
          Create a SafeContentsBag with the filename of the DER-encoded or BASE64-encoded object.
SafeContentsBag(String filename, boolean base64, String provider)
          Create a SafeContentsBag with the filename of the DER-encoded or BASE64-encoded object.
 
Method Summary
 Object clone()
          Creates a clone of this SafeContentsBag object.
protected  void decode(com.ibm.security.pkcs12.DerValue encoding)
          Initialize a SafeContentsBag object from an input stream.
 void encode(OutputStream out)
          Encodes this object to a DER OutputStream.
 boolean equals(Object other)
          Determines if this SafeContentsBag object is equivalent to the input object.
 byte[] getEncodedValue()
          Returns the DER-encoded contents of this object.
 String getName()
          Returns the common name for this bag type: "SafeContentsBag".
 ObjectIdentifier getObjectIdentifier()
          Returns a copy of the object identifier for this PKCS #12 bag.
 Object getValue()
          Returns a copy of the contents of this PKCS #12 bag.
 String toString()
          Returns a string representation of this SafeContentsBag object.
 
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

SafeContentsBag

public SafeContentsBag(byte[] der)
                throws IOException
Create a SafeContentsBag with a DER byte array.

SafeContentsBag

public SafeContentsBag(byte[] der,
                       String provider)
                throws IOException
Create a SafeContentsBag with a DER byte array.

SafeContentsBag

public SafeContentsBag(SafeContents contents)
Create a SafeContentsBag with the input SafeContents.
Parameters:
contents - a SafeContents object.

SafeContentsBag

public SafeContentsBag(SafeContents contents,
                       String provider)
Create a SafeContentsBag with the input SafeContents.
Parameters:
contents - a SafeContents object.
provider - the provider being used.

SafeContentsBag

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

SafeContentsBag

public SafeContentsBag(String filename,
                       boolean base64,
                       String provider)
                throws IOException
Create a SafeContentsBag 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 - a provider being used
Throws:
IOException - on decoding errors.
Method Detail

encode

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

getObjectIdentifier

public ObjectIdentifier getObjectIdentifier()
Returns a copy of the object identifier for this PKCS #12 bag.
Specified by:
getObjectIdentifier in interface Bag
Overrides:
getObjectIdentifier in class PKCSDerObject
Returns:
the ObjectIdentifier for this bag.

getValue

public Object getValue()
Returns a copy of the contents of this PKCS #12 bag. The type of the contents object is a SafeContents object.
Specified by:
getValue in interface Bag
Returns:
the contents for this bag.

getEncodedValue

public byte[] getEncodedValue()
Returns the DER-encoded contents of this object.
Specified by:
getEncodedValue in interface Bag
Returns:
the DER-encoded SafeContents of this bag. Null may be returned if the contents cannot be successfully encoded.

getName

public String getName()
Returns the common name for this bag type: "SafeContentsBag".
Specified by:
getName in interface Bag
Returns:
the name of this bag.

equals

public boolean equals(Object other)
Determines if this SafeContentsBag 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.

clone

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

toString

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

decode

protected void decode(com.ibm.security.pkcs12.DerValue encoding)
               throws IOException
Initialize a SafeContentsBag object from an input stream. The data on that input stream must be a DER-encoded SafeContents object.
Parameters:
encoding - an input stream with a DER-encoded SafeContents object.
Throws:
IOException - on parsing errors.