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

Class JdbcCacheOCSPSource

java.lang.Object

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

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

eu.europa.esig.dss.service.ocsp.JdbcCacheOCSPSource

All Implemented Interfaces:

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

public class JdbcCacheOCSPSource
extends JdbcRevocationSource<OCSP>
implements OCSPSource

OCSPSource that retrieve information from a JDBC data-source.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	JdbcCacheOCSPSource.SqlOCSPResponse	Represents an OCSP record extracted from the SQL database table

Field Summary

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

proxiedSource

Constructor Summary

Constructors

Constructor	Description
JdbcCacheOCSPSource()	Default constructor

Method Summary

Modifier and Type	Method	Description
protected RevocationToken<OCSP>	buildRevocationTokenFromResult(SqlRecord response, CertificateToken certificateToken, CertificateToken issuerCert)	Builds RevocationToken from the obtained ResultSet
protected SqlQuery	getCreateTableQuery()	Returns CREATE_TABLE sql query
protected SqlQuery	getDeleteTableQuery()	Returns an sql query to remove a table from DB
protected SqlQuery	getInsertRevocationTokenEntryQuery()	Returns an SQL query to insert a new revocation token to a table
protected SqlQuery	getRemoveRevocationTokenEntryQuery()	Returns an sql query to remove a revocation token from DB
protected List<String>	getRevocationAccessUrls(CertificateToken certificateToken)	Returns a revocation access URLs of the given revocation type for the provided CertificateToken
protected SqlSelectQuery	getRevocationDataExtractQuery()	Returns a request to find a revocation data
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 urlString)	Gets a unique revocation token identifier used to store the revocation token for this certificateToken within a repository
protected SqlQuery	getTableExistenceQuery()	Returns an sql query to check table existence
protected SqlQuery	getUpdateRevocationTokenEntryQuery()	Returns an SQL query to update a revocation token in a table
protected final List<String>	initRevocationTokenKeys(CertificateToken certificateToken)	Initialize a list of revocation token keys String from the given CertificateToken
protected void	insertRevocation(String revocationKey, RevocationToken<OCSP> token)	Inserts a new RevocationToken into the cache
protected void	updateRevocation(String revocationKey, RevocationToken<OCSP> token)	Updates the currently stored OCSP token for the given key with supplied token.

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

destroyTable, findRevocations, getJdbcCacheConnector, initTable, isTableExists, removeRevocation, setJdbcCacheConnector

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

JdbcCacheOCSPSource

public JdbcCacheOCSPSource()

Default constructor

Method Details

getCreateTableQuery

protected SqlQuery getCreateTableQuery()

Description copied from class: JdbcRevocationSource

Returns CREATE_TABLE sql query

Specified by:

getCreateTableQuery in class JdbcRevocationSource<OCSP>

Returns:

SqlQuery

getTableExistenceQuery

protected SqlQuery getTableExistenceQuery()

Description copied from class: JdbcRevocationSource

Returns an sql query to check table existence

Specified by:

getTableExistenceQuery in class JdbcRevocationSource<OCSP>

Returns:

SqlQuery

getDeleteTableQuery

protected SqlQuery getDeleteTableQuery()

Description copied from class: JdbcRevocationSource

Returns an sql query to remove a table from DB

Specified by:

getDeleteTableQuery in class JdbcRevocationSource<OCSP>

Returns:

SqlQuery

getInsertRevocationTokenEntryQuery

protected SqlQuery getInsertRevocationTokenEntryQuery()

Description copied from class: JdbcRevocationSource

Returns an SQL query to insert a new revocation token to a table

Specified by:

getInsertRevocationTokenEntryQuery in class JdbcRevocationSource<OCSP>

Returns:

SqlQuery

getUpdateRevocationTokenEntryQuery

protected SqlQuery getUpdateRevocationTokenEntryQuery()

Description copied from class: JdbcRevocationSource

Returns an SQL query to update a revocation token in a table

Specified by:

getUpdateRevocationTokenEntryQuery in class JdbcRevocationSource<OCSP>

Returns:

SqlQuery

getRemoveRevocationTokenEntryQuery

protected SqlQuery getRemoveRevocationTokenEntryQuery()

Description copied from class: JdbcRevocationSource

Returns an sql query to remove a revocation token from DB

Specified by:

getRemoveRevocationTokenEntryQuery in class JdbcRevocationSource<OCSP>

Returns:

SqlQuery

getRevocationDataExtractQuery

protected SqlSelectQuery getRevocationDataExtractQuery()

Description copied from class: JdbcRevocationSource

Returns a request to find a revocation data

Specified by:

getRevocationDataExtractQuery in class JdbcRevocationSource<OCSP>

Returns:

SqlSelectQuery

initRevocationTokenKeys

protected final 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

buildRevocationTokenFromResult

protected RevocationToken<OCSP> buildRevocationTokenFromResult(SqlRecord response,
 CertificateToken certificateToken,
 CertificateToken issuerCert)
                                                        throws DSSExternalResourceException

Description copied from class: JdbcRevocationSource

Builds RevocationToken from the obtained ResultSet

Specified by:

buildRevocationTokenFromResult in class JdbcRevocationSource<OCSP>

Parameters:

response - SqlRecord represent the extracted record row

certificateToken - CertificateToken of certificate to get revocation data for

issuerCert - CertificateToken if issuer of the certificateToken

Returns:

RevocationToken

Throws:

DSSExternalResourceException - if an exception occurs during the attempt to extract token

insertRevocation

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

Description copied from class: RepositoryRevocationSource

Inserts a new RevocationToken into the cache

Specified by:

insertRevocation in class RepositoryRevocationSource<OCSP>

Parameters:

revocationKey - String

token - RevocationToken

updateRevocation

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

Updates the currently stored OCSP token for the given key with supplied token.

Specified by:

updateRevocation in class RepositoryRevocationSource<OCSP>

Parameters:

revocationKey - String the key of the revocation data to be updated

token - new OCSP token

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

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

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

getRevocationTokenKey

protected String getRevocationTokenKey(CertificateToken certificateToken,
 String urlString)

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

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

Returns:

String revocation token key