com.rsa.certj.provider.revocation.ocsp

Class OCSPEvidence

java.lang.Object
  |
  +--com.rsa.certj.provider.revocation.ocsp.OCSPEvidence

public final class OCSPEvidence

extends Object

This class holds evidence related to the status of a certificate provided by an OCSP responder. This class is used with CertRevocationInfo when the type of evidence is CertRevocationInfo.CRE_OCSP.

Note: Objects that are passed to a constructor or method or returned from a method of this class are shared. No copy is made. It is often advisable to make a copy of the object before passing it to a constructor or method of this class, or after getting it from a method of this class.

Copyright © RSA Security Inc., 2001. All rights reserved.

See Also

CertRevocationInfo

Field Summary

static int

NONCE_IGNORED Indicates that the client provided the optional nonce extension in the request, and that no nonce was returned by the OCSP responder.

Constructor Summary

OCSPEvidence(int flags, Date producedAtTime, Date thisUpdateTime, Date nextUpdateTime, X509V3Extensions responseExtensions, OCSPRevocationInfo revocationInfo)

Constructs OCSPEvidence and initializes all the fields with given arguments.

Method Summary

int	getFlags() Returns a collection of bit values indicating extra information found in the evidence object.
Date	getNextUpdate() Returns the time at which newer information about the status of the certificate will be available.
Date	getProducedAt() Returns the time indicating when the response message was produced.
X509V3Extensions	getResponseExtensions() Returns optional extensions found in the response message.
OCSPRevocationInfo	getRevocationInfo() Returns information pertaining to the time and circumstances of revocation.
Date	getThisUpdate() Returns the time at which the status of the certificate is known to be correct.
void	setFlags(int flags) Set a collection of bit values to indicate extra information in the evidence object.
String	toString() Returns a String that describes this OCSPEvidence object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NONCE_IGNORED

public static final int NONCE_IGNORED

Indicates that the client provided the optional nonce extension in the request, and that no nonce was returned by the OCSP responder.

Constructor Detail

OCSPEvidence

public OCSPEvidence(int flags,
                    Date producedAtTime,
                    Date thisUpdateTime,
                    Date nextUpdateTime,
                    X509V3Extensions responseExtensions,
                    OCSPRevocationInfo revocationInfo)
             throws InvalidParameterException

Constructs OCSPEvidence and initializes all the fields with given arguments.

Parameters

	flags		A collection of bit values indicating any extra information found in the response message. Currently the only possible value is NONCE_IGNORED.
	producedAtTime		The time when the response message was produced.
	thisUpdateTime		The time at which the status of the certificate is known to be correct.
	nextUpdateTime		The time at which newer information about the status of the certificate will be available.
	responseExtensions		Optional extensions found in the response message.
	revocationInfo		Information pertaining to the time and circumstances of revocation.

Throws

InvalidParameterException - If any argument is invalid.

Method Detail

toString

public String toString()

Returns a String that describes this OCSPEvidence object.

Overrides

toString in class Object

Returns

A String that describes this OCSPEvidence object.

getFlags

public int getFlags()

Returns a collection of bit values indicating extra information found in the evidence object. Currently the only defined flag is NONCE_IGNORED.

Returns

An int value holding a collection of bit values indicating any extra information found in the evidence.

setFlags

public void setFlags(int flags)

Set a collection of bit values to indicate extra information in the evidence object. Currently the only defined flag is NONCE_IGNORED.

getProducedAt

public Date getProducedAt()

Returns the time indicating when the response message was produced.

Returns

A Date object indicating the time when the response message was produced.

getThisUpdate

public Date getThisUpdate()

Returns the time at which the status of the certificate is known to be correct.

Returns

A Date object indicating the time at which the status of the certificate is known to be correct.

getNextUpdate

public Date getNextUpdate()

Returns the time at which newer information about the status of the certificate will be available.

Returns

A Date object indicating the time at which newer information about the status of the certificate will be available. This method returns null if the optional field of nextUpdate of the response message is absent.

getResponseExtensions

public X509V3Extensions getResponseExtensions()

Returns optional extensions found in the response message.

Returns

An X509V3Extensions object indicating optional extensions found in the response message. If the extensions are absent in the response message, this method returns null.

getRevocationInfo

public OCSPRevocationInfo getRevocationInfo()

Returns information pertaining to the time and circumstances of revocation.

Returns

An OCSPRevocationInfo object containing the revocation details. This method returns null if the certificate has not been revoked, or no such information is available.