com.helger.phase4.crypto

Class AS4CryptParams

java.lang.Object

com.helger.phase4.crypto.AS4CryptParams

All Implemented Interfaces:

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

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

AS4 encrypt/decrypt parameters

Since:

0.9.0

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DIGEST_ALGORITHM
static String	DEFAULT_KEY_ENC_ALGORITHM
static String	DEFAULT_MGF_ALGORITHM

Constructor Summary

Constructors

Constructor and Description
AS4CryptParams()

Method Summary

Modifier and Type	Method and Description
static AS4CryptParams	createDefault()
ECryptoAlgorithmCrypt	getAlgorithmCrypt()
String	getAlias()
X509Certificate	getCertificate()
AS4CryptParams	getClone()
String	getDigestAlgorithm()
String	getKeyEncAlgorithm()
String	getMGFAlgorithm()
boolean	hasAlias()
boolean	hasCertificate()
boolean	isCryptEnabled(Consumer<String> aWarningConsumer)
AS4CryptParams	setAlgorithmCrypt(ECryptoAlgorithmCrypt eAlgorithmCrypt) A encryption algorithm can be set.
AS4CryptParams	setAlias(String sAlias)
AS4CryptParams	setCertificate(X509Certificate aCert)
AS4CryptParams	setDigestAlgorithm(String sDigestAlgorithm)
AS4CryptParams	setFromPMode(PModeLegSecurity aSecurity)
AS4CryptParams	setKeyEncAlgorithm(String sKeyEncAlgorithm)
AS4CryptParams	setMGFAlgorithm(String sMGFAlgorithm)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_KEY_ENC_ALGORITHM

public static final String DEFAULT_KEY_ENC_ALGORITHM

See Also:

Constant Field Values

DEFAULT_MGF_ALGORITHM

public static final String DEFAULT_MGF_ALGORITHM

See Also:

Constant Field Values

DEFAULT_DIGEST_ALGORITHM

public static final String DEFAULT_DIGEST_ALGORITHM

See Also:

Constant Field Values

Constructor Detail

AS4CryptParams

public AS4CryptParams()

Method Detail

isCryptEnabled

public boolean isCryptEnabled(@Nullable
                              Consumer<String> aWarningConsumer)

getAlgorithmCrypt

@Nullable
public final ECryptoAlgorithmCrypt getAlgorithmCrypt()

Returns:

The encryption algorithm to use. May be null.

setAlgorithmCrypt

@Nonnull
public final AS4CryptParams setAlgorithmCrypt(@Nullable
                                                        ECryptoAlgorithmCrypt eAlgorithmCrypt)

A encryption algorithm can be set.
MANDATORY if you want to use encryption.

Parameters:

eAlgorithmCrypt - the encryption algorithm that should be set

Returns:

this for chaining

getKeyEncAlgorithm

@Nonnull
 @Nonempty
public final String getKeyEncAlgorithm()

setKeyEncAlgorithm

@Nonnull
public final AS4CryptParams setKeyEncAlgorithm(@Nonnull @Nonempty
                                                         String sKeyEncAlgorithm)

getMGFAlgorithm

@Nonnull
 @Nonempty
public final String getMGFAlgorithm()

Returns:

the MGF algorithm to use with the RSA-OAEP key transport algorithm. The default is DEFAULT_MGF_ALGORITHM

setMGFAlgorithm

@Nonnull
public final AS4CryptParams setMGFAlgorithm(@Nonnull @Nonempty
                                                      String sMGFAlgorithm)

getDigestAlgorithm

@Nonnull
 @Nonempty
public final String getDigestAlgorithm()

Returns:

the digest algorithm to use with the RSA-OAEP key transport algorithm. The default is DEFAULT_DIGEST_ALGORITHM

setDigestAlgorithm

@Nonnull
public final AS4CryptParams setDigestAlgorithm(@Nonnull @Nonempty
                                                         String sDigestAlgorithm)

getCertificate

@Nullable
public final X509Certificate getCertificate()

hasCertificate

public final boolean hasCertificate()

setCertificate

@Nonnull
public final AS4CryptParams setCertificate(@Nullable
                                                     X509Certificate aCert)

getAlias

@Nullable
public final String getAlias()

hasAlias

public final boolean hasAlias()

setAlias

@Nonnull
public final AS4CryptParams setAlias(@Nullable
                                               String sAlias)

setFromPMode

@Nonnull
public final AS4CryptParams setFromPMode(@Nullable
                                                   PModeLegSecurity aSecurity)

getClone

@Nonnull
 @ReturnsMutableCopy
public AS4CryptParams getClone()

Specified by:

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

toString

public String toString()

Overrides:

toString in class Object

createDefault

@Nonnull
 @ReturnsMutableObject
public static AS4CryptParams createDefault()