Class KeyStoreCertificateSource

java.lang.Object

eu.europa.esig.dss.spi.x509.CommonCertificateSource

eu.europa.esig.dss.spi.x509.KeyStoreCertificateSource

All Implemented Interfaces:

CertificateSource, Serializable

public class KeyStoreCertificateSource
extends CommonCertificateSource

Implements a CertificateSource using a KeyStore (PKCS12, JKS,...).

See Also:

• Serialized Form

Field Summary

Fields inherited from class CommonCertificateSource

certificateMatcher

Constructor Summary

Constructors

Constructor	Description
KeyStoreCertificateSource(File ksFile, String ksType, char[] ksPassword)	Constructor for KeyStoreCertificateSource with CertificatePool.
KeyStoreCertificateSource(InputStream ksStream, String ksType, char[] ksPassword)	The default constructor for KeyStoreCertificateSource.
KeyStoreCertificateSource(String ksType, char[] ksPassword)	Constructor for KeyStoreCertificateSource.
KeyStoreCertificateSource(String ksFilePath, String ksType, char[] ksPassword)	Constructor for KeyStoreCertificateSource.

Method Summary

Modifier and Type	Method	Description
void	addAllCertificatesToKeyStore(List<CertificateToken> certificates)	This method allows to add a list of certificates to the keystore
CertificateToken	addCertificate(CertificateToken certificateToAdd)	This method adds an external certificate to the source.
void	addCertificateToKeyStore(CertificateToken certificateToken)	This method allows to add a certificate in the keystore.
void	clearAllCertificates()	This method allows to remove all certificates from the keystore
void	deleteCertificateFromKeyStore(String alias)	This method allows to remove a certificate from the keystore
CertificateToken	getCertificate(String alias)	This method allows to retrieve a certificate by its alias
void	store(OutputStream os)	This method allows to store the keystore in the OutputStream

Methods inherited from class CommonCertificateSource

doesCertificateReferenceMatch, findTokensFromCertRef, getByCertificateDigest, getByEntityKey, getByPublicKey, getBySignerIdentifier, getBySki, getBySubject, getCertificates, getCertificateSourceType, getEntities, getNumberOfCertificates, getNumberOfEntities, isAllSelfSigned, isCertificateSourceEqual, isCertificateSourceEquivalent, isKnown, isTrusted, isTrustedAtTime, removeCertificate, reset

Methods inherited from class Object

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

Constructor Details

KeyStoreCertificateSource

public KeyStoreCertificateSource(String ksType,
 char[] ksPassword)

Constructor for KeyStoreCertificateSource. This constructor allows to create a new empty keystore.

Parameters:

ksType - the keystore type

ksPassword - the keystore password

KeyStoreCertificateSource

public KeyStoreCertificateSource(String ksFilePath,
 String ksType,
 char[] ksPassword)
                          throws IOException

Constructor for KeyStoreCertificateSource.

Parameters:

ksFilePath - the keystore filepath

ksType - the keystore type

ksPassword - the keystore password

Throws:

IOException - if the file not exists

KeyStoreCertificateSource

public KeyStoreCertificateSource(File ksFile,
 String ksType,
 char[] ksPassword)
                          throws IOException

Constructor for KeyStoreCertificateSource with CertificatePool.

Parameters:

ksFile - the keystore file

ksType - the keystore type

ksPassword - the keystore password

Throws:

IOException - if the file not exists

KeyStoreCertificateSource

public KeyStoreCertificateSource(InputStream ksStream,
 String ksType,
 char[] ksPassword)

The default constructor for KeyStoreCertificateSource.

Parameters:

ksStream - the inputstream with the keystore (can be null to create a new keystore)

ksType - the keystore type

ksPassword - the keystore password

Method Details

getCertificate

public CertificateToken getCertificate(String alias)

This method allows to retrieve a certificate by its alias

Parameters:

alias - the certificate alias in the keystore

Returns:

the certificate

addAllCertificatesToKeyStore

public void addAllCertificatesToKeyStore(List<CertificateToken> certificates)

This method allows to add a list of certificates to the keystore

Parameters:

certificates - the list of certificates

addCertificateToKeyStore

public void addCertificateToKeyStore(CertificateToken certificateToken)

This method allows to add a certificate in the keystore. The generated alias will be the DSS ID.

Parameters:

certificateToken - the certificate to be added in the keystore

addCertificate

public CertificateToken addCertificate(CertificateToken certificateToAdd)

Description copied from class: CommonCertificateSource

This method adds an external certificate to the source. If the public is already known, the certificate is merged in the CertificateSourceEntity

Specified by:

addCertificate in interface CertificateSource

Overrides:

addCertificate in class CommonCertificateSource

Parameters:

certificateToAdd - the certificate to be added

Returns:

the corresponding certificate token

deleteCertificateFromKeyStore

public void deleteCertificateFromKeyStore(String alias)

This method allows to remove a certificate from the keystore

Parameters:

alias - the certificate alias

clearAllCertificates

public void clearAllCertificates()

This method allows to remove all certificates from the keystore

store

public void store(OutputStream os)

This method allows to store the keystore in the OutputStream

Parameters:

os - the OutputStream where to store the keystore