com.entrust.toolkit.asn1.cmpv1.gkm

Class EntrustCertInfoId

java.lang.Object

com.entrust.toolkit.asn1.cmpv1.gkm.EntrustCertInfoId

All Implemented Interfaces:

ASN1Type

public class EntrustCertInfoId
extends java.lang.Object
implements ASN1Type

This class implements the ASN.1 structure for EntrustCertInfoId as defined in the EASM N Key Pair support specification.

 EntrustCertInfoId ::= SEQUENCE {
     name    UTF8String    OPTIONAL, -- at least one of name/id must be given
     id      INTEGER       OPTIONAL
 };
 

Since:

7.0

Constructor Summary

Constructors

Constructor and Description
EntrustCertInfoId(ASN1Object obj) Creates a new EntrustCertInfoId from an ASN1Object.
EntrustCertInfoId(java.math.BigInteger id) Creates a new EntrustCertInfoId object with the specified component.
EntrustCertInfoId(java.lang.String name) Creates a new EntrustCertInfoId object with the specified component.
EntrustCertInfoId(java.lang.String name, java.math.BigInteger id) Creates a new EntrustCertInfoId object with the specified components.

Method Summary

Methods

Modifier and Type	Method and Description
void	decode(ASN1Object obj) Decodes an EntrustCertInfoId structure from an ASN1Object.
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one.
java.math.BigInteger	getId() Returns the certificate information identifier if it has been set; otherwise null is returned.
java.lang.String	getName() Returns the name of the certificate information identifier if it has been set; otherwise null is returned..
int	hashCode() Returns a hash code value for the object.
boolean	isEquivalent(EntrustCertInfoId entrustCertInfoId) Indicates whether this EntrustCertInfoId object is equivalent to another EntrustCertInfoId object.
void	setId(java.math.BigInteger id) Sets the certificate information identifier.
void	setName(java.lang.String name) Sets the name of the certificate information identifier.
ASN1Object	toASN1Object() Encodes this EntrustCertInfoId object as an ASN1Object.
java.lang.String	toMessageString() Creates a message string that represents the contents of this EntrustCertInfoId object.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this EntrustCertInfoId object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EntrustCertInfoId

public EntrustCertInfoId(java.lang.String name)

Creates a new EntrustCertInfoId object with the specified component.

Parameters:

name - the name of the certificate information identifier

EntrustCertInfoId

public EntrustCertInfoId(java.math.BigInteger id)

Creates a new EntrustCertInfoId object with the specified component.

Parameters:

id - the certificate information identifier

EntrustCertInfoId

public EntrustCertInfoId(java.lang.String name,
                 java.math.BigInteger id)

Creates a new EntrustCertInfoId object with the specified components.

Parameters:

id - the certificate information identifier

name - the name of the certificate information identifier

EntrustCertInfoId

public EntrustCertInfoId(ASN1Object obj)
                  throws CodingException

Creates a new EntrustCertInfoId from an ASN1Object.

Parameters:

obj - the ASN.1 representation of an EntrustCertInfoId structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

Method Detail

getName

public java.lang.String getName()

Returns the name of the certificate information identifier if it has been set; otherwise null is returned..

Returns:

the name component

getId

public java.math.BigInteger getId()

Returns the certificate information identifier if it has been set; otherwise null is returned.

Returns:

the id component

setName

public void setName(java.lang.String name)

Sets the name of the certificate information identifier.

The name cannot be set to null when the id is also null.

Parameters:

name - the name component

setId

public void setId(java.math.BigInteger id)

Sets the certificate information identifier.

The id cannot be set to null when the name is also null.

Parameters:

id - the id component

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes an EntrustCertInfoId structure from an ASN1Object.

Specified by:

decode in interface ASN1Type

Parameters:

obj - an ASN.1 representation of an EntrustCertInfoId structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toASN1Object

public ASN1Object toASN1Object()

Encodes this EntrustCertInfoId object 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 EntrustCertInfoId object.

Overrides:

toString in class java.lang.Object

Returns:

a text representation of the ASN.1 structure of this object

toMessageString

public java.lang.String toMessageString()

Creates a message string that represents the contents of this EntrustCertInfoId object. This method can be used to create messages that can be returned in exceptions.

Returns:

a message string that represents this object

equals

public boolean equals(java.lang.Object obj)

Indicates whether some other object is "equal to" this one.

Two EntrustCertInfoId objects are equal only if their components are equal.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the reference object with which to compare

Returns:

true if the objects are "equal"; false otherwise

isEquivalent

public boolean isEquivalent(EntrustCertInfoId entrustCertInfoId)

Indicates whether this EntrustCertInfoId object is equivalent to another EntrustCertInfoId object.

Two EntrustCertInfoId objects are equivalent if they represent the same Entrust certificate information identifier; this occurs when either the name or id components match when one of them is null, or when both components are non-null and equal.

For example: If this object is configured with an id of 2 and name of "Verification" (denoted [2:Verification] for simplicity), it would match when the passed in EntrustCertInfoId contains [2:Verification]. It would also match when [null:Verification] or [2:null] is used. It would not match if [71:Verification] or [2:Encryption] were used.

Parameters:

entrustCertInfoId - the EntrustCertInfoId object with which to compare

Returns:

true if the objects are equavalent; false otherwise

Since:

7.1sp1

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.