com.entrust.toolkit.asn1.cmpv1.gkm

Class EntrustEventInfo

java.lang.Object

com.entrust.toolkit.asn1.cmpv1.gkm.EntrustEventInfo

All Implemented Interfaces:

ASN1Type

public class EntrustEventInfo
extends java.lang.Object
implements ASN1Type

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

 EntrustEventInfoSyntax ::= SEQUENCE
 {
     eventTime          [0] GeneralizedTime       OPTIONAL,
     eventReason        [1] EntrustEventReason    OPTIONAL,
     csSyncNumber       [2] INTEGER,
     state              [3] EntrustState          OPTIONAL,
     rolloverAllowed    [4] BOOLEAN               OPTIONAL,
     newCAName          [5] GeneralNames          OPTIONAL, -- present if CA name changed (exported)
     eventIndicator     [6] INTEGER
 }
 
 entrustEventInfo OBJECT-TYPE
     SYNTAX EntrustEventInfoSyntax 
         ACCESS read-write
         STATUS mandatory
         ::= { 2 16 840 1 114027 50 4 }
 

Since:

7.0

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectID	oid The object identifier for an EntrustEventIdentifier.

Constructor Summary

Constructors

Constructor and Description
EntrustEventInfo(ASN1Object obj) Creates a new EntrustEventInfo from an ASN1Object.
EntrustEventInfo(java.math.BigInteger csSyncNumber, java.math.BigInteger eventIndicator) Creates a new EntrustEventInfo object with the specified components.

Method Summary

Methods

Modifier and Type	Method and Description
void	addNewCAName(GeneralName newCAName) Adds the new CA name to the set of new CA names.
void	decode(ASN1Object obj) Decodes an EntrustEventInfo from an ASN1Object.
java.math.BigInteger	getCsSyncNumber() Returns the certificate store synchronization number.
java.math.BigInteger	getEventIndicator() Returns the eventIndicator.
EntrustEventReason	getEventReason() Returns the reason the event ocured if it has been set; otherwise null is returned.
java.util.Date	getEventTime() Returns the time the event occured if it has been set; otherwise null is returned.
GeneralName[]	getNewCAName() Returns the new name of the CA if it has been set; otherwise null is returned.
java.lang.Boolean	getRolloverAllowed() Returns an indicator for whether roll-over is permitted if it has been set; otherwise null is returned.
EntrustState	getState() Returns the state if it has been set; otherwise null is returned.
void	setEventReason(EntrustEventReason eventReason) Sets the reason the event occured.
void	setEventTime(java.util.Date eventTime) Sets the time the event occured.
void	setNewCAName(GeneralName[] newCAName) Sets the set of new CA names.
void	setRolloverAllowed(java.lang.Boolean rolloverAllowed) Sets an indicator for whether roll-over is permitted.
void	setState(EntrustState state) Sets the state.
ASN1Object	toASN1Object() Encodes this EntrustEventInfo object as an ASN1Object.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this EntrustEventInfo object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

oid

public static final ObjectID oid

The object identifier for an EntrustEventIdentifier.

Constructor Detail

EntrustEventInfo

public EntrustEventInfo(java.math.BigInteger csSyncNumber,
                java.math.BigInteger eventIndicator)

Creates a new EntrustEventInfo object with the specified components.

Parameters:

csSyncNumber - the certificate store synchronization number

eventIndicator - the event indicator

EntrustEventInfo

public EntrustEventInfo(ASN1Object obj)
                 throws CodingException

Creates a new EntrustEventInfo from an ASN1Object. The ASN1Object must be an EntrustEventInfoSyntax structure.

Parameters:

obj - the ASN.1 representation of an EntrustEventInfoSyntax structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

Method Detail

getEventTime

public java.util.Date getEventTime()

Returns the time the event occured if it has been set; otherwise null is returned.

Returns:

the eventTime component

getEventReason

public EntrustEventReason getEventReason()

Returns the reason the event ocured if it has been set; otherwise null is returned.

Returns:

the eventReason component

getCsSyncNumber

public java.math.BigInteger getCsSyncNumber()

Returns the certificate store synchronization number.

Returns:

the csSyncNumber component

getState

public EntrustState getState()

Returns the state if it has been set; otherwise null is returned.

Returns:

the state component

getRolloverAllowed

public java.lang.Boolean getRolloverAllowed()

Returns an indicator for whether roll-over is permitted if it has been set; otherwise null is returned.

Returns:

the rolloverAllowed component

getNewCAName

public GeneralName[] getNewCAName()

Returns the new name of the CA if it has been set; otherwise null is returned.

Returns:

the newCAName component

getEventIndicator

public java.math.BigInteger getEventIndicator()

Returns the eventIndicator.

Returns:

the eventIndicator component

setEventTime

public void setEventTime(java.util.Date eventTime)

Sets the time the event occured.

Parameters:

eventTime - the eventTime component

setEventReason

public void setEventReason(EntrustEventReason eventReason)

Sets the reason the event occured.

Parameters:

eventReason - the eventReason component

setState

public void setState(EntrustState state)

Sets the state.

Parameters:

state - the state component

setRolloverAllowed

public void setRolloverAllowed(java.lang.Boolean rolloverAllowed)

Sets an indicator for whether roll-over is permitted.

Parameters:

rolloverAllowed - the rolloverAllowed component

setNewCAName

public void setNewCAName(GeneralName[] newCAName)

Sets the set of new CA names.

If the set of new CA names is not null, then it must consist of one or more GeneralName objects.

Parameters:

newCAName - the newCAName component

addNewCAName

public void addNewCAName(GeneralName newCAName)

Adds the new CA name to the set of new CA names.

If newCAName is null, it is not added.

Parameters:

newCAName - a new CA name to be added to the newCAName component

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes an EntrustEventInfo from an ASN1Object. The ASN1Object must be an EntrustEventInfoSyntax structure.

Specified by:

decode in interface ASN1Type

Parameters:

obj - an ASN.1 representation of a EntrustEventInfoSyntax structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toASN1Object

public ASN1Object toASN1Object()

Encodes this EntrustEventInfo object as an ASN1Object.

Specified by:

toASN1Object in interface ASN1Type

Returns:

an ASN.1 representation of the EntrustEventInfoSyntax structure

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

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