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

Class OnlineOCSPSource

java.lang.Object

eu.europa.esig.dss.service.ocsp.OnlineOCSPSource

All Implemented Interfaces:

OCSPSource, OnlineRevocationSource<OCSP>, RevocationSource<OCSP>, RevocationSourceAlternateUrlsSupport<OCSP>, Serializable

public class OnlineOCSPSource
extends Object
implements OCSPSource, RevocationSourceAlternateUrlsSupport<OCSP>, OnlineRevocationSource<OCSP>

Online OCSP repository. This implementation will contact the OCSP Responder to retrieve the OCSP response.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface eu.europa.esig.dss.spi.x509.revocation.OnlineRevocationSource

OnlineRevocationSource.RevocationTokenAndUrl<R extends Revocation>

Constructor Summary

Constructors

Constructor	Description
OnlineOCSPSource()	Create an OCSP source The default constructor for OnlineOCSPSource.
OnlineOCSPSource(DataLoader dataLoader)	Creates an Online OCSP Source with the provided DataLoader instance.

Method Summary

Modifier and Type	Method	Description
OCSPToken	getRevocationToken(CertificateToken certificateToken, CertificateToken issuerCertificateToken)	This method retrieves a RevocationToken for the certificateToken
OCSPToken	getRevocationToken(CertificateToken certificateToken, CertificateToken issuerCertificateToken, List<String> alternativeUrls)	Gets an RevocationToken for the given certificate / issuer's certificate couple.
OnlineRevocationSource.RevocationTokenAndUrl<OCSP>	getRevocationTokenAndUrl(CertificateToken certificateToken, CertificateToken issuerToken)	This method retrieves a RevocationTokenAndUrl for the certificateToken
protected OnlineRevocationSource.RevocationTokenAndUrl<OCSP>	getRevocationTokenAndUrl(CertificateToken certificateToken, CertificateToken issuerToken, List<String> ocspUrls)	Extracts an OCSP token for a certificateToken from the given list of ocspUrls
void	setCertIDDigestAlgorithm(DigestAlgorithm certIDDigestAlgorithm)	This method allows setting of DigestAlgorithm to be used in hash calculation for CertID element in an OCSP request building
void	setDataLoader(DataLoader dataLoader)	Set the DataLoader to use for querying a revocation server.
void	setNonceSource(NonceSource nonceSource)	Set the NonceSource to use for querying the OCSP server.

Methods inherited from class java.lang.Object

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

Constructor Details

OnlineOCSPSource

public OnlineOCSPSource()

Create an OCSP source The default constructor for OnlineOCSPSource. The default OCSPDataLoader is set. It is possible to change it with #setDataLoader(dataLoader).

OnlineOCSPSource

public OnlineOCSPSource(DataLoader dataLoader)

Creates an Online OCSP Source with the provided DataLoader instance. It is still possible to change the defined instance with #setDataLoader(dataLoader).

Parameters:

dataLoader - DataLoader to use

Method Details

setDataLoader

public void setDataLoader(DataLoader dataLoader)

Description copied from interface: OnlineRevocationSource

Set the DataLoader to use for querying a revocation server.

Specified by:

setDataLoader in interface OnlineRevocationSource<OCSP>

Parameters:

dataLoader - the component that allows to retrieve a revocation response using HTTP.

setNonceSource

public void setNonceSource(NonceSource nonceSource)

Set the NonceSource to use for querying the OCSP server.

Parameters:

nonceSource - the component that prevents the replay attack.

setCertIDDigestAlgorithm

public void setCertIDDigestAlgorithm(DigestAlgorithm certIDDigestAlgorithm)

This method allows setting of DigestAlgorithm to be used in hash calculation for CertID element in an OCSP request building

Parameters:

certIDDigestAlgorithm - DigestAlgorithm

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>

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,
 List<String> alternativeUrls)

Description copied from interface: RevocationSourceAlternateUrlsSupport

Gets an RevocationToken for the given certificate / issuer's certificate couple. The coherence between the response and the request is checked.

Specified by:

getRevocationToken in interface RevocationSourceAlternateUrlsSupport<OCSP>

Parameters:

certificateToken - The CertificateToken for which the request is made

issuerCertificateToken - The CertificateToken which is the issuer of the certificateToken

alternativeUrls - The list of alternative urls to call

Returns:

RevocationToken containing information about the validity of the cert

getRevocationTokenAndUrl

public OnlineRevocationSource.RevocationTokenAndUrl<OCSP> getRevocationTokenAndUrl(CertificateToken certificateToken,
 CertificateToken issuerToken)

Description copied from interface: OnlineRevocationSource

This method retrieves a RevocationTokenAndUrl for the certificateToken

Specified by:

getRevocationTokenAndUrl in interface OnlineRevocationSource<OCSP>

Parameters:

certificateToken - The CertificateToken for which the request is made

issuerToken - The CertificateToken which is the issuer of the certificateToken

Returns:

an instance of RevocationTokenAndUrl

getRevocationTokenAndUrl

protected OnlineRevocationSource.RevocationTokenAndUrl<OCSP> getRevocationTokenAndUrl(CertificateToken certificateToken,
 CertificateToken issuerToken,
 List<String> ocspUrls)

Extracts an OCSP token for a certificateToken from the given list of ocspUrls

Parameters:

certificateToken - CertificateToken to get an OCSP token for

issuerToken - CertificateToken issued the certificateToken

ocspUrls - a list of String URLs to use to access an OCSP token

Returns:

OnlineRevocationSource.RevocationTokenAndUrl