com.helger.phase4.crypto

Class AS4CryptoFactoryPropertiesFile

java.lang.Object

com.helger.phase4.crypto.AS4CryptoFactoryPropertiesFile

All Implemented Interfaces:

IAS4CryptoFactory

@Immutable
public class AS4CryptoFactoryPropertiesFile
extends Object
implements IAS4CryptoFactory

The phase4 crypto settings. By default the properties are read from the files "private-crypto.properties" or "crypto.properties". Alternatively the properties can be provided in the code. See AS4CryptoProperties for the list of supported property names.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AS4CryptoFactoryPropertiesFile(AS4CryptoProperties aCryptoProps) This constructor takes the crypto properties directly.
AS4CryptoFactoryPropertiesFile(String sCryptoPropertiesPath) Should be used if you want to use a non-default crypto properties to create your Crypto-Instance.

Method Summary

Modifier and Type	Method and Description
static org.apache.wss4j.common.crypto.Crypto	createCrypto(AS4CryptoProperties aCryptoProps)
AS4CryptoProperties	cryptoProperties()
X509Certificate	getCertificate()
org.apache.wss4j.common.crypto.Crypto	getCrypto() Lazily create a Crypto instance using the properties from cryptoProperties().
static AS4CryptoFactoryPropertiesFile	getDefaultInstance()
String	getKeyAlias()
String	getKeyPassword()
KeyStore	getKeyStore()
KeyStore.PrivateKeyEntry	getPrivateKeyEntry()
static AS4CryptoProperties	readCryptoPropertiesFromFile(String sCryptoPropertiesPath) Read crypto properties from the specified file path.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.phase4.crypto.IAS4CryptoFactory

createWSSConfig

Constructor Detail

AS4CryptoFactoryPropertiesFile

public AS4CryptoFactoryPropertiesFile(@Nullable
                                      String sCryptoPropertiesPath)

Should be used if you want to use a non-default crypto properties to create your Crypto-Instance. This constructor reads the properties from a file.

Parameters:

sCryptoPropertiesPath - when this parameter is null, the default values will get used. Else it will try to invoke the given properties and read them throws an exception if it does not work.

Throws:

com.helger.commons.exception.InitializationException - If the file could not be loaded

AS4CryptoFactoryPropertiesFile

public AS4CryptoFactoryPropertiesFile(@Nonnull
                                      AS4CryptoProperties aCryptoProps)

This constructor takes the crypto properties directly. See the AbstractAS4Client for a usage example.

Parameters:

aCryptoProps - The properties to be used. May not be null. Note: the object is cloned internally to avoid outside modification.

Method Detail

getDefaultInstance

@Nullable
public static AS4CryptoFactoryPropertiesFile getDefaultInstance()

Returns:

The default instance, created by reading the default "crypto.properties" file. If this file is not present, than this method returns null.

readCryptoPropertiesFromFile

@Nonnull
public static AS4CryptoProperties readCryptoPropertiesFromFile(@Nullable
                                                                         String sCryptoPropertiesPath)

Read crypto properties from the specified file path.

Parameters:

sCryptoPropertiesPath - The class path to read the properties file from. It is null or empty, than the default file "crypto.properties" is read.

Returns:

Never null.

cryptoProperties

@Nonnull
 @ReturnsMutableObject
public final AS4CryptoProperties cryptoProperties()

Returns:

The crypto properties as created in the constructor. Never null.

createCrypto

@Nonnull
public static org.apache.wss4j.common.crypto.Crypto createCrypto(@Nonnull
                                                                           AS4CryptoProperties aCryptoProps)

getCrypto

@Nonnull
public final org.apache.wss4j.common.crypto.Crypto getCrypto()

Lazily create a Crypto instance using the properties from cryptoProperties().

Specified by:

getCrypto in interface IAS4CryptoFactory

Returns:

A Crypto instance and never null.

getKeyStore

@Nullable
public final KeyStore getKeyStore()

Specified by:

getKeyStore in interface IAS4CryptoFactory

Returns:

The underlying key store, or null if none is available (the reasons depend on the used implementation).

getPrivateKeyEntry

@Nullable
public final KeyStore.PrivateKeyEntry getPrivateKeyEntry()

Specified by:

getPrivateKeyEntry in interface IAS4CryptoFactory

Returns:

The underlying private key entry from the keystore or null if none is available (the reasons depend on the used implementation).

getKeyAlias

@Nullable
public final String getKeyAlias()

Specified by:

getKeyAlias in interface IAS4CryptoFactory

Returns:

The keystore alias to resolve the private key entry. May be null.

getKeyPassword

@Nullable
public final String getKeyPassword()

Specified by:

getKeyPassword in interface IAS4CryptoFactory

Returns:

The password to access the private key entry denoted by the key alias. May be null.

getCertificate

@Nullable
public final X509Certificate getCertificate()

Returns:

The public certificate of the private key entry or null if the private key entry could not be loaded.

See Also:

getPrivateKeyEntry()