com.entrust.toolkit.asn1.cmpv1

Class PKIStatusInfo

java.lang.Object

com.entrust.toolkit.asn1.cmpv1.PKIStatusInfo

All Implemented Interfaces:

ASN1Type

public class PKIStatusInfo
extends java.lang.Object
implements ASN1Type

This class implements the ASN.1 structure for PKIStatusInfo as defined in the CMPv1 specification.

 PKIStatusInfo ::= SEQUENCE {
     status          PKIStatus,
     statusString    PKIFreeText       OPTIONAL,
     failInfo        PKIFailureInfo    OPTIONAL
 }

 PKIStatus ::= INTEGER {
     granted                   (0),
     -- you got exactly what you asked for
     grantedWithMods           (1),
     -- you got something like what you asked for; the
     -- requester is responsible for ascertaining the differences
     rejection                 (2),
     -- you don't get it, more information elsewhere in the message
     waiting                   (3),
     -- the request body part has not yet been processed,
     -- expect to hear more later
     revocationWarning         (4),
     -- this message contains a warning that a revocation is
     -- imminent
     revocationNotification    (5),
     -- notification that a revocation has occurred
     keyUpdateWarning          (6)
     -- update already done for the oldCertId specified in
     -- CertReqMsg
 }

 PKIFreeText ::= SEQUENCE SIZE (1..MAX) OF UTF8String
     -- text encoded as UTF-8 String (note:  each UTF8String SHOULD
     -- include an RFC 1766 language tag to indicate the language
     -- of the contained text)

 PKIFailureInfo ::= BIT STRING {
 -- since we can fail in more than one way!
 -- More codes may be added in the future if/when required.
     badAlg              (0),
     -- unrecognized or unsupported Algorithm Identifier
     badMessageCheck     (1),
     -- integrity check failed (e.g., signature did not verify)
     badRequest          (2),
     -- transaction not permitted or supported
     badTime             (3),
     -- messageTime was not sufficiently close to the system time,
     -- as defined by local policy
     badCertId           (4),
     -- no certificate could be found matching the provided criteria
     badDataFormat       (5),
     -- the data submitted has the wrong format
     wrongAuthority      (6),
     -- the authority indicated in the request is different from the
     -- one creating the response token
     incorrectData       (7),
     -- the requester's data is incorrect (for notary services)
     missingTimeStamp    (8),
     -- when the timestamp is missing but should be there (by policy)
     badPOP              (9)
     -- the proof-of-possession failed
 }
 

Since:

7.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PKIStatusInfo.PKIFailureInfo Contains a set of pre-defined (known) PKIFailureInfo values.
static class	PKIStatusInfo.PKIStatus Contains a set of pre-defined (known) PKIStatus values.

Constructor Summary

Constructors

Constructor and Description
PKIStatusInfo(ASN1Object obj) Creates a new PKIStatusInfo object from an ASN1Object.
PKIStatusInfo(int status) Creates a new PKIStatusInfo object with the specified component.

Method Summary

Methods

Modifier and Type	Method and Description
void	addStatusString(java.lang.String statusString) Adds the status information to the set of status information.
void	decode(ASN1Object obj) Decodes an PKIStatusInfo structure from an ASN1Object.
BinaryString	getFailInfo() Returns the failure code as a binary string if it has been set; otherwise null is returned.
int	getStatus() Returns the status code.
java.lang.String[]	getStatusString() Returns all the human-readable status information if it has been set; otherwise null is returned.
void	setFailInfo(BinaryString failInfo) Sets the failure information from a binary string.
void	setStatusString(java.lang.String[] statusString) Sets the set of status information.
ASN1Object	toASN1Object() Encodes this PKIStatusInfo object as an ASN1Object.
java.lang.String	toMessageString() Creates a message string that represents the contents of this PKIStatusInfo object.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this PKIStatusInfo object.

Methods inherited from class java.lang.Object

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

Constructor Detail

PKIStatusInfo

public PKIStatusInfo(int status)

Creates a new PKIStatusInfo object with the specified component.

Parameters:

status - indicates the status

PKIStatusInfo

public PKIStatusInfo(ASN1Object obj)
              throws CodingException

Creates a new PKIStatusInfo object from an ASN1Object.

Parameters:

obj - the ASN.1 representation of an PKIStatusInfo structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

Method Detail

getStatus

public int getStatus()

Returns the status code.

Returns:

the status component

getStatusString

public java.lang.String[] getStatusString()

Returns all the human-readable status information if it has been set; otherwise null is returned.

Returns:

the statuString component

getFailInfo

public BinaryString getFailInfo()

Returns the failure code as a binary string if it has been set; otherwise null is returned.

Note:

The following convention exists for the ordering of the bits: the first bit of the string is the one on the left-hand side (position 0) and the last bit is the one on the right-hand side.

Returns:

the failure information in binary string format

setStatusString

public void setStatusString(java.lang.String[] statusString)

Sets the set of status information.

If the status information is not null, then it must consist of one or more String objects.

Parameters:

statusString - the statusString component

addStatusString

public void addStatusString(java.lang.String statusString)

Adds the status information to the set of status information.

If statusString is null, it is not added.

Parameters:

statusString - the status information to be added to the statusString component

setFailInfo

public void setFailInfo(BinaryString failInfo)

Sets the failure information from a binary string.

Note:

The following convention exists for the ordering of the bits: the first bit of the string is the one on the left-hand side (position 0) and the last bit is the one on the right-hand side.

Parameters:

failInfo - the failure information in binary string format

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes an PKIStatusInfo structure from an ASN1Object.

Specified by:

decode in interface ASN1Type

Parameters:

obj - an ASN.1 representation of a PKIStatusInfo structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toASN1Object

public ASN1Object toASN1Object()

Encodes this PKIStatusInfo 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 PKIStatusInfo 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 PKIStatusInfo object. This method can be used to create messages that can be returned in exceptions.

Returns:

a message string that represents this object