com.guardtime.ksi

Class PublicationsHandlerBuilder

java.lang.Object

com.guardtime.ksi.PublicationsHandlerBuilder

public final class PublicationsHandlerBuilder
extends Object

Obtaining and configuring the PublicationsHandler object(s).

It is mandatory to set publications file client and publications file trusted certificate selector.

Constructor Summary

Constructors

Constructor and Description
PublicationsHandlerBuilder()

Method Summary

Modifier and Type	Method and Description
PublicationsHandler	build() Builds the PublicationsHandler instance.
PublicationsHandlerBuilder	setKsiProtocolPublicationsFileClient(KSIPublicationsFileClient publicationsFileClient) Sets the publications file client to be used to download publications file.
PublicationsHandlerBuilder	setPublicationsFileCacheExpirationTime(long expirationTime) Sets the publications file expiration time.
PublicationsHandlerBuilder	setPublicationsFileCertificateConstraints(CertSelector certSelector) Sets the CertSelector to be used to verify the certificate that was used to sign the publications file.
PublicationsHandlerBuilder	setPublicationsFilePkiTrustStore(File file, String password) Loads the KeyStore from the file system and sets the KeyStore to be used as truststore to verify the certificate that was used to sign the publications file.
PublicationsHandlerBuilder	setPublicationsFilePkiTrustStore(KeyStore trustStore) Sets the KeyStore to be used as truststore to verify the certificate that was used to sign the publications file.

Methods inherited from class java.lang.Object

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

Constructor Detail

PublicationsHandlerBuilder

public PublicationsHandlerBuilder()

Method Detail

setKsiProtocolPublicationsFileClient

public PublicationsHandlerBuilder setKsiProtocolPublicationsFileClient(KSIPublicationsFileClient publicationsFileClient)

Sets the publications file client to be used to download publications file.

Parameters:

publicationsFileClient - instance of KSIPublicationsFileClient.

Returns:

Instance of PublicationsHandlerBuilder.

setPublicationsFilePkiTrustStore

public PublicationsHandlerBuilder setPublicationsFilePkiTrustStore(KeyStore trustStore)
                                                            throws KSIException

Sets the KeyStore to be used as truststore to verify the certificate that was used to sign the publications file. If not set, the default Java keystore is used.

Parameters:

trustStore - truststore to be used to verify certificates.

Returns:

Instance of PublicationsHandlerBuilder.

Throws:

KSIException - when any error occurs.

setPublicationsFilePkiTrustStore

public PublicationsHandlerBuilder setPublicationsFilePkiTrustStore(File file,
                                                                   String password)
                                                            throws KSIException

Loads the KeyStore from the file system and sets the KeyStore to be used as truststore to verify the certificate that was used to sign the publications file.

Parameters:

file - keystore file on disk, not null.

password - password of the keystore, null if keystore isn't protected by password.

Returns:

Instance of PublicationsHandlerBuilder.

Throws:

KSIException - when any error occurs.

setPublicationsFileCertificateConstraints

public PublicationsHandlerBuilder setPublicationsFileCertificateConstraints(CertSelector certSelector)

Sets the CertSelector to be used to verify the certificate that was used to sign the publications file. X509CertSelector can be used instead of X509CertificateSubjectRdnSelector

Parameters:

certSelector - instance of CertSelector.

Returns:

Instance of PublicationsHandlerBuilder.

See Also:

X509CertSelector

setPublicationsFileCacheExpirationTime

public PublicationsHandlerBuilder setPublicationsFileCacheExpirationTime(long expirationTime)

Sets the publications file expiration time. Default value is 0.

build

public PublicationsHandler build()
                          throws KSIException

Builds the PublicationsHandler instance. Checks that publications file client and KSI publications file trusted certificate selector are set. If not configured, NullPointerException is thrown.

Returns:

Publications handler (PublicationsHandler).

Throws:

KSIException - will be thrown when errors occur on PublicationsHandler class initialization.