com.netscape.certsrv.ocsp

Interface IDefStore

All Superinterfaces:

IOCSPStore, ISubsystem

All Known Implementing Classes:

DefStore, LDAPStore

public interface IDefStore
extends IOCSPStore

This class defines an Online Certificate Status Protocol (OCSP) store which has been extended to provide information from the internal database.

Version:

$Revision$, $Date$

Method Summary

Modifier and Type	Method and Description
void	addCRLIssuingPoint(java.lang.String name, ICRLIssuingPointRecord rec) This method adds a CRL issuing point
void	addRepository(java.lang.String name, java.lang.String thisUpdate, IRepositoryRecord rec) This method adds a request to the default OCSP store repository.
ICRLIssuingPointRecord	createCRLIssuingPointRecord(java.lang.String name, java.math.BigInteger crlNumber, java.lang.Long crlSize, java.util.Date thisUpdate, java.util.Date nextUpdate) This method creates a CRL issuing point record.
IRepositoryRecord	createRepositoryRecord() This method creates a an OCSP default store repository record.
void	deleteCRLIssuingPointRecord(java.lang.String id) This method deletes a CRL issuing point record
long	getReqCount(java.lang.String id) This method retrieves the number of OCSP requests since startup.
int	getStateCount() This method retrieves the number of CRL updates since startup.
boolean	isNotFoundGood() This method checks to see if the OCSP response should return good when the certificate is not found.
ICRLIssuingPointRecord	readCRLIssuingPoint(java.lang.String name) This method attempts to read the CRL issuing point.
java.util.Enumeration<ICRLIssuingPointRecord>	searchAllCRLIssuingPointRecord(int maxSize) This method searches all CRL issuing points.
java.util.Enumeration<ICRLIssuingPointRecord>	searchCRLIssuingPointRecord(java.lang.String filter, int maxSize) This method searches all CRL issuing points constrained by the specified filtering mechanism.
void	updateCRL(java.security.cert.X509CRL crl) This method updates the specified CRL.
boolean	waitOnCRLUpdate() This method specifies whether or not to wait for the Certificate Revocation List (CRL) to be updated.

Methods inherited from interface com.netscape.certsrv.ocsp.IOCSPStore

getConfigParameters, setConfigParameters, validate

Methods inherited from interface com.netscape.certsrv.base.ISubsystem

getConfigStore, getId, init, setId, shutdown, startup

Method Detail

getStateCount

int getStateCount()

This method retrieves the number of CRL updates since startup.

Returns:

count the number of OCSP default stores

getReqCount

long getReqCount(java.lang.String id)

This method retrieves the number of OCSP requests since startup.

Parameters:

id - a string associated with an OCSP request

Returns:

count the number of this type of OCSP requests

createRepositoryRecord

IRepositoryRecord createRepositoryRecord()

This method creates a an OCSP default store repository record.

Returns:

IRepositoryRecord an instance of the repository record object

addRepository

void addRepository(java.lang.String name,
                   java.lang.String thisUpdate,
                   IRepositoryRecord rec)
            throws EBaseException

This method adds a request to the default OCSP store repository.

Parameters:

name - a string representing the name of this request

thisUpdate - the current request

rec - an instance of the repository record object

Throws:

EBaseException - occurs when there is an error attempting to add this request to the repository

waitOnCRLUpdate

boolean waitOnCRLUpdate()

This method specifies whether or not to wait for the Certificate Revocation List (CRL) to be updated.

Returns:

boolean true or false

updateCRL

void updateCRL(java.security.cert.X509CRL crl)
        throws EBaseException

This method updates the specified CRL.

Parameters:

crl - the CRL to be updated

Throws:

EBaseException - occurs when the CRL cannot be updated

readCRLIssuingPoint

ICRLIssuingPointRecord readCRLIssuingPoint(java.lang.String name)
                                    throws EBaseException

This method attempts to read the CRL issuing point.

Parameters:

name - the name of the CRL to be read

Returns:

ICRLIssuingPointRecord the CRL issuing point

Throws:

EBaseException - occurs when the specified CRL cannot be located

searchAllCRLIssuingPointRecord

java.util.Enumeration<ICRLIssuingPointRecord> searchAllCRLIssuingPointRecord(int maxSize)
                                                                      throws EBaseException

This method searches all CRL issuing points.

Parameters:

maxSize - specifies the largest number of hits from the search

Returns:

Enumeration a list of the CRL issuing points

Throws:

EBaseException - occurs when no CRL issuing point exists

searchCRLIssuingPointRecord

java.util.Enumeration<ICRLIssuingPointRecord> searchCRLIssuingPointRecord(java.lang.String filter,
                                                                          int maxSize)
                                                                   throws EBaseException

This method searches all CRL issuing points constrained by the specified filtering mechanism.

Parameters:

filter - a string which constrains the search

maxSize - specifies the largest number of hits from the search

Returns:

Enumeration a list of the CRL issuing points

Throws:

EBaseException - occurs when no CRL issuing point exists

createCRLIssuingPointRecord

ICRLIssuingPointRecord createCRLIssuingPointRecord(java.lang.String name,
                                                   java.math.BigInteger crlNumber,
                                                   java.lang.Long crlSize,
                                                   java.util.Date thisUpdate,
                                                   java.util.Date nextUpdate)

This method creates a CRL issuing point record.

Parameters:

name - a string representation of this CRL issuing point record

crlNumber - the number of this CRL issuing point record

crlSize - the size of this CRL issuing point record

thisUpdate - the time for this CRL issuing point record

nextUpdate - the time for the next CRL issuing point record

Returns:

ICRLIssuingPointRecord this CRL issuing point record

addCRLIssuingPoint

void addCRLIssuingPoint(java.lang.String name,
                        ICRLIssuingPointRecord rec)
                 throws EBaseException

This method adds a CRL issuing point

Parameters:

name - a string representation of this CRL issuing point record

rec - this CRL issuing point record

Throws:

EBaseException - occurs when the specified CRL issuing point record cannot be added

deleteCRLIssuingPointRecord

void deleteCRLIssuingPointRecord(java.lang.String id)
                          throws EBaseException

This method deletes a CRL issuing point record

Parameters:

id - a string representation of this CRL issuing point record

Throws:

EBaseException - occurs when the specified CRL issuing point record cannot be deleted

isNotFoundGood

boolean isNotFoundGood()

This method checks to see if the OCSP response should return good when the certificate is not found.

Returns:

boolean true or false