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

java.lang.Object
- com.entrust.toolkit.asn1.crmf.CertTemplate

All Implemented Interfaces:: ASN1Type

public class CertTemplate
extends java.lang.Object
implements ASN1Type

This class implements the CertTemplate structure as defined in the CRMF specification.

 CertTemplate ::= SEQUENCE {
     version      [0] IMPLICIT Version               OPTIONAL,
     serialNumber [1] IMPLICIT INTEGER               OPTIONAL,
     signingAlg   [2] IMPLICIT AlgorithmIdentifier   OPTIONAL,
     issuer       [3] Name                           OPTIONAL,
     validity     [4] IMPLICIT OptionalValidity      OPTIONAL,
     subject      [5] Name                           OPTIONAL,
     publicKey    [6] IMPLICIT SubjectPublicKeyInfo  OPTIONAL,
     issuerUID    [7] IMPLICIT UniqueIdentifier      OPTIONAL,
     subjectUID   [8] IMPLICIT UniqueIdentifier      OPTIONAL,
     extensions   [9] IMPLICIT Extensions            OPTIONAL
 }

Since:: 7.0

Field Summary

Fields
Modifier and Type Field and Description

static int version_v1
Version value - v1.

static int version_v2
Version value - v2.

static int version_v3
Version value - v3.

Fields
Modifier and Type	Field and Description
`static int`	`version_v1` Version value - v1.
`static int`	`version_v2` Version value - v2.
`static int`	`version_v3` Version value - v3.

Constructor Summary

Constructors
Constructor and Description

CertTemplate()
Creates a new (empty) CertTemplate object.

CertTemplate(ASN1Object obj)
Creates a CertTemplate object from an ASN1Object.

Constructors
Constructor and Description
`CertTemplate()` Creates a new (empty) `CertTemplate` object.
`CertTemplate(ASN1Object obj)` Creates a `CertTemplate` object from an `ASN1Object`.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addExtension(V3Extension extension)` Adds the specified extension.
`void`	`decode(ASN1Object obj)` Decodes a CertTemplate structure from an `ASN1Object`.
`V3Extension`	`getExtension(ObjectID oid)` Returns a specific extension, identified by its object identifier, if it exists in the; otherwise `null` is returned.
`X509Extensions`	`getExtensions()` Returns the extensions.
`Name`	`getIssuer()` Returns the issuer if it has be set; otherwise `null` is returned.
`java.lang.String`	`getIssuerUID()` Returns the issuer unique ID if it has be set; otherwise `null` is returned.
`java.security.PublicKey`	`getPublicKey()` Returns the public key if it has be set; otherwise `null` is returned.
`java.math.BigInteger`	`getSerialNumber()` Returns the serial number if it has be set; otherwise `null` is returned.
`AlgorithmID`	`getSigningAlg()` Returns the signature algorithm if it has be set; otherwise `null` is returned.
`Name`	`getSubject()` Returns the subject if it has be set; otherwise `null` is returned.
`java.lang.String`	`getSubjectUID()` Returns the subject unique ID if it has be set; otherwise `null` is returned.
`OptionalValidity`	`getValidity()` Returns the validity if it has be set; otherwise `null` is returned.
`int`	`getVersion()` Returns the version if it has be set; otherwise -1 is returned.
`void`	`setExtensions(X509Extensions extensions)` Sets the extensions.
`void`	`setIssuer(Name issuer)` Sets the issuer.
`void`	`setIssuerUID(java.lang.String issuerUID)` Sets the issuer unique ID.
`void`	`setPublicKey(java.security.PublicKey publicKey)` Sets the public key.
`void`	`setSerialNumber(java.math.BigInteger serialNumber)` Sets the serial number.
`void`	`setSigningAlg(AlgorithmID signingAlg)` Sets the signature algorithm.
`void`	`setSubject(Name subject)` Sets the subject.
`void`	`setSubjectUID(java.lang.String subjectUID)` Sets the subject unique ID.
`void`	`setValidity(OptionalValidity validity)` Sets the validity.
`void`	`setVersion(int version)` Sets the version.
`ASN1Object`	`toASN1Object()` Encodes this `CertTemplate` as an `ASN1Object`.
`java.lang.String`	`toString()` Creates a text representation of the ASN.1 structure of this `CertTemplate` object.

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

- Field Detail
  - version_v1
```
public static final int version_v1
```
    Version value - v1.
    
    See Also:
    Constant Field Values
  - version_v2
```
public static final int version_v2
```
    Version value - v2.
    
    See Also:
    Constant Field Values
  - version_v3
```
public static final int version_v3
```
    Version value - v3.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - CertTemplate
```
public CertTemplate()
```
    Creates a new (empty) CertTemplate object.
  - CertTemplate
```
public CertTemplate(ASN1Object obj)
             throws CodingException
```
    Creates a CertTemplate object from an ASN1Object.
    
    Parameters:
    obj - the ASN.1 representation of a CertTemplate structure
    
    Throws:
    
    CodingException - thrown if an errors occurs while decoding the ANS1Object
- Method Detail
  - setVersion
```
public void setVersion(int version)
```
    Sets the version.
    
    Parameters:
    version - the version component
  - setSerialNumber
```
public void setSerialNumber(java.math.BigInteger serialNumber)
```
    Sets the serial number.
    
    Parameters:
    serialNumber - the serialNumber component
  - setSigningAlg
```
public void setSigningAlg(AlgorithmID signingAlg)
```
    Sets the signature algorithm.
    
    Parameters:
    signingAlg - the signingAlg component
  - setIssuer
```
public void setIssuer(Name issuer)
```
    Sets the issuer.
    
    Parameters:
    issuer - the issuer component
  - setValidity
```
public void setValidity(OptionalValidity validity)
```
    Sets the validity.
    
    Parameters:
    validity - the validity component
  - setSubject
```
public void setSubject(Name subject)
```
    Sets the subject.
    
    Parameters:
    subject - the subject component
  - setPublicKey
```
public void setPublicKey(java.security.PublicKey publicKey)
```
    Sets the public key.
    
    Parameters:
    publicKey - the publicKey component
  - setIssuerUID
```
public void setIssuerUID(java.lang.String issuerUID)
```
    Sets the issuer unique ID.
    
    Parameters:
    issuerUID - the issuerUID component
  - setSubjectUID
```
public void setSubjectUID(java.lang.String subjectUID)
```
    Sets the subject unique ID.
    
    Parameters:
    subjectUID - the subjectUID component
  - setExtensions
```
public void setExtensions(X509Extensions extensions)
```
    Sets the extensions.
    
    Parameters:
    extensions - the extensions component
  - addExtension
```
public void addExtension(V3Extension extension)
                  throws X509ExtensionException
```
    Adds the specified extension.
    
    Parameters:
    extension - the extension to be added
    
    Throws:
    
    X509ExtensionException - thrown if there is a problem with the extension
  - getVersion
```
public int getVersion()
```
    Returns the version if it has be set; otherwise -1 is returned.
    
    Returns:
    the version component
  - getSerialNumber
```
public java.math.BigInteger getSerialNumber()
```
    Returns the serial number if it has be set; otherwise null is returned.
    
    Returns:
    the serialNumber component
  - getSigningAlg
```
public AlgorithmID getSigningAlg()
```
    Returns the signature algorithm if it has be set; otherwise null is returned.
    
    Returns:
    the signingAlg component
  - getIssuer
```
public Name getIssuer()
```
    Returns the issuer if it has be set; otherwise null is returned.
    
    Returns:
    the issuer component
  - getValidity
```
public OptionalValidity getValidity()
```
    Returns the validity if it has be set; otherwise null is returned.
    
    Returns:
    the validity component
  - getSubject
```
public Name getSubject()
```
    Returns the subject if it has be set; otherwise null is returned.
    
    Returns:
    the subject component
  - getPublicKey
```
public java.security.PublicKey getPublicKey()
```
    Returns the public key if it has be set; otherwise null is returned.
    
    Returns:
    the publicKey component
  - getIssuerUID
```
public java.lang.String getIssuerUID()
```
    Returns the issuer unique ID if it has be set; otherwise null is returned.
    
    Returns:
    the issuerUID component
  - getSubjectUID
```
public java.lang.String getSubjectUID()
```
    Returns the subject unique ID if it has be set; otherwise null is returned.
    
    Returns:
    the subjectUID component
  - getExtensions
```
public X509Extensions getExtensions()
```
    Returns the extensions.
    
    Returns:
    the extensions component
  - getExtension
```
public V3Extension getExtension(ObjectID oid)
                         throws X509ExtensionInitException
```
    Returns a specific extension, identified by its object identifier, if it exists in the; otherwise null is returned.
    
    Returns:
    an extension from the extensions component
    
    Throws:
    
    X509ExtensionInitException - if there is a problem with the extension
  - decode
```
public void decode(ASN1Object obj)
            throws CodingException
```
    Decodes a CertTemplate structure from an ASN1Object.
    
    Specified by:
    
    decode in interface ASN1Type
    
    Parameters:
    obj - an ASN.1 representation of a CertTemplate structure
    
    Throws:
    
    CodingException - thrown if an errors occurs while decoding the ANS1Object
  - toASN1Object
```
public ASN1Object toASN1Object()
```
    Encodes this CertTemplate as an ASN1Object.
    
    Specified by:
    
    toASN1Object in interface ASN1Type
    
    Returns:
    an ASN.1 representation of this object
  - toString
```
public java.lang.String toString()
```
    Creates a text representation of the ASN.1 structure of this CertTemplate object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    a text representation of the ASN.1 structure of this object

Class CertTemplate

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version_v1

version_v2

version_v3

Constructor Detail

CertTemplate

CertTemplate

Method Detail

setVersion

setSerialNumber

setSigningAlg

setIssuer

setValidity

setSubject

setPublicKey

setIssuerUID

setSubjectUID

setExtensions

addExtension

getVersion

getSerialNumber

getSigningAlg

getIssuer

getValidity

getSubject

getPublicKey

getIssuerUID

getSubjectUID

getExtensions

getExtension

decode

toASN1Object

toString