com.helger.as2lib.cert

Class CertificateFactory

java.lang.Object

com.helger.as2lib.AbstractDynamicComponent

com.helger.as2lib.cert.AbstractCertificateFactory

com.helger.as2lib.cert.CertificateFactory

All Implemented Interfaces:

IAliasedCertificateFactory, ICertificateFactory, IKeyStoreCertificateFactory, IStorableCertificateFactory, IDynamicComponent, Serializable

Direct Known Subclasses:

PKCS12CertificateFactory

public class CertificateFactory
extends AbstractCertificateFactory
implements IAliasedCertificateFactory, IKeyStoreCertificateFactory, IStorableCertificateFactory

An implementation of a file-based certificate factory using a custom key store type.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

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

Fields inherited from class com.helger.as2lib.AbstractDynamicComponent

m_aRWLock

Fields inherited from interface com.helger.as2lib.cert.IStorableCertificateFactory

DEFAULT_SAVE_CHANGES_TO_FILE

Constructor Summary

Constructors

Constructor and Description
CertificateFactory()

Method Summary

Modifier and Type	Method and 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)
boolean	equals(Object o)
String	getAlias(Partnership aPartnership, ECertificatePartnershipType ePartnershipType)
X509Certificate	getCertificate(String sAlias)
com.helger.commons.collection.impl.ICommonsOrderedMap<String,Certificate>	getCertificates()
String	getFilename()
KeyStore	getKeyStore()
char[]	getPassword()
PrivateKey	getPrivateKey(IMessageMDN aMDN, X509Certificate aCert)
PrivateKey	getPrivateKey(IMessage aMsg, X509Certificate aCert)
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 X509Certificate	internalGetCertificate(String sAlias, ECertificatePartnershipType ePartnershipType)
boolean	isSaveChangesToFile()
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)
void	setFilename(String sFilename)
void	setPassword(char[] aPassword)
void	setSaveChangesToFile(boolean bSaveChangesToFile) Change the behavior if all changes should trigger a saving to the original file.

Methods inherited from class com.helger.as2lib.cert.AbstractCertificateFactory

getCertificate, getCertificate, getCertificateOrNull, getCertificateOrNull

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.IStorableCertificateFactory

load, load, save, save

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

getCertificate, getCertificate, getCertificateOrNull, getCertificateOrNull

Methods inherited from interface com.helger.as2lib.IDynamicComponent

attrs, getName, getSession

Field Detail

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_FILENAME

public static final String ATTR_FILENAME

See Also:

Constant Field Values

ATTR_PASSWORD

public static final String ATTR_PASSWORD

See Also:

Constant Field Values

ATTR_SAVE_CHANGES_TO_FILE

public static final String ATTR_SAVE_CHANGES_TO_FILE

See Also:

Constant Field Values

Constructor Detail

CertificateFactory

public CertificateFactory()

Method Detail

createNewKeyStore

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

Throws:

Exception

initDynamicComponent

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

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:

OpenAS2Exception - If an error occurs while initializing the component

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

See Also:

IAS2Session

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 OpenAS2Exception

Specified by:

getAlias in class AbstractCertificateFactory

Throws:

OpenAS2Exception

internalGetCertificate

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

Specified by:

internalGetCertificate in class AbstractCertificateFactory

Throws:

OpenAS2Exception

getCertificate

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

Specified by:

getCertificate in interface IAliasedCertificateFactory

Throws:

OpenAS2Exception

getCertificates

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

Specified by:

getCertificates in interface IAliasedCertificateFactory

Throws:

OpenAS2Exception

setFilename

public void setFilename(@Nullable
                        String sFilename)

Specified by:

setFilename in interface IStorableCertificateFactory

getFilename

@Nonnull
public String getFilename()
                             throws InvalidParameterException

Specified by:

getFilename in interface IStorableCertificateFactory

Throws:

InvalidParameterException

getKeyStore

@Nonnull
public KeyStore getKeyStore()

Specified by:

getKeyStore in interface IKeyStoreCertificateFactory

setPassword

public void setPassword(@Nonnull
                        char[] aPassword)

Specified by:

setPassword in interface IStorableCertificateFactory

getPassword

@Nonnull
public char[] getPassword()
                             throws InvalidParameterException

Specified by:

getPassword in interface IStorableCertificateFactory

Throws:

InvalidParameterException

setSaveChangesToFile

public void setSaveChangesToFile(boolean bSaveChangesToFile)

Description copied from interface: IStorableCertificateFactory

Change the behavior if all changes should trigger a saving to the original file. The default value is IStorableCertificateFactory.DEFAULT_SAVE_CHANGES_TO_FILE.

Specified by:

setSaveChangesToFile in interface IStorableCertificateFactory

Parameters:

bSaveChangesToFile - true to enable auto-saving, false to disable it.

isSaveChangesToFile

public boolean isSaveChangesToFile()

Specified by:

isSaveChangesToFile in interface IStorableCertificateFactory

Returns:

true if changes to the key store should be persisted back to the original file, false if not. The default value is IStorableCertificateFactory.DEFAULT_SAVE_CHANGES_TO_FILE.

onChange

@OverrideOnDemand
protected void onChange()
                                    throws OpenAS2Exception

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

Throws:

OpenAS2Exception - In case saving fails.

See Also:

isSaveChangesToFile(), setSaveChangesToFile(boolean)

getPrivateKey

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

Throws:

OpenAS2Exception

getPrivateKey

@Nonnull
public PrivateKey getPrivateKey(@Nullable
                                          IMessage aMsg,
                                          @Nullable
                                          X509Certificate aCert)
                                   throws OpenAS2Exception

Specified by:

getPrivateKey in interface ICertificateFactory

Throws:

OpenAS2Exception

getPrivateKey

@Nonnull
public PrivateKey getPrivateKey(@Nullable
                                          IMessageMDN aMDN,
                                          @Nullable
                                          X509Certificate aCert)
                                   throws OpenAS2Exception

Specified by:

getPrivateKey in interface ICertificateFactory

Throws:

OpenAS2Exception

addCertificate

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

Specified by:

addCertificate in interface IAliasedCertificateFactory

Throws:

OpenAS2Exception

addPrivateKey

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

Specified by:

addPrivateKey in interface IAliasedCertificateFactory

Throws:

OpenAS2Exception

clearCertificates

public void clearCertificates()
                       throws OpenAS2Exception

Specified by:

clearCertificates in interface IAliasedCertificateFactory

Throws:

OpenAS2Exception

load

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

Specified by:

load in interface IStorableCertificateFactory

Throws:

OpenAS2Exception

removeCertificate

public void removeCertificate(@Nonnull
                              X509Certificate aCert)
                       throws OpenAS2Exception

Specified by:

removeCertificate in interface IAliasedCertificateFactory

Throws:

OpenAS2Exception

removeCertificate

public void removeCertificate(@Nullable
                              String sAlias)
                       throws OpenAS2Exception

Specified by:

removeCertificate in interface IAliasedCertificateFactory

Throws:

OpenAS2Exception

save

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

Specified by:

save in interface IStorableCertificateFactory

Throws:

OpenAS2Exception

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractDynamicComponent

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDynamicComponent