com.netscape.certsrv.ocsp
Interface IOCSPAuthority

All Superinterfaces:
ISubsystem

public interface IOCSPAuthority
extends ISubsystem

This class represents the primary interface for the Online Certificate Status Protocol (OCSP) server.

Version:
$Revision: 1211 $, $Date: 2010-08-18 10:15:37 -0700 (Wed, 18 Aug 2010) $

Field Summary
static java.lang.String ID
           
static org.mozilla.jss.asn1.OBJECT_IDENTIFIER OCSP_NONCE
           
static java.lang.String PROP_DEF_STORE_ID
           
static java.lang.String PROP_NEW_NICKNAME
           
static java.lang.String PROP_NICKNAME
           
static java.lang.String PROP_SIGNING_SUBSTORE
           
static java.lang.String PROP_STORE
           
 
Method Summary
 boolean arraysEqual(byte[] bytes, byte[] ints)
          This method compares two byte arrays to see if they are equivalent.
 java.lang.String getDefaultAlgorithm()
          This method retrieves the default signing algorithm.
 IDefStore getDefaultStore()
          This method retrieves the default OCSP store (i.
 java.lang.String getDigestName(org.mozilla.jss.pkix.primitive.AlgorithmIdentifier alg)
          This method retrieves an OCSP server instance digest name as a string.
 netscape.security.x509.X500Name getName()
          This method retrieves the X500Name of an OCSP server instance.
 java.lang.String[] getOCSPSigningAlgorithms()
          This method retrieves all potential OCSP signing algorithms.
 IOCSPStore getOCSPStore(java.lang.String id)
          This method retrieves the OCSP store given its name.
 com.netscape.cmsutil.ocsp.ResponderID getResponderIDByHash()
          This method retrieves the responder ID by its hash.
 com.netscape.cmsutil.ocsp.ResponderID getResponderIDByName()
          This method retrieves the responder ID by its name.
 ISigningUnit getSigningUnit()
          This method retrieves the signing unit.
 void incLookupTime(long inc)
           
 void incNumOCSPRequest(long inc)
           
 void incSignTime(long inc)
           
 void incTotalTime(long inc)
           
 void log(int event, int level, java.lang.String msg)
          This method logs the specified message at the specified level given the specified event.
 void log(int level, java.lang.String msg)
          This method logs the specified message at the specified level.
 void setDefaultAlgorithm(java.lang.String algorithm)
          This method sets the supplied algorithm as the default signing algorithm.
 com.netscape.cmsutil.ocsp.BasicOCSPResponse sign(com.netscape.cmsutil.ocsp.ResponseData rd)
          This method signs the basic OCSP response data provided as a parameter.
 
Methods inherited from interface com.netscape.certsrv.base.ISubsystem
getConfigStore, getId, init, setId, shutdown, startup
 

Field Detail

ID

static final java.lang.String ID
See Also:
Constant Field Values

OCSP_NONCE

static final org.mozilla.jss.asn1.OBJECT_IDENTIFIER OCSP_NONCE

PROP_DEF_STORE_ID

static final java.lang.String PROP_DEF_STORE_ID
See Also:
Constant Field Values

PROP_STORE

static final java.lang.String PROP_STORE
See Also:
Constant Field Values

PROP_SIGNING_SUBSTORE

static final java.lang.String PROP_SIGNING_SUBSTORE
See Also:
Constant Field Values

PROP_NICKNAME

static final java.lang.String PROP_NICKNAME
See Also:
Constant Field Values

PROP_NEW_NICKNAME

static final java.lang.String PROP_NEW_NICKNAME
See Also:
Constant Field Values
Method Detail

getOCSPStore

IOCSPStore getOCSPStore(java.lang.String id)
This method retrieves the OCSP store given its name.

Parameters:
id - the string representation of an OCSP store
Returns:
IOCSPStore an instance of an OCSP store object

getSigningUnit

ISigningUnit getSigningUnit()
This method retrieves the signing unit.

Returns:
ISigningUnit an instance of a signing unit object

getResponderIDByName

com.netscape.cmsutil.ocsp.ResponderID getResponderIDByName()
This method retrieves the responder ID by its name.

Returns:
ResponderID an instance of a responder ID

getResponderIDByHash

com.netscape.cmsutil.ocsp.ResponderID getResponderIDByHash()
This method retrieves the responder ID by its hash.

Returns:
ResponderID an instance of a responder ID

getDefaultStore

IDefStore getDefaultStore()
This method retrieves the default OCSP store (i. e. - information from the internal database).

Returns:
IDefStore an instance of the default OCSP store

setDefaultAlgorithm

void setDefaultAlgorithm(java.lang.String algorithm)
                         throws EBaseException
This method sets the supplied algorithm as the default signing algorithm.

Parameters:
algorithm - a string representing the requested algorithm
Throws:
EBaseException - if the algorithm is unknown or disallowed

getDefaultAlgorithm

java.lang.String getDefaultAlgorithm()
This method retrieves the default signing algorithm.

Returns:
String the name of the default signing algorithm

getOCSPSigningAlgorithms

java.lang.String[] getOCSPSigningAlgorithms()
This method retrieves all potential OCSP signing algorithms.

Returns:
String[] the names of all potential OCSP signing algorithms

log

void log(int level,
         java.lang.String msg)
This method logs the specified message at the specified level.

Parameters:
level - the log level
msg - the log message

log

void log(int event,
         int level,
         java.lang.String msg)
This method logs the specified message at the specified level given the specified event.

Parameters:
event - the log event
level - the log message
msg - the log message

getName

netscape.security.x509.X500Name getName()
This method retrieves the X500Name of an OCSP server instance.

Returns:
X500Name an instance of the X500 name object

getDigestName

java.lang.String getDigestName(org.mozilla.jss.pkix.primitive.AlgorithmIdentifier alg)
This method retrieves an OCSP server instance digest name as a string.

Parameters:
alg - the signing algorithm
Returns:
String the digest name of the related OCSP server

sign

com.netscape.cmsutil.ocsp.BasicOCSPResponse sign(com.netscape.cmsutil.ocsp.ResponseData rd)
                                                 throws EBaseException
This method signs the basic OCSP response data provided as a parameter.

Parameters:
rd - response data
Returns:
BasicOCSPResponse signed response data
Throws:
EBaseException - error associated with an inability to sign the specified response data

arraysEqual

boolean arraysEqual(byte[] bytes,
                    byte[] ints)
This method compares two byte arrays to see if they are equivalent.

Parameters:
bytes - the first byte array
ints - the second byte array
Returns:
boolean true or false

incTotalTime

void incTotalTime(long inc)

incSignTime

void incSignTime(long inc)

incLookupTime

void incLookupTime(long inc)

incNumOCSPRequest

void incNumOCSPRequest(long inc)