Package com.helger.as2lib.cert

Class AbstractCertificateFactory

java.lang.Object

com.helger.as2lib.AbstractDynamicComponent

com.helger.as2lib.cert.AbstractCertificateFactory

All Implemented Interfaces:

IAliasedCertificateFactory, ICertificateFactory, IKeyStoreCertificateFactory, IDynamicComponent

Direct Known Subclasses:

CertificateFactory, PredefinedCertificateFactory

@ThreadSafe
public abstract class AbstractCertificateFactory
extends AbstractDynamicComponent
implements IKeyStoreCertificateFactory, IAliasedCertificateFactory

Abstract base implementation of a read-only Certificate factory that operates on a KeyStore object. The only method to be implemented is IKeyStoreCertificateFactory.reinitKeyStore() which is responsible for setting the keystore. The protected method setKeyStore(KeyStore) may be used to work around the default behaviour and provide an arbitrary implementation.

Since:

4.6.4

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_PASSWORD
static final String	ATTR_TYPE	Key store type; since 4.0.0
static final com.helger.security.keystore.EKeyStoreType	DEFAULT_KEY_STORE_TYPE

Fields inherited from class com.helger.as2lib.AbstractDynamicComponent

m_aRWLock

Constructor Summary

Constructors

Constructor	Description
AbstractCertificateFactory()

Method Summary

Modifier and Type	Method	Description
void	addCertificate(String sAlias, X509Certificate aCert, boolean bOverwrite)
void	addPrivateKey(String sAlias, Key aKey, String sPassword)
void	clearCertificates()
protected KeyStore	createNewKeyStore(com.helger.security.keystore.EKeyStoreType eKeyStoreType)
protected final void	debugLog(Supplier<String> aSupplier)
boolean	equals(Object o)
String	getAlias(Partnership aPartnership, ECertificatePartnershipType ePartnershipType)
X509Certificate	getCertificate(IBaseMessage aMsg, ECertificatePartnershipType ePartnershipType)	Get the certificate of the specified type for the partnership defined in the provided message
X509Certificate	getCertificate(String sAlias)
com.helger.commons.collection.impl.ICommonsOrderedMap<String,X509Certificate>	getCertificates()
KeyStore	getKeyStore()
final String	getKeyStoreType()
char[]	getPassword()
PrivateKey	getPrivateKey(X509Certificate aCert)
protected String	getUnifiedAlias(String sAlias)	Overridable method to perform unifications on aliases, e.g. for lower casing when using Oracle JDKs PKCS12 implementation.
int	hashCode()
void	initDynamicComponent(IAS2Session aSession, com.helger.commons.collection.attr.IStringMap aOptions)	After creating a Component object, this method should be called to set any parameters used by the component.
protected void	initEmptyKeyStore()	This method is responsible to create a new empty keystore based on the configured type.
protected X509Certificate	internalGetCertificate(String sAlias, ECertificatePartnershipType ePartnershipType)
final boolean	isDebugLogEnabled()
void	load(InputStream aIS, char[] aPassword)
protected void	onChange()	Custom callback method that is invoked if something changes in the key store.
void	removeCertificate(String sAlias)
void	removeCertificate(X509Certificate aCert)
void	save(OutputStream aOS, char[] aPassword)
final void	setDebugLogEnaled(boolean bDebugLog)
protected final void	setKeyStore(KeyStore aKeyStore)	Internal method to set the KeyStore used internally.
final void	setKeyStoreType(com.helger.security.keystore.IKeyStoreType aKeyStoreType)
final void	setKeyStoreType(String sKeyStoreType)
void	setPassword(String sPassword)

Methods inherited from class com.helger.as2lib.AbstractDynamicComponent

attrs, getAttributeAsIntRequired, getAttributeAsStringRequired, getName, getSession, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.as2lib.cert.ICertificateFactory

getCertificateOrNull

Methods inherited from interface com.helger.as2lib.IDynamicComponent

attrs, getName, getSession

Methods inherited from interface com.helger.as2lib.cert.IKeyStoreCertificateFactory

reinitKeyStore

Field Details

DEFAULT_KEY_STORE_TYPE

public static final com.helger.security.keystore.EKeyStoreType DEFAULT_KEY_STORE_TYPE

ATTR_TYPE

public static final String ATTR_TYPE

Key store type; since 4.0.0

See Also:

• Constant Field Values

ATTR_PASSWORD

public static final String ATTR_PASSWORD

See Also:

• Constant Field Values

Constructor Details

AbstractCertificateFactory

public AbstractCertificateFactory()

Method Details

isDebugLogEnabled

public final boolean isDebugLogEnabled()

setDebugLogEnaled

public final void setDebugLogEnaled(boolean bDebugLog)

debugLog

protected final void debugLog(@Nonnull
 Supplier<String> aSupplier)

getKeyStoreType

@Nullable
public final String getKeyStoreType()

setKeyStoreType

public final void setKeyStoreType(@Nullable
 com.helger.security.keystore.IKeyStoreType aKeyStoreType)

setKeyStoreType

public final void setKeyStoreType(@Nullable
 String sKeyStoreType)

setPassword

public void setPassword(@Nullable
 String sPassword)

getPassword

@Nullable
public char[] getPassword()

createNewKeyStore

@Nonnull
@OverrideOnDemand
protected KeyStore createNewKeyStore(@Nonnull
 com.helger.security.keystore.EKeyStoreType eKeyStoreType)
                              throws GeneralSecurityException

Throws:

GeneralSecurityException

initDynamicComponent

public void initDynamicComponent(@Nonnull
 IAS2Session aSession,
 @Nullable
 com.helger.commons.collection.attr.IStringMap aOptions)
                          throws AS2Exception

Description copied from interface: IDynamicComponent

After creating a Component object, this method should be called to set any parameters used by the component. Component implementations typically have required parameter checking and code to start timers and threads within this method.

Specified by:

initDynamicComponent in interface IDynamicComponent

Overrides:

initDynamicComponent in class AbstractDynamicComponent

Parameters:

aSession - the component uses this object to access other components

aOptions - configuration values for the component. All parameters will be stored as attributes of this component. All attributes existing before this method is called will be removed!

Throws:

AS2Exception - If an error occurs while initializing the component

AS2InvalidParameterException - If a required parameter is null in the parameters Map

See Also:

• IAS2Session

getKeyStore

@Nonnull
public KeyStore getKeyStore()

Specified by:

getKeyStore in interface IKeyStoreCertificateFactory

Returns:

The key store this certificate factory deals with. May not be null.

setKeyStore

protected final void setKeyStore(@Nonnull
 KeyStore aKeyStore)

Internal method to set the KeyStore used internally.

Parameters:

aKeyStore - The key store to use. May not be null.

initEmptyKeyStore

protected void initEmptyKeyStore()
                          throws AS2Exception

This method is responsible to create a new empty keystore based on the configured type.

Throws:

AS2Exception - In case of error

See Also:

• getKeyStoreType()
• createNewKeyStore(EKeyStoreType)
• setKeyStore(KeyStore)

getUnifiedAlias

@Nullable
@OverrideOnDemand
protected String getUnifiedAlias(@Nullable
 String sAlias)

Overridable method to perform unifications on aliases, e.g. for lower casing when using Oracle JDKs PKCS12 implementation.

Parameters:

sAlias - Source alias. May be null.

Returns:

null if the source was null.

Since:

4.0.2

getAlias

@Nonnull
public String getAlias(@Nonnull
 Partnership aPartnership,
 @Nonnull
 ECertificatePartnershipType ePartnershipType)
                throws AS2Exception

Throws:

AS2Exception

internalGetCertificate

@Nonnull
protected X509Certificate internalGetCertificate(@Nullable
 String sAlias,
 @Nullable
 ECertificatePartnershipType ePartnershipType)
                                          throws AS2Exception

Throws:

AS2Exception

getCertificate

@Nonnull
public X509Certificate getCertificate(@Nullable
 String sAlias)
                               throws AS2Exception

Specified by:

getCertificate in interface IAliasedCertificateFactory

Throws:

AS2Exception

getCertificate

@Nonnull
public X509Certificate getCertificate(@Nonnull
 IBaseMessage aMsg,
 @Nonnull
 ECertificatePartnershipType ePartnershipType)
                               throws AS2Exception

Description copied from interface: ICertificateFactory

Get the certificate of the specified type for the partnership defined in the provided message

Specified by:

getCertificate in interface ICertificateFactory

Parameters:

aMsg - Message to get the partnership from. May not be null.

ePartnershipType - Sender or receiver?

Returns:

Never null-

Throws:

AS2Exception - In case of error

AS2CertificateNotFoundException - If no certificate is present

getCertificates

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsOrderedMap<String,X509Certificate> getCertificates()
                                                                                              throws AS2Exception

Specified by:

getCertificates in interface IAliasedCertificateFactory

Throws:

AS2Exception

onChange

@OverrideOnDemand
protected void onChange()
                 throws AS2Exception

Custom callback method that is invoked if something changes in the key store. By default the changes are written back to disk.

Throws:

AS2Exception - In case saving fails.

getPrivateKey

@Nonnull
public PrivateKey getPrivateKey(@Nullable
 X509Certificate aCert)
                         throws AS2Exception

Specified by:

getPrivateKey in interface ICertificateFactory

Throws:

AS2Exception

addCertificate

public void addCertificate(@Nonnull @Nonempty
 String sAlias,
 @Nonnull
 X509Certificate aCert,
 boolean bOverwrite)
                    throws AS2Exception

Specified by:

addCertificate in interface IAliasedCertificateFactory

Throws:

AS2Exception

addPrivateKey

public void addPrivateKey(@Nonnull @Nonempty
 String sAlias,
 @Nonnull
 Key aKey,
 @Nonnull
 String sPassword)
                   throws AS2Exception

Specified by:

addPrivateKey in interface IAliasedCertificateFactory

Throws:

AS2Exception

clearCertificates

public void clearCertificates()
                       throws AS2Exception

Specified by:

clearCertificates in interface IAliasedCertificateFactory

Throws:

AS2Exception

removeCertificate

public void removeCertificate(@Nonnull
 X509Certificate aCert)
                       throws AS2Exception

Specified by:

removeCertificate in interface IAliasedCertificateFactory

Throws:

AS2Exception

removeCertificate

public void removeCertificate(@Nullable
 String sAlias)
                       throws AS2Exception

Specified by:

removeCertificate in interface IAliasedCertificateFactory

Throws:

AS2Exception

load

public void load(@Nonnull @WillClose
 InputStream aIS,
 @Nonnull
 char[] aPassword)
          throws AS2Exception

Throws:

AS2Exception

save

public void save(@Nonnull @WillClose
 OutputStream aOS,
 @Nonnull
 char[] aPassword)
          throws AS2Exception

Throws:

AS2Exception

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractDynamicComponent

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDynamicComponent