com.entrust.toolkit.asn1.cmpv1

Class ErrorMsgContent

java.lang.Object

com.entrust.toolkit.asn1.cmpv1.ErrorMsgContent

All Implemented Interfaces:

ASN1Type

public class ErrorMsgContent
extends java.lang.Object
implements ASN1Type

This class implements the ASN.1 structure for CertifiedKeyPair as defined in RFC 2510, the Certificate Management Protocols (CMP) specification.

 ErrorMsgContent ::= SEQUENCE {
     pKIStatusInfo    PKIStatusInfo,
     errorCode        INTEGER        OPTIONAL,
     -- implementation-specific error codes
     errorDetails     PKIFreeText    OPTIONAL
     -- implementation-specific error details
 }

 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)
 

Since:

7.0

See Also:

RFC 2510

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addErrorDetails(java.lang.String errorDetails) Adds the specified error information to set of implementation-specific error details.
void	decode(ASN1Object obj) Decodes an ErrorMsgContent structure from an ASN1Object.
java.math.BigInteger	getErrorCode() Returns the implementation-specific error code if it has been set; otherwise null is returned.
java.lang.String[]	getErrorDetails() Returns the implementation-specific error details if they have been set; otherwise null is returned.
PKIStatusInfo	getPKIStatusInfo() Returns the status information.
void	setErrorCode(java.math.BigInteger errorCode) Sets the implementation-specific error code.
void	setErrorDetails(java.lang.String[] errorDetails) Sets the set of implementation-specific error details.
ASN1Object	toASN1Object() Encodes this ErrorMsgContent object as an ASN1Object.
java.lang.String	toMessageString() Creates a message string that represents the contents of this ErrorMsgContent object.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this ErrorMsgContent object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorMsgContent

public ErrorMsgContent(PKIStatusInfo pkiStatusInfo)
                throws java.lang.IllegalArgumentException

Creates a new ErrorMsgContent object with the specified component.

Parameters:

pkiStatusInfo - indicates status information

Throws:

java.lang.IllegalArgumentException - thrown if the parameter is null

ErrorMsgContent

public ErrorMsgContent(ASN1Object obj)
                throws CodingException,
                       java.lang.IllegalArgumentException

Creates a new ErrorMsgContent object from an ASN1Object.

The ASN1Object must be an ErrorMsgContent structure.

Parameters:

obj - the ASN.1 representation of an ErrorMsgContent structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

java.lang.IllegalArgumentException - thrown if the parameter is null

Method Detail

getPKIStatusInfo

public PKIStatusInfo getPKIStatusInfo()

Returns the status information.

Returns:

the pkiStatusInfo component

getErrorCode

public java.math.BigInteger getErrorCode()

Returns the implementation-specific error code if it has been set; otherwise null is returned.

Returns:

the errorCode component

getErrorDetails

public java.lang.String[] getErrorDetails()

Returns the implementation-specific error details if they have been set; otherwise null is returned.

Returns:

the errorDetails component

setErrorCode

public void setErrorCode(java.math.BigInteger errorCode)

Sets the implementation-specific error code.

Parameters:

errorCode - the errorCode component

setErrorDetails

public void setErrorDetails(java.lang.String[] errorDetails)

Sets the set of implementation-specific error details.

Parameters:

errorDetails - the errorDetails component

addErrorDetails

public void addErrorDetails(java.lang.String errorDetails)

Adds the specified error information to set of implementation-specific error details.

If errorDetails is null, it is not added.

Parameters:

errorDetails - implementation-specific error details to be added to the errorDetails component

decode

public void decode(ASN1Object obj)
            throws CodingException,
                   java.lang.IllegalArgumentException

Decodes an ErrorMsgContent structure from an ASN1Object.

Specified by:

decode in interface ASN1Type

Parameters:

obj - an ASN.1 representation of an ErrorMsgContent structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

java.lang.IllegalArgumentException - thrown if the parameter is null

toASN1Object

public ASN1Object toASN1Object()

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

This method can be used to create messages that can be returned in exceptions.

Returns:

a message string that represents this object