Package eu.europa.esig.dss.service.crl

Class OnlineCRLSource

java.lang.Object

eu.europa.esig.dss.service.crl.OnlineCRLSource

All Implemented Interfaces:

CRLSource, OnlineRevocationSource<CRL>, RevocationSource<CRL>, RevocationSourceAlternateUrlsSupport<CRL>, Serializable

public class OnlineCRLSource
extends Object
implements CRLSource, RevocationSourceAlternateUrlsSupport<CRL>, OnlineRevocationSource<CRL>

Online CRL repository. This CRL repository implementation will download the CRLs from the given CRL URIs. Note that for the HTTP kind of URLs you can provide dedicated data loader. If the data loader is not provided the standard load from URI is provided. For FTP the standard load from URI is provided. For LDAP kind of URLs an internal implementation using apache-ldap-api is provided.

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
OnlineCRLSource()	The default constructor.
OnlineCRLSource(DataLoader dataLoader)	This constructor allows to set a specific DataLoader.

Method Summary

Modifier and Type	Method	Description
CRLToken	getRevocationToken(CertificateToken certificateToken, CertificateToken issuerCertificateToken)	This method retrieves a RevocationToken for the certificateToken
CRLToken	getRevocationToken(CertificateToken certificateToken, CertificateToken issuerToken, List<String> alternativeUrls)	Gets an RevocationToken for the given certificate / issuer's certificate couple.
OnlineRevocationSource.RevocationTokenAndUrl<CRL>	getRevocationTokenAndUrl(CertificateToken certificateToken, CertificateToken issuerToken)	This method retrieves a RevocationTokenAndUrl for the certificateToken
protected OnlineRevocationSource.RevocationTokenAndUrl<CRL>	getRevocationTokenAndUrl(CertificateToken certificateToken, CertificateToken issuerToken, List<String> crlUrls)	Extracts a CRL token for a certificateToken from the given list of crlUrls
void	setDataLoader(DataLoader dataLoader)	Set the DataLoader to use for querying a revocation server.
void	setPreferredProtocol(Protocol preferredProtocol)	This method allows to set the preferred protocol.

Methods inherited from class java.lang.Object

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

Constructor Details

OnlineCRLSource

public OnlineCRLSource()

The default constructor. A CommonsDataLoader is created.

OnlineCRLSource

public OnlineCRLSource(DataLoader dataLoader)

This constructor allows to set a specific DataLoader.

Parameters:

dataLoader - the component that allows to retrieve the data using any protocol: HTTP, HTTPS, FTP, LDAP.

Method Details

setPreferredProtocol

public void setPreferredProtocol(Protocol preferredProtocol)

This method allows to set the preferred protocol. This parameter is used used when retrieving the CRL to choose the canal.
Possible values are: http, ldap, ftp

Parameters:

preferredProtocol - Protocol that is used first to retrieve the revocation data

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<CRL>

Parameters:

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

getRevocationToken

public CRLToken getRevocationToken(CertificateToken certificateToken,
 CertificateToken issuerCertificateToken)

Description copied from interface: RevocationSource

This method retrieves a RevocationToken for the certificateToken

Specified by:

getRevocationToken in interface CRLSource

Specified by:

getRevocationToken in interface RevocationSource<CRL>

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 CRLToken getRevocationToken(CertificateToken certificateToken,
 CertificateToken issuerToken,
 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<CRL>

Parameters:

certificateToken - The CertificateToken for which the request is made

issuerToken - 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<CRL> getRevocationTokenAndUrl(CertificateToken certificateToken,
 CertificateToken issuerToken)

Description copied from interface: OnlineRevocationSource

This method retrieves a RevocationTokenAndUrl for the certificateToken

Specified by:

getRevocationTokenAndUrl in interface OnlineRevocationSource<CRL>

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<CRL> getRevocationTokenAndUrl(CertificateToken certificateToken,
 CertificateToken issuerToken,
 List<String> crlUrls)

Extracts a CRL token for a certificateToken from the given list of crlUrls

Parameters:

certificateToken - CertificateToken to get a CRL token for

issuerToken - CertificateToken issued the certificateToken

crlUrls - a list of String URLs to use to access a CRL token

Returns:

OnlineRevocationSource.RevocationTokenAndUrl