Package eu.europa.esig.dss.spi.x509.revocation

Class FileRevocationSource<R extends Revocation>

java.lang.Object

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

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

Type Parameters:

R - CRL or OCSP

All Implemented Interfaces:

MultipleRevocationSource<R>, RevocationSource<R>, Serializable

Direct Known Subclasses:

FileCacheCRLSource, FileCacheOCSPSource

public abstract class FileRevocationSource<R extends Revocation>
extends RepositoryRevocationSource<R>

Abstract class that extends RepositoryRevocationSource to provide file-based caching functionality for revocation data.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	FileRevocationSource.FileCacheEntry	This class represents a cache entry related to a single revocation token

Field Summary

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

proxiedSource

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FileRevocationSource()	Empty constructor.
protected	FileRevocationSource(RevocationSource<R> proxiedSource)	Constructor that initializes the file revocation source with a proxied revocation source provided.

Method Summary

Modifier and Type	Method	Description
void	clearCache()	Clears all cached files from the cache directory
protected void	deleteCacheFile(File cacheFile)	Deletes a cache file
protected List<RevocationToken<R>>	findRevocations(String key, CertificateToken certificateToken, CertificateToken issuerCertToken)	Finds a list of RevocationTokens in the cache for the given certificateToken with the corresponding key
File	getFileCacheDirectory()	Gets the cache directory
protected abstract String	getRevocationFileExtension()	Gets the file extension used for cached revocation files.
protected void	insertRevocation(String revocationKey, RevocationToken<R> token)	Inserts a new RevocationToken into the cache
protected abstract RevocationToken<R>	reconstructTokenFromEncodedData(FileRevocationSource<R>.FileCacheEntry revocationCache, CertificateToken certificateToken, CertificateToken issuerCertToken)	Creates a revocation token from cached encoded data
protected void	removeRevocation(String revocationKey)	Removes the RevocationToken from cache with the given key
protected void	saveRevocationToken(FileRevocationSource<R>.FileCacheEntry revocationCache, RevocationToken<R> token)	Writes the revocationToken within the file system
void	setFileCacheDirectory(File fileCacheDirectory)	This method allows to set the file cache directory.
protected void	updateRevocation(String revocationKey, RevocationToken<R> token)	Updates the RevocationToken into cache

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

getRevocationAccessUrls, getRevocationSourceUrl, getRevocationToken, getRevocationToken, getRevocationTokenKey, getRevocationTokens, getRevocationTokens, initRevocationTokenKeys, 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

FileRevocationSource

protected FileRevocationSource()

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

FileRevocationSource

protected FileRevocationSource(RevocationSource<R> proxiedSource)

Constructor that initializes the file revocation source with a proxied revocation source provided.

Parameters:

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

Method Details

setFileCacheDirectory

public void setFileCacheDirectory(File fileCacheDirectory)

This method allows to set the file cache directory. If the cache folder does not exist then it's created. Default : Temporary directory with a "/dss-cache-revocation" subdirectory

Parameters:

fileCacheDirectory - File pointing the cache folder to be used.

getFileCacheDirectory

public File getFileCacheDirectory()

Gets the cache directory

Returns:

File the cache directory

findRevocations

protected List<RevocationToken<R>> findRevocations(String key,
 CertificateToken certificateToken,
 CertificateToken issuerCertToken)

Description copied from class: RepositoryRevocationSource

Finds a list of RevocationTokens in the cache for the given certificateToken with the corresponding key

Specified by:

findRevocations in class RepositoryRevocationSource<R extends Revocation>

Parameters:

key - the key String

certificateToken - CertificateToken

issuerCertToken - CertificateToken

Returns:

a list of RevocationToken objects

insertRevocation

protected void insertRevocation(String revocationKey,
 RevocationToken<R> token)

Description copied from class: RepositoryRevocationSource

Inserts a new RevocationToken into the cache

Specified by:

insertRevocation in class RepositoryRevocationSource<R extends Revocation>

Parameters:

revocationKey - String

token - RevocationToken

saveRevocationToken

protected void saveRevocationToken(FileRevocationSource<R>.FileCacheEntry revocationCache,
 RevocationToken<R> token)

Writes the revocationToken within the file system

Parameters:

revocationCache - FileRevocationSource<R extends Revocation>.FileCacheEntry

token - RevocationToken to store

updateRevocation

protected void updateRevocation(String revocationKey,
 RevocationToken<R> token)

Description copied from class: RepositoryRevocationSource

Updates the RevocationToken into cache

Specified by:

updateRevocation in class RepositoryRevocationSource<R extends Revocation>

Parameters:

revocationKey - String

token - RevocationToken

removeRevocation

protected void removeRevocation(String revocationKey)

Description copied from class: RepositoryRevocationSource

Removes the RevocationToken from cache with the given key

Specified by:

removeRevocation in class RepositoryRevocationSource<R extends Revocation>

Parameters:

revocationKey - String

reconstructTokenFromEncodedData

protected abstract RevocationToken<R> reconstructTokenFromEncodedData(FileRevocationSource<R>.FileCacheEntry revocationCache,
 CertificateToken certificateToken,
 CertificateToken issuerCertToken)

Creates a revocation token from cached encoded data

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 abstract String getRevocationFileExtension()

Gets the file extension used for cached revocation files.

Returns:

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

deleteCacheFile

protected void deleteCacheFile(File cacheFile)

Deletes a cache file

Parameters:

cacheFile - the file to delete

clearCache

public void clearCache()

Clears all cached files from the cache directory