OriginatorInfo ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- iaik.cms.OriginatorInfo

```
public class OriginatorInfo
extends java.lang.Object
```
This class represents the CMS type OriginatorInfo.
The CMS Cryptographic Message Syntax (RFC 2630) specifies the OriginatorInfo type to be used within the EnvelopedData or AuthenticatedData type for optionally including certificate and/or crl information of the originator if required by the key management protocol in use:
```
 OriginatorInfo ::= SEQUENCE {
   certs [0] IMPLICIT CertificateSet OPTIONAL,
   crls  [1] IMPLICIT CertificateRevocationLists OPTIONAL }
 
```
CertificateSet ::= SET OF CertificateChoices CertificateChoices ::= CHOICE { certificate Certificate, -- See X.509 extendedCertificate [0] IMPLICIT ExtendedCertificate, -- Obsolete attrCert [1] IMPLICIT AttributeCertificate } -- See X.509 & X9.57 }
CertificateRevocationLists ::= SET OF CertificateList
An application may use the empty #OriginatorInfo() default constructor for creating an OriginatorInfo object and later add {@link #setCertificates(Certificate[]) certificates} and/or {@link #setCRLs(X509CRL[]) crls} as required:
```
 OriginatorInfo originatorInfo = new OriginatorInfo();
 X509Certificate[] certs = ...;
 X509CRL[] crls = ...;
 originatorInfo.setCertificates(certs);
 originatorInfo.setCRLs(crls);
 
```
Attention! Only X.509 public key certificates (instances of iaik.x509.X509Certificate) or X.509 attribute certificates (instances of iaik.x509.attr.AttributeCertificate) can be added to an OriginatorInfo object; PKCS#6 extended certificates are obsolete and therefore not supported.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`OriginatorInfo()` Default constructor.
	`OriginatorInfo(ASN1Object obj)` Creates a new OriginatorInfo from its ASN.1 representation.
	`OriginatorInfo(java.io.InputStream is)` Creates a new OriginatorInfo from its DER encoding, read from the given InputStream.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`containsCertificates()` Looks if any certificates are included in this OriginatorInfo.
`boolean`	`containsCRLs()` Looks if any crls are included in this OriginatorInfo.
`void`	`decode(ASN1Object obj)` Decodes an OriginatorInfo from its ASN.1 representation.
`void`	`decode(java.io.InputStream is)` Reads and decodes the OriginatorInfo from DER encoding.
`AttributeCertificate[]`	`getAttributeCertificates()` Returns the attribute certificates included in this OriginatorInfo.
`X509Certificate`	`getCertificate(CertificateIdentifier certificateIdentifier)` Tries to find the originator certificate specified by the given CertificateIdentidier.
`java.security.cert.Certificate[]`	`getCertificates()` Returns all certificates included.
`CertificateSet`	`getCertificateSet()` Gets the certificateSet holding all certificates included in this OriginatorInfo.
`X509CRL[]`	`getCRLs()` Returns all the cerificate-revocation lists included in this `OriginatorInfo` object.
`X509Certificate[]`	`getX509Certificates()` Returns the X.509 public key certificates included.
`boolean`	`isEmpty()` Looks if this OriginatorInfo is empty.
`void`	`setCertificates(java.security.cert.Certificate[] certificates)` Sets the originator certificates.
`void`	`setCertificateSet(CertificateSet certSet)` Sets the certificateSet to be included.
`void`	`setCRLs(X509CRL[] crls)` Sets a set of cerificate-revocation lists.
`ASN1Object`	`toASN1Object()` Returns this OriginatorInfo as ASN1Object.
`java.lang.String`	`toString()` Returns a string giving some information about this `OriginatorInfo` object.
`void`	`writeTo(java.io.OutputStream os)` DER encodes and writes this object to the supplied output stream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OriginatorInfo
```
protected OriginatorInfo()
```
    Default constructor.
    Creates an empty OriginatorInfo object. Certificates and/or revocation lists may be added by calling method setCertificates or setCertificateSet and/or setCRLs as required:
```
 OriginatorInfo originatorInfo = new OriginatorInfo();
 X509Certificate[] certs = ...;
 X509CRL[] crls = ...;
 originatorInfo.setCertificates(certs);
 originatorInfo.setCRLs(crls);
 
```
    Attention! Only X.509 public key certificates (instances of iaik.x509.X509Certificate) or X.509 attribute certificates (instances of iaik.x509.attr.AttributeCertificate) can be added to an OriginatorInfo object; PKCS#6 extended certificates are obsolete and therefore not supported.
  - OriginatorInfo
```
public OriginatorInfo(java.io.InputStream is)
               throws CMSParsingException,
                      java.io.IOException
```
    Creates a new OriginatorInfo from its DER encoding, read from the given InputStream.
    
    Parameters:
    is - the InputStream holding a DER encoded CMS OriginatorInfo object
    
    Throws:
    
    java.io.IOException - if an I/O error occurs during reading from the InputStream
    
    CMSParsingException - if an error occurs while parsing the object
  - OriginatorInfo
```
public OriginatorInfo(ASN1Object obj)
               throws CMSParsingException
```
    Creates a new OriginatorInfo from its ASN.1 representation.
    
    Parameters:
    obj - the OriginatorInfo as ASN1Object
    
    Throws:
    
    CMSParsingException - if an error occurs while parsing the object
- Method Detail
  - decode
```
public void decode(java.io.InputStream is)
            throws java.io.IOException,
                   CMSParsingException
```
    Reads and decodes the OriginatorInfo from DER encoding.
    
    Parameters:
    is - the InputStream holding a DER encoded CMS OriginatorInfo object
    
    Throws:
    
    java.io.IOException - if an I/O error occurs during reading from the InputStream
    
    CMSParsingException - if an error occurs while parsing the object
  - decode
```
public void decode(ASN1Object obj)
            throws CMSParsingException
```
    Decodes an OriginatorInfo from its ASN.1 representation.
    
    Parameters:
    obj - the OriginatorInfo as ASN1Object
    
    Throws:
    
    CMSParsingException - if an error occurs while parsing the object
  - setCertificates
```
public void setCertificates(java.security.cert.Certificate[] certificates)
```
    Sets the originator certificates.
    Attention! Only X.509 public key certificates (instances of iaik.x509.X509Certificate) or X.509 attribute certificates (instances of iaik.x509.attr.AttributeCertificate) can be added to this OriginatorInfo object; PKCS#6 extended certificates are obsolete and therefore not supported.
    
    Parameters:
    certificates - the certificates to be set
    
    Throws:
    
    java.lang.IllegalArgumentException - if any of the supplied certificates is not a iaik.x509.X509Certificate or iaik.x509.attr.AttributeCertificate object
  - setCertificateSet
```
public void setCertificateSet(CertificateSet certSet)
```
    Sets the certificateSet to be included. This method provides an alternative way to set the certificates by immediately supplying a CertificateSet that may hold any number of X.509 public key and/or attribute certificates.
    Attention! Only X.509 public key certificates (instances of iaik.x509.X509Certificate) or X.509 attribute certificates (instances of iaik.x509.attr.AttributeCertificate) can be included in the given CertificateSet; PKCS#6 extended certificates are obsolete and therefore not supported.
    
    Parameters:
    certSet - the certificate set to be added
  - setCRLs
```
public void setCRLs(X509CRL[] crls)
```
    Sets a set of cerificate-revocation lists.
    The given CRLs supply information about the revocation status of the certificates specified in the certs field.
    
    Parameters:
    crls - a set of cerificate-revocation lists as array of X509CRLs
  - getCertificates
```
public java.security.cert.Certificate[] getCertificates()
```
    Returns all certificates included.
    Any certificate returned by this method either may be an X.509 public key certificate (iaik.x509.X509Certificate) or an X.509 attribute certificate (iaik.x509.attr.AttributeCertificate). PKCS#6 extended certificates are obsolete and therefore not supported.
    
    Returns:
    all certificates included; or null if no certificates are included
  - getX509Certificates
```
public X509Certificate[] getX509Certificates()
```
    Returns the X.509 public key certificates included.
    
    Returns:
    the X.509 public key certificates, or null if no X.509 certificates are included
  - getAttributeCertificates
```
public AttributeCertificate[] getAttributeCertificates()
```
    Returns the attribute certificates included in this OriginatorInfo.
    
    Returns:
    an array containing all attribute certificates included in this OriginatorInfo, or null if no attribute certificates are included
  - getCertificateSet
```
public CertificateSet getCertificateSet()
```
    Gets the certificateSet holding all certificates included in this OriginatorInfo. This method never returns null, however the retrieved certificateSet maybe empty. If not empty, the CertificateSet returned may contain X.509 public key certificate (iaik.x509.X509Certificate objects) and/or or an X.509 attribute certificate (iaik.x509.attr.AttributeCertificate objects); PKCS#6 extended certificates are obsolete and therefore not supported.
    
    Returns:
    the certificateSet holding the certificates of this OriginatorInfo
  - getCertificate
```
public X509Certificate getCertificate(CertificateIdentifier certificateIdentifier)
                               throws CMSException
```
    Tries to find the originator certificate specified by the given CertificateIdentidier.
    This method searches the certificates field of this OriginatorInfo for a certificate identified by the given CertificateIdentifier.
    
    Parameters:
    certificateIdentifier - the certificate identifier
    
    Returns:
    the X509Certificate belonging to the given CertificateIdentifier, if included; otherwise a CMSException is thrown
    
    Throws:
    
    CMSException - if the requested certificate cannot be found
  - getCRLs
```
public X509CRL[] getCRLs()
```
    Returns all the cerificate-revocation lists included in this OriginatorInfo object.
    
    Returns:
    an array containing the cerificate-revocation lists included into this OriginatorInfo object, or null if there are no CRLs included
  - containsCertificates
```
public boolean containsCertificates()
```
    Looks if any certificates are included in this OriginatorInfo.
    
    Returns:
    true if certificates are included, false if not
  - containsCRLs
```
public boolean containsCRLs()
```
    Looks if any crls are included in this OriginatorInfo.
    
    Returns:
    true if crls are included, false if not
  - isEmpty
```
public boolean isEmpty()
```
    Looks if this OriginatorInfo is empty.
    
    Returns:
    true if there are no certificates and no crls inlcuded, false otherwise
  - toASN1Object
```
public ASN1Object toASN1Object()
                        throws CMSException
```
    Returns this OriginatorInfo as ASN1Object.
    
    Returns:
    this OriginatorInfo as ASN1Object
    
    Throws:
    
    CMSException - if the ASN1Object could not be created
  - writeTo
```
public void writeTo(java.io.OutputStream os)
             throws java.io.IOException
```
    DER encodes and writes this object to the supplied output stream.
    
    Parameters:
    os - the output stream to which this OriginatorInfo shall be encoded
    
    Throws:
    
    java.io.IOException - if an error occurs when writing to the stream
  - toString
```
public java.lang.String toString()
```
    Returns a string giving some information about this OriginatorInfo object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    the string representation

Class OriginatorInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OriginatorInfo

OriginatorInfo

OriginatorInfo

Method Detail

decode

decode

setCertificates

setCertificateSet

setCRLs

getCertificates

getX509Certificates

getAttributeCertificates

getCertificateSet

getCertificate

getCRLs

containsCertificates

containsCRLs

isEmpty

toASN1Object

writeTo

toString