sun.security.timestamp

Class TSResponse

java.lang.Object

sun.security.timestamp.TSResponse

public class TSResponse
extends java.lang.Object

This class provides the response corresponding to a timestamp request, as defined in RFC 3161. The TimeStampResp ASN.1 type has the following definition:

     TimeStampResp ::= SEQUENCE {
         status            PKIStatusInfo,
         timeStampToken    TimeStampToken OPTIONAL ]

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

     PKIStatus ::= INTEGER {
         granted                (0),
           -- when the PKIStatus contains the value zero a TimeStampToken, as
           -- requested, is present.
         grantedWithMods        (1),
           -- when the PKIStatus contains the value one a TimeStampToken,
           -- with modifications, is present.
         rejection              (2),
         waiting                (3),
         revocationWarning      (4),
           -- this message contains a warning that a revocation is
           -- imminent
         revocationNotification (5)
           -- notification that a revocation has occurred }

     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 {
         badAlg              (0),
           -- unrecognized or unsupported Algorithm Identifier
         badRequest          (2),
           -- transaction not permitted or supported
         badDataFormat       (5),
           -- the data submitted has the wrong format
         timeNotAvailable    (14),
           -- the TSA's time source is not available
         unacceptedPolicy    (15),
           -- the requested TSA policy is not supported by the TSA
         unacceptedExtension (16),
           -- the requested extension is not supported by the TSA
         addInfoNotAvailable (17)
           -- the additional information requested could not be understood
           -- or is not available
         systemFailure       (25)
           -- the request cannot be handled due to system failure }

     TimeStampToken ::= ContentInfo
         -- contentType is id-signedData
         -- content is SignedData
         -- eContentType within SignedData is id-ct-TSTInfo
         -- eContent within SignedData is TSTInfo

 

Since:

1.5

Author:

Vincent Ryan

See Also:

Timestamper

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADD_INFO_NOT_AVAILABLE The additional information requested could not be understood or is not available.
static int	BAD_ALG Unrecognized or unsupported algorithm identifier.
static int	BAD_DATA_FORMAT The data submitted has the wrong format.
static int	BAD_REQUEST The requested transaction is not permitted or supported.
static int	GRANTED The requested timestamp was granted.
static int	GRANTED_WITH_MODS The requested timestamp was granted with some modifications.
static int	REJECTION The requested timestamp was not granted.
static int	REVOCATION_NOTIFICATION Notification that a certificate revocation has occurred.
static int	REVOCATION_WARNING A warning that a certificate revocation is imminent.
static int	SYSTEM_FAILURE The request cannot be handled due to system failure.
static int	TIME_NOT_AVAILABLE The TSA's time source is not available.
static int	UNACCEPTED_EXTENSION The requested extension is not supported by the TSA.
static int	UNACCEPTED_POLICY The requested TSA policy is not supported by the TSA.
static int	WAITING The requested timestamp has not yet been processed.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getEncodedToken() Retrieve the ASN.1 BER encoded timestamp token returned by the TSA.
int	getFailureCode() Retrieve the failure code returned by the TSA.
java.lang.String	getFailureCodeAsText()
int	getStatusCode() Retrieve the status code returned by the TSA.
java.lang.String	getStatusCodeAsText()
java.lang.String[]	getStatusMessages() Retrieve the status messages returned by the TSA.
PKCS7	getToken() Retrieve the timestamp token returned by the TSA.

Methods inherited from class java.lang.Object

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

Field Detail

GRANTED

public static final int GRANTED

The requested timestamp was granted.

See Also:

Constant Field Values

GRANTED_WITH_MODS

public static final int GRANTED_WITH_MODS

The requested timestamp was granted with some modifications.

See Also:

Constant Field Values

REJECTION

public static final int REJECTION

The requested timestamp was not granted.

See Also:

Constant Field Values

WAITING

public static final int WAITING

The requested timestamp has not yet been processed.

See Also:

Constant Field Values

REVOCATION_WARNING

public static final int REVOCATION_WARNING

A warning that a certificate revocation is imminent.

See Also:

Constant Field Values

REVOCATION_NOTIFICATION

public static final int REVOCATION_NOTIFICATION

Notification that a certificate revocation has occurred.

See Also:

Constant Field Values

BAD_ALG

public static final int BAD_ALG

Unrecognized or unsupported algorithm identifier.

See Also:

Constant Field Values

BAD_REQUEST

public static final int BAD_REQUEST

The requested transaction is not permitted or supported.

See Also:

Constant Field Values

BAD_DATA_FORMAT

public static final int BAD_DATA_FORMAT

The data submitted has the wrong format.

See Also:

Constant Field Values

TIME_NOT_AVAILABLE

public static final int TIME_NOT_AVAILABLE

The TSA's time source is not available.

See Also:

Constant Field Values

UNACCEPTED_POLICY

public static final int UNACCEPTED_POLICY

The requested TSA policy is not supported by the TSA.

See Also:

Constant Field Values

UNACCEPTED_EXTENSION

public static final int UNACCEPTED_EXTENSION

The requested extension is not supported by the TSA.

See Also:

Constant Field Values

ADD_INFO_NOT_AVAILABLE

public static final int ADD_INFO_NOT_AVAILABLE

The additional information requested could not be understood or is not available.

See Also:

Constant Field Values

SYSTEM_FAILURE

public static final int SYSTEM_FAILURE

The request cannot be handled due to system failure.

See Also:

Constant Field Values

Method Detail

getStatusCode

public int getStatusCode()

Retrieve the status code returned by the TSA.

getStatusMessages

public java.lang.String[] getStatusMessages()

Retrieve the status messages returned by the TSA.

Returns:

If null then no status messages were received.

getFailureCode

public int getFailureCode()

Retrieve the failure code returned by the TSA.

Returns:

If -1 then no failure code was received.

getStatusCodeAsText

public java.lang.String getStatusCodeAsText()

getFailureCodeAsText

public java.lang.String getFailureCodeAsText()

getToken

public PKCS7 getToken()

Retrieve the timestamp token returned by the TSA.

Returns:

If null then no token was received.

getEncodedToken

public byte[] getEncodedToken()

Retrieve the ASN.1 BER encoded timestamp token returned by the TSA.

Returns:

If null then no token was received.