com.helger.phase4.crypto

Class AS4CryptoProperties

java.lang.Object

com.helger.phase4.crypto.AS4CryptoProperties

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<AS4CryptoProperties>, Serializable

@Immutable
public class AS4CryptoProperties
extends Object
implements Serializable, com.helger.commons.lang.ICloneable<AS4CryptoProperties>

Wrapper around the crypto properties file.

Author:

bayerlma, Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CRYPTO_PROVIDER The class name implementing the CryptoProvider - default value is "org.apache.wss4j.common.crypto.Merlin"
static String	KEY_ALIAS Keystore key alias
static String	KEY_PASSWORD Keystore key password
static String	KEYSTORE_FILE Keystore filename/path
static String	KEYSTORE_PASSWORD Keystore password
static String	KEYSTORE_TYPE Keystore type: JKS or PKCS12
static String	LOAD_CACERTS Type boolean
static String	TRUSTSTORE_FILE Truststore filename/path
static String	TRUSTSTORE_PASSWORD Truststore password
static String	TRUSTSTORE_PROVIDER Truststore provider - must usually not be set
static String	TRUSTSTORE_TYPE Truststore type - JKS or PKCS12?

Constructor Summary

Constructors

Constructor and Description
AS4CryptoProperties() Default constructor having only the crypto provider property set to default.
AS4CryptoProperties(com.helger.commons.io.resource.IReadableResource aRes) Constructor reading the properties from a resource using the Properties file syntax

Method Summary

Modifier and Type	Method and Description
Properties	getAsProperties()
AS4CryptoProperties	getClone()
String	getCryptoProvider()
String	getKeyAlias()
String	getKeyPassword()
String	getKeyStorePassword()
String	getKeyStorePath()
com.helger.security.keystore.EKeyStoreType	getKeyStoreType()
com.helger.commons.state.ETriState	getLoadCACerts()
String	getTrustStorePassword()
String	getTrustStorePath()
String	getTrustStoreProvider()
com.helger.security.keystore.EKeyStoreType	getTrustStoreType()
boolean	isRead()
AS4CryptoProperties	setCryptoProvider(String sCryptoProvider)
AS4CryptoProperties	setCryptoProviderDefault()
AS4CryptoProperties	setKeyAlias(String sKeyAlias)
AS4CryptoProperties	setKeyPassword(String sKeyPassword)
AS4CryptoProperties	setKeyStorePassword(String sKeyStorePassword)
AS4CryptoProperties	setKeyStorePath(String sKeyStorePath)
AS4CryptoProperties	setKeyStoreType(com.helger.security.keystore.EKeyStoreType eType)
AS4CryptoProperties	setLoadCACerts(boolean bLoadCACerts)
AS4CryptoProperties	setTrustStorePassword(String sTrustStorePassword)
AS4CryptoProperties	setTrustStorePath(String sTrustStorePath)
AS4CryptoProperties	setTrustStoreProvider(String sTrustStoreProvider)
AS4CryptoProperties	setTrustStoreType(com.helger.security.keystore.EKeyStoreType eType)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CRYPTO_PROVIDER

public static final String CRYPTO_PROVIDER

The class name implementing the CryptoProvider - default value is "org.apache.wss4j.common.crypto.Merlin"

See Also:

Constant Field Values

KEYSTORE_TYPE

public static final String KEYSTORE_TYPE

Keystore type: JKS or PKCS12

See Also:

Constant Field Values

KEYSTORE_FILE

public static final String KEYSTORE_FILE

Keystore filename/path

See Also:

Constant Field Values

KEYSTORE_PASSWORD

public static final String KEYSTORE_PASSWORD

Keystore password

See Also:

Constant Field Values

KEY_ALIAS

public static final String KEY_ALIAS

Keystore key alias

See Also:

Constant Field Values

KEY_PASSWORD

public static final String KEY_PASSWORD

Keystore key password

See Also:

Constant Field Values

LOAD_CACERTS

public static final String LOAD_CACERTS

Type boolean

See Also:

Constant Field Values

TRUSTSTORE_PROVIDER

public static final String TRUSTSTORE_PROVIDER

Truststore provider - must usually not be set

See Also:

Constant Field Values

TRUSTSTORE_TYPE

public static final String TRUSTSTORE_TYPE

Truststore type - JKS or PKCS12?

See Also:

Constant Field Values

TRUSTSTORE_FILE

public static final String TRUSTSTORE_FILE

Truststore filename/path

See Also:

Constant Field Values

TRUSTSTORE_PASSWORD

public static final String TRUSTSTORE_PASSWORD

Truststore password

See Also:

Constant Field Values

Constructor Detail

AS4CryptoProperties

public AS4CryptoProperties()

Default constructor having only the crypto provider property set to default.

AS4CryptoProperties

public AS4CryptoProperties(@Nonnull
                           com.helger.commons.io.resource.IReadableResource aRes)

Constructor reading the properties from a resource using the Properties file syntax

Parameters:

aRes - The resource to read. May not be null.

Method Detail

isRead

public final boolean isRead()

Returns:

true if properties are available. This is always true when a map was used to initialize it. Only if a resource was used, this may become false.

getAsProperties

@Nullable
public Properties getAsProperties()

Returns:

A representation of the contained properties as Properties. May be null.

getCryptoProvider

@Nullable
public String getCryptoProvider()

setCryptoProvider

@Nonnull
public final AS4CryptoProperties setCryptoProvider(@Nullable
                                                             String sCryptoProvider)

setCryptoProviderDefault

@Nonnull
public final AS4CryptoProperties setCryptoProviderDefault()

getKeyStoreType

@Nullable
public com.helger.security.keystore.EKeyStoreType getKeyStoreType()

setKeyStoreType

@Nonnull
public final AS4CryptoProperties setKeyStoreType(@Nullable
                                                           com.helger.security.keystore.EKeyStoreType eType)

getKeyStorePath

@Nullable
public String getKeyStorePath()

setKeyStorePath

@Nonnull
public final AS4CryptoProperties setKeyStorePath(@Nullable
                                                           String sKeyStorePath)

getKeyStorePassword

@Nullable
public String getKeyStorePassword()

setKeyStorePassword

@Nonnull
public final AS4CryptoProperties setKeyStorePassword(@Nullable
                                                               String sKeyStorePassword)

getKeyAlias

@Nullable
public String getKeyAlias()

setKeyAlias

@Nonnull
public final AS4CryptoProperties setKeyAlias(@Nullable
                                                       String sKeyAlias)

getKeyPassword

@Nullable
public String getKeyPassword()

setKeyPassword

@Nonnull
public final AS4CryptoProperties setKeyPassword(@Nullable
                                                          String sKeyPassword)

getLoadCACerts

@Nonnull
public com.helger.commons.state.ETriState getLoadCACerts()

setLoadCACerts

@Nonnull
public final AS4CryptoProperties setLoadCACerts(boolean bLoadCACerts)

getTrustStoreProvider

@Nullable
public String getTrustStoreProvider()

setTrustStoreProvider

@Nonnull
public final AS4CryptoProperties setTrustStoreProvider(@Nullable
                                                                 String sTrustStoreProvider)

getTrustStoreType

@Nullable
public com.helger.security.keystore.EKeyStoreType getTrustStoreType()

setTrustStoreType

@Nonnull
public final AS4CryptoProperties setTrustStoreType(@Nullable
                                                             com.helger.security.keystore.EKeyStoreType eType)

getTrustStorePath

@Nullable
public String getTrustStorePath()

setTrustStorePath

@Nonnull
public final AS4CryptoProperties setTrustStorePath(@Nullable
                                                             String sTrustStorePath)

getTrustStorePassword

@Nullable
public String getTrustStorePassword()

setTrustStorePassword

@Nonnull
public final AS4CryptoProperties setTrustStorePassword(@Nullable
                                                                 String sTrustStorePassword)

getClone

@Nonnull
 @ReturnsMutableCopy
public AS4CryptoProperties getClone()

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<AS4CryptoProperties>

toString

public String toString()

Overrides:

toString in class Object