Package eu.europa.esig.dss.service.ocsp

Class FileCacheOCSPSource

java.lang.Object

eu.europa.esig.dss.spi.x509.revocation.RepositoryRevocationSource<OCSP>

eu.europa.esig.dss.spi.x509.revocation.FileRevocationSource<OCSP>

eu.europa.esig.dss.service.ocsp.FileCacheOCSPSource

All Implemented Interfaces:

MultipleRevocationSource<OCSP>, OCSPSource, RevocationSource<OCSP>, Serializable

public class FileCacheOCSPSource
extends FileRevocationSource<OCSP>
implements OCSPSource

OCSPSource that stores its OCSP responses on the file system.

WARNING: The class represents an experimental functionality and included in the DSS version 6.3. Please note the class was not extensively tested.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class eu.europa.esig.dss.spi.x509.revocation.FileRevocationSource

FileRevocationSource.FileCacheEntry

Field Summary

Fields inherited from class eu.europa.esig.dss.spi.x509.revocation.RepositoryRevocationSource

proxiedSource

Constructor Summary

Constructors

Constructor	Description
FileCacheOCSPSource()	Empty constructor.
FileCacheOCSPSource(OCSPSource proxiedSource)	Constructor that initializes the file cache OCSP source with a proxiedOCSPSource provided.

Method Summary

Modifier and Type	Method	Description
protected List<String>	getRevocationAccessUrls(CertificateToken certificateToken)	Returns a revocation access URLs of the given revocation type for the provided CertificateToken
protected String	getRevocationFileExtension()	Gets the file extension used for cached revocation files.
OCSPToken	getRevocationToken(CertificateToken certificateToken, CertificateToken issuerCertificateToken)	This method retrieves a RevocationToken for the certificateToken
OCSPToken	getRevocationToken(CertificateToken certificateToken, CertificateToken issuerCertificateToken, boolean forceRefresh)	Retrieves a revocation token for the given CertificateToken
protected String	getRevocationTokenKey(CertificateToken certificateToken, String revocationAccessUrl)	Gets a unique revocation token identifier used to store the revocation token for this certificateToken within a repository
protected List<String>	initRevocationTokenKeys(CertificateToken certificateToken)	Initialize a list of revocation token keys String from the given CertificateToken
protected OCSPToken	reconstructTokenFromEncodedData(FileRevocationSource<OCSP>.FileCacheEntry revocationCache, CertificateToken certificateToken, CertificateToken issuerCertToken)	Creates a revocation token from cached encoded data

Methods inherited from class eu.europa.esig.dss.spi.x509.revocation.FileRevocationSource

clearCache, deleteCacheFile, findRevocations, getFileCacheDirectory, insertRevocation, removeRevocation, saveRevocationToken, setFileCacheDirectory, updateRevocation

Methods inherited from class eu.europa.esig.dss.spi.x509.revocation.RepositoryRevocationSource

getRevocationSourceUrl, getRevocationTokens, getRevocationTokens, isNotExpired, setDefaultNextUpdateDelay, setMaxNextUpdateDelay, setProxySource, setRemoveExpired

Methods inherited from class java.lang.Object

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

Constructor Details

FileCacheOCSPSource

public FileCacheOCSPSource()

Empty constructor. The proxied OCSPSource can be provided using the #setProxySource method.

FileCacheOCSPSource

public FileCacheOCSPSource(OCSPSource proxiedSource)

Constructor that initializes the file cache OCSP source with a proxiedOCSPSource provided.

Parameters:

proxiedSource - OCSPSource to be used to load OCSP when the corresponding revocation document is not available in the file system.

Method Details

reconstructTokenFromEncodedData

protected OCSPToken reconstructTokenFromEncodedData(FileRevocationSource<OCSP>.FileCacheEntry revocationCache,
 CertificateToken certificateToken,
 CertificateToken issuerCertToken)

Description copied from class: FileRevocationSource

Creates a revocation token from cached encoded data

Specified by:

reconstructTokenFromEncodedData in class FileRevocationSource<OCSP>

Parameters:

revocationCache - FileRevocationSource<R extends Revocation>.FileCacheEntry the cached revocation data entry

certificateToken - CertificateToken the certificate token

issuerCertToken - CertificateToken the issuer certificate token

Returns:

the revocation token or null if creation fails

getRevocationFileExtension

protected String getRevocationFileExtension()

Description copied from class: FileRevocationSource

Gets the file extension used for cached revocation files.

Specified by:

getRevocationFileExtension in class FileRevocationSource<OCSP>

Returns:

the file extension (e.g., ".crl" or ".ocsp")

getRevocationTokenKey

protected String getRevocationTokenKey(CertificateToken certificateToken,
 String revocationAccessUrl)

Description copied from class: RepositoryRevocationSource

Gets a unique revocation token identifier used to store the revocation token for this certificateToken within a repository

Specified by:

getRevocationTokenKey in class RepositoryRevocationSource<OCSP>

Parameters:

certificateToken - CertificateToken

revocationAccessUrl - String representing a URL used to download the revocation token from

Returns:

String revocation token key

getRevocationAccessUrls

protected List<String> getRevocationAccessUrls(CertificateToken certificateToken)

Description copied from class: RepositoryRevocationSource

Returns a revocation access URLs of the given revocation type for the provided CertificateToken

Specified by:

getRevocationAccessUrls in class RepositoryRevocationSource<OCSP>

Parameters:

certificateToken - CertificateToken to get revocation URLs for

Returns:

a list of String URLs

initRevocationTokenKeys

protected List<String> initRevocationTokenKeys(CertificateToken certificateToken)

Description copied from class: RepositoryRevocationSource

Initialize a list of revocation token keys String from the given CertificateToken

Specified by:

initRevocationTokenKeys in class RepositoryRevocationSource<OCSP>

Parameters:

certificateToken - CertificateToken

Returns:

list of String revocation keys

getRevocationToken

public OCSPToken getRevocationToken(CertificateToken certificateToken,
 CertificateToken issuerCertificateToken,
 boolean forceRefresh)

Description copied from class: RepositoryRevocationSource

Retrieves a revocation token for the given CertificateToken

Overrides:

getRevocationToken in class RepositoryRevocationSource<OCSP>

Parameters:

certificateToken - CertificateToken

issuerCertificateToken - CertificateToken of the issuer of certificateToken

forceRefresh - if true, explicitly skips the cache

Returns:

RevocationToken

getRevocationToken

public OCSPToken getRevocationToken(CertificateToken certificateToken,
 CertificateToken issuerCertificateToken)

Description copied from interface: RevocationSource

This method retrieves a RevocationToken for the certificateToken

Specified by:

getRevocationToken in interface OCSPSource

Specified by:

getRevocationToken in interface RevocationSource<OCSP>

Overrides:

getRevocationToken in class RepositoryRevocationSource<OCSP>

Parameters:

certificateToken - The CertificateToken for which the request is made

issuerCertificateToken - The CertificateToken which is the issuer of the certificateToken

Returns:

an instance of RevocationToken