AS2ClientSettings (as2-lib 4.3.0 API)

java.lang.Object
- com.helger.as2lib.client.AS2ClientSettings

All Implemented Interfaces:

Serializable
```
public class AS2ClientSettings
extends Object
implements Serializable
```
Settings object for a message delivery.

Author:

oleo Date: May 12, 2010 Time: 5:16:57 PM, Philip Helger

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_COMPRESS_BEFORE_SIGNING` If compression and signing are enabled, compression happens before singing
`static int`	`DEFAULT_CONNECT_TIMEOUT_MS` Default connection timeout: 60 seconds
`static boolean`	`DEFAULT_IS_MDN_REQUESTED` By default an MDN is requested.
`static boolean`	`DEFAULT_LARGE_FILE_SUPPORT_ENABLED`
`static String`	`DEFAULT_MDN_OPTIONS` The default MDN options to be used.
`static String`	`DEFAULT_MESSAGE_ID_FORMAT` The default message ID format to use.
`static int`	`DEFAULT_READ_TIMEOUT_MS` Default read timeout: 60 seconds
`static int`	`DEFAULT_RETRY_COUNT` By default no retry happens.

Constructor Summary

Constructors
Constructor and Description

AS2ClientSettings()

Constructors
Constructor and Description
`AS2ClientSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.helger.commons.http.HttpHeaderMap`	`customHeaders()`
`String`	`getAsyncMDNUrl()`
`ECompressionType`	`getCompressionType()`
`int`	`getConnectTimeoutMS()`
`ECryptoAlgorithmCrypt`	`getCryptAlgo()`
`String`	`getCryptAlgoID()`
`String`	`getDestinationAS2URL()`
`File`	`getKeyStoreFile()`
`String`	`getKeyStorePassword()`
`com.helger.security.keystore.IKeyStoreType`	`getKeyStoreType()`
`String`	`getMDNOptions()` Get the current MDN options.
`String`	`getMessageIDFormat()`
`String`	`getPartnershipName()`
`int`	`getReadTimeoutMS()`
`String`	`getReceiverAS2ID()`
`X509Certificate`	`getReceiverCertificate()`
`String`	`getReceiverKeyAlias()`
`int`	`getRetryCount()`
`String`	`getSenderAS2ID()`
`String`	`getSenderEmailAddress()`
`String`	`getSenderKeyAlias()`
`ECryptoAlgorithmSign`	`getSignAlgo()`
`String`	`getSignAlgoID()`
`boolean`	`hasMDNOptions()`
`boolean`	`isAsyncMDNRequested()`
`boolean`	`isCompressBeforeSigning()` Check if compress before sign or sign before compress is used.
`boolean`	`isLargeFileSupport()`
`boolean`	`isMDNRequested()`
`boolean`	`isSaveKeyStoreChangesToFile()`
`AS2ClientSettings`	`setAsyncMDNUrl(String sAsyncMDNUrl)` Set the asynchronous MDN URL to be used.
`AS2ClientSettings`	`setCompress(ECompressionType eCompressionType, boolean bCompressBeforeSigning)` Enable or disable the compression of the message.
`AS2ClientSettings`	`setConnectTimeoutMS(int nConnectTimeoutMS)` Set the connection timeout in milliseconds.
`AS2ClientSettings`	`setEncryptAndSign(ECryptoAlgorithmCrypt eCryptAlgo, ECryptoAlgorithmSign eSignAlgo)` Set the encryption and signing algorithms to use.
`AS2ClientSettings`	`setKeyStore(com.helger.security.keystore.IKeyStoreType aKeyStoreType, File aFile, String sPassword)` Set the details of the certificate store of the client.
`AS2ClientSettings`	`setLargeFileSupport(boolean bLargeFileSupport)`
`AS2ClientSettings`	`setMDNOptions(DispositionOptions aDispositionOptions)` Set the MDN options to be used.
`AS2ClientSettings`	`setMDNOptions(String sMDNOptions)` Set the MDN options to be used.
`AS2ClientSettings`	`setMDNRequested(boolean bMDNRequested)` Determine if an MDN is requested at all.
`AS2ClientSettings`	`setMessageIDFormat(String sMessageIDFormat)` Set the Message ID format.
`AS2ClientSettings`	`setPartnershipName(String sPartnershipName)` Set the name of the partnership for lookup and dynamic creation.
`AS2ClientSettings`	`setReadTimeoutMS(int nReadTimeoutMS)` Set the read timeout in milliseconds.
`AS2ClientSettings`	`setReceiverCertificate(X509Certificate aReceiverCertificate)` Explicitly set the receiver certificate to be used.
`AS2ClientSettings`	`setReceiverData(String sAS2ID, String sKeyAlias, String sAS2URL)` Set the receiver data.
`AS2ClientSettings`	`setRetryCount(int nRetryCount)` Set the retry count for sending,
`AS2ClientSettings`	`setSaveKeyStoreChangesToFile(boolean bSaveKeyStoreChangesToFile)` Change the behavior if all changes to the keystore should trigger a saving to the original file.
`AS2ClientSettings`	`setSenderData(String sAS2ID, String sEmailAddress, String sKeyAlias)` Set the sender data.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_COMPRESS_BEFORE_SIGNING
```
public static final boolean DEFAULT_COMPRESS_BEFORE_SIGNING
```
    If compression and signing are enabled, compression happens before singing
    
    See Also:
    
    Constant Field Values
  - DEFAULT_IS_MDN_REQUESTED
```
public static final boolean DEFAULT_IS_MDN_REQUESTED
```
    By default an MDN is requested.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MDN_OPTIONS
```
public static final String DEFAULT_MDN_OPTIONS
```
    The default MDN options to be used.
    
    See Also:
    
    setMDNOptions(DispositionOptions)
  - DEFAULT_MESSAGE_ID_FORMAT
```
public static final String DEFAULT_MESSAGE_ID_FORMAT
```
    The default message ID format to use.
    
    See Also:
    
    setMessageIDFormat(String), Constant Field Values
  - DEFAULT_RETRY_COUNT
```
public static final int DEFAULT_RETRY_COUNT
```
    By default no retry happens.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CONNECT_TIMEOUT_MS
```
public static final int DEFAULT_CONNECT_TIMEOUT_MS
```
    Default connection timeout: 60 seconds
    
    See Also:
    
    Constant Field Values
  - DEFAULT_READ_TIMEOUT_MS
```
public static final int DEFAULT_READ_TIMEOUT_MS
```
    Default read timeout: 60 seconds
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LARGE_FILE_SUPPORT_ENABLED
```
public static final boolean DEFAULT_LARGE_FILE_SUPPORT_ENABLED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AS2ClientSettings
```
public AS2ClientSettings()
```
- Method Detail
  - setKeyStore
```
@Nonnull
public AS2ClientSettings setKeyStore(@Nonnull
                                               com.helger.security.keystore.IKeyStoreType aKeyStoreType,
                                               @Nonnull
                                               File aFile,
                                               @Nonnull
                                               String sPassword)
```
    Set the details of the certificate store of the client.
    
    Parameters:
    
    aKeyStoreType - Key store type. May not be null.
    
    aFile - The key store file. May not be null.
    
    sPassword - The password used to open the key store. May not be null.
    
    Returns:
    
    this for chaining
  - getKeyStoreType
```
@Nonnull
public com.helger.security.keystore.IKeyStoreType getKeyStoreType()
```
    Returns:
    
    The key store type. May not be null.
    
    See Also:
    
    setKeyStore(IKeyStoreType, File, String)
  - getKeyStoreFile
```
@Nullable
public File getKeyStoreFile()
```
    Returns:
    
    The key store file. May be null if not yet set.
    
    See Also:
    
    setKeyStore(IKeyStoreType, File, String)
  - getKeyStorePassword
```
@Nullable
public String getKeyStorePassword()
```
    Returns:
    
    The key store password. May be null if not yet set.
    
    See Also:
    
    setKeyStore(IKeyStoreType, File, String)
  - setSaveKeyStoreChangesToFile
```
@Nonnull
public AS2ClientSettings setSaveKeyStoreChangesToFile(boolean bSaveKeyStoreChangesToFile)
```
    Change the behavior if all changes to the keystore should trigger a saving to the original file.
    
    Parameters:
    
    bSaveKeyStoreChangesToFile - true if key store changes should be written back to the file, false if not.
    
    Returns:
    
    this for chaining
  - isSaveKeyStoreChangesToFile
```
public boolean isSaveKeyStoreChangesToFile()
```
    Returns:
    
    true if key store changes should be written back to the file, false if not.
  - setSenderData
```
@Nonnull
public AS2ClientSettings setSenderData(@Nonnull
                                                 String sAS2ID,
                                                 @Nonnull
                                                 String sEmailAddress,
                                                 @Nonnull
                                                 String sKeyAlias)
```
    Set the sender data.
    
    Parameters:
    
    sAS2ID - Sender AS2 ID. May not be null.
    
    sEmailAddress - Sender email address. May not be null.
    
    sKeyAlias - Alias into the keystore for identifying the sender's key. May not be null.
    
    Returns:
    
    this for chaining
  - getSenderAS2ID
```
@Nullable
public String getSenderAS2ID()
```
    Returns:
    
    The sender AS2 ID. May be null if not set.
    
    See Also:
    
    setSenderData(String, String, String)
  - getSenderEmailAddress
```
@Nullable
public String getSenderEmailAddress()
```
    Returns:
    
    The sender's email address. May be null if not set.
    
    See Also:
    
    setSenderData(String, String, String)
  - getSenderKeyAlias
```
@Nullable
public String getSenderKeyAlias()
```
    Returns:
    
    The senders key alias in the keystore. May be null if not set.
    
    See Also:
    
    setSenderData(String, String, String), setKeyStore(IKeyStoreType, File, String)
  - setReceiverData
```
@Nonnull
public AS2ClientSettings setReceiverData(@Nonnull
                                                   String sAS2ID,
                                                   @Nonnull
                                                   String sKeyAlias,
                                                   @Nonnull
                                                   String sAS2URL)
```
    Set the receiver data.
    
    Parameters:
    
    sAS2ID - Receiver AS2 ID. May not be null.
    
    sKeyAlias - Alias into the keystore for identifying the receivers certificate. May not be null.
    
    sAS2URL - Destination URL to send the request to. May not be null .
    
    Returns:
    
    this for chaining
  - getReceiverAS2ID
```
@Nullable
public String getReceiverAS2ID()
```
    Returns:
    
    The receiver AS2 ID. May be null if not set.
    
    See Also:
    
    setReceiverData(String, String, String)
  - getReceiverKeyAlias
```
@Nullable
public String getReceiverKeyAlias()
```
    Returns:
    
    The receivers key alias in the keystore. May be null if not set.
    
    See Also:
    
    setReceiverData(String, String, String), setKeyStore(IKeyStoreType, File, String)
  - getDestinationAS2URL
```
@Nullable
public String getDestinationAS2URL()
```
    Returns:
    
    The destination URL to send the request to. May be null if not set.
    
    See Also:
    
    setReceiverData(String, String, String)
  - setReceiverCertificate
```
@Nonnull
public AS2ClientSettings setReceiverCertificate(@Nullable
                                                          X509Certificate aReceiverCertificate)
```
    Explicitly set the receiver certificate to be used. This might be used to dynamically add it to the certificate factory for dynamic partnership handling (like in PEPPOL).
    
    Parameters:
    
    aReceiverCertificate - The receiver certificate. May be null.
    
    Returns:
    
    this for chaining
  - getReceiverCertificate
```
@Nullable
public X509Certificate getReceiverCertificate()
```
    Returns:
    
    The explicit certificate of the recipient. This might be used to dynamically add it to the certificate factory for dynamic partnership handling (like in PEPPOL). May be null.
    
    See Also:
    
    setReceiverCertificate(X509Certificate)
  - setEncryptAndSign
```
@Nonnull
public AS2ClientSettings setEncryptAndSign(@Nullable
                                                     ECryptoAlgorithmCrypt eCryptAlgo,
                                                     @Nullable
                                                     ECryptoAlgorithmSign eSignAlgo)
```
    Set the encryption and signing algorithms to use.
    
    Parameters:
    
    eCryptAlgo - The encryption algorithm. May be null to indicate that the message should not be encrypted.
    
    eSignAlgo - The signing algorithm. May be null to indicate that the message should not be signed.
    
    Returns:
    
    this for chaining.
  - getCryptAlgo
```
@Nullable
public ECryptoAlgorithmCrypt getCryptAlgo()
```
    Returns:
    
    The algorithm used to encrypt the message. May be null if not set.
    
    See Also:
    
    setEncryptAndSign(ECryptoAlgorithmCrypt, ECryptoAlgorithmSign)
  - getCryptAlgoID
```
@Nullable
public String getCryptAlgoID()
```
    Returns:
    
    The ID of the algorithm used to encrypt the message. May be null if not set.
    
    See Also:
    
    setEncryptAndSign(ECryptoAlgorithmCrypt, ECryptoAlgorithmSign)
  - getSignAlgo
```
@Nullable
public ECryptoAlgorithmSign getSignAlgo()
```
    Returns:
    
    The algorithm used to sign the message. May be null if not set.
    
    See Also:
    
    setEncryptAndSign(ECryptoAlgorithmCrypt, ECryptoAlgorithmSign)
  - getSignAlgoID
```
@Nullable
public String getSignAlgoID()
```
    Returns:
    
    The ID of the algorithm used to sign the message. May be null if not set.
    
    See Also:
    
    setEncryptAndSign(ECryptoAlgorithmCrypt, ECryptoAlgorithmSign)
  - setCompress
```
@Nonnull
public AS2ClientSettings setCompress(@Nullable
                                               ECompressionType eCompressionType,
                                               boolean bCompressBeforeSigning)
```
    Enable or disable the compression of the message. Note: compression requires the receiver to support AS2 version 1.1!
    
    Parameters:
    
    eCompressionType - The compression type to use. Pass null to not compress the message (that is also the default).
    
    bCompressBeforeSigning - true to compress the data before it is signed, false to sign first and than compress the message. The default is true.
    
    Returns:
    
    this for chaining
  - getCompressionType
```
@Nullable
public ECompressionType getCompressionType()
```
    Returns:
    
    The compression type used to compress the message. May be null to indicate no compression.
    
    See Also:
    
    setCompress(ECompressionType, boolean)
  - isCompressBeforeSigning
```
public boolean isCompressBeforeSigning()
```
    Check if compress before sign or sign before compress is used. This flag is only evaluated if getCompressionType() is not null.
    
    Returns:
    
    true to compress before signing, false to sign before compressing
    
    See Also:
    
    setCompress(ECompressionType, boolean)
  - setPartnershipName
```
@Nonnull
public AS2ClientSettings setPartnershipName(@Nonnull
                                                      String sPartnershipName)
```
    Set the name of the partnership for lookup and dynamic creation.
    
    Parameters:
    
    sPartnershipName - The partnership name. May not be null.
    
    Returns:
    
    this for chaining
  - getPartnershipName
```
@Nullable
public String getPartnershipName()
```
    Returns:
    
    The partnership name to be used. May be null if not set.
    
    See Also:
    
    setPartnershipName(String)
  - setMDNRequested
```
@Nonnull
public AS2ClientSettings setMDNRequested(boolean bMDNRequested)
```
    Determine if an MDN is requested at all.
    
    Parameters:
    
    bMDNRequested - true to request an MDN (is the default), false to not request one.
    
    Returns:
    
    this for chaining
    
    Since:
    
    4.2.0
  - isMDNRequested
```
public boolean isMDNRequested()
```
    Returns:
    
    true if an MDN is requested at all (sync or async), false if not.
    
    Since:
    
    4.2.0
  - setMDNOptions
```
@Nonnull
public AS2ClientSettings setMDNOptions(@Nullable
                                                 String sMDNOptions)
```
    Set the MDN options to be used. Since 3.0.4 the MDN options (corresponding to the 'Disposition-Notification-Options' header) may be null.
    
    Parameters:
    
    sMDNOptions - The Disposition-Notification-Options String to be used. May be null.
    
    Returns:
    
    this for chaining
    
    See Also:
    
    setMDNOptions(DispositionOptions)
  - setMDNOptions
```
@Nonnull
public AS2ClientSettings setMDNOptions(@Nonnull
                                                 DispositionOptions aDispositionOptions)
```
    Set the MDN options to be used.
    
    Parameters:
    
    aDispositionOptions - The Disposition-Notification-Options structured object to be used. May not be null.
    
    Returns:
    
    this for chaining
    
    See Also:
    
    setMDNOptions(String)
  - getMDNOptions
```
@Nullable
public String getMDNOptions()
```
    Get the current MDN options. Since 3.0.4 the MDN options (corresponding to the 'Disposition-Notification-Options' header) may be null.
    
    Returns:
    
    The MDN options (Disposition-Notification-Options header) to be used. May be null. The default is defined in DEFAULT_MDN_OPTIONS.
    
    See Also:
    
    setMDNOptions(DispositionOptions), setMDNOptions(String)
  - hasMDNOptions
```
public boolean hasMDNOptions()
```
    Returns:
    
    true if MDN options are specified (the default), false if not.
    
    Since:
    
    3.0.4
  - setAsyncMDNUrl
```
@Nonnull
public AS2ClientSettings setAsyncMDNUrl(@Nullable
                                                  String sAsyncMDNUrl)
```
    Set the asynchronous MDN URL to be used.
    
    Parameters:
    
    sAsyncMDNUrl - May be null in which case a synchronous MDN is requested (which is also the default).
    
    Returns:
    
    this for chaining
    
    Since:
    
    3.0.4
  - getAsyncMDNUrl
```
@Nullable
public String getAsyncMDNUrl()
```
    Returns:
    
    The URL for the asynchronous MDN. If this is null than a synchronous MDN is requested. By default a synchronous MDN is requested.
    
    Since:
    
    3.0.4
  - isAsyncMDNRequested
```
public boolean isAsyncMDNRequested()
```
    Returns:
    
    true if an asynchronous MDN is requested, false if not (default).
    
    Since:
    
    3.0.4
    
    See Also:
    
    getAsyncMDNUrl()
  - setMessageIDFormat
```
@Nonnull
public AS2ClientSettings setMessageIDFormat(@Nonnull
                                                      String sMessageIDFormat)
```
    Set the Message ID format. This string may contain placeholders as supported by the com.helger.as2lib.params parameters parsers.
    
    Parameters:
    
    sMessageIDFormat - The message ID format to use. May not be null.
    
    Returns:
    
    this for chaining
  - getMessageIDFormat
```
@Nonnull
public String getMessageIDFormat()
```
    Returns:
    
    The message ID format to use. Never null. It defaults to "ph-OpenAS2-$date.ddMMuuuuHHmmssZ$-$rand.1234$@$msg.sender.as2_id$_$msg.receiver.as2_id$".
    
    See Also:
    
    DEFAULT_MESSAGE_ID_FORMAT, setMessageIDFormat(String)
  - setRetryCount
```
@Nonnull
public AS2ClientSettings setRetryCount(int nRetryCount)
```
    Set the retry count for sending,
    
    Parameters:
    
    nRetryCount - Sending retry count. Values ≤ 0 mean "no retry".
    
    Returns:
    
    this for chaining
    
    See Also:
    
    getRetryCount()
  - getRetryCount
```
public int getRetryCount()
```
    Returns:
    
    The number of retries to be performed. May be ≤ 0 meaning that no retry will happen. The default value is DEFAULT_RETRY_COUNT.
    
    See Also:
    
    setRetryCount(int)
  - setConnectTimeoutMS
```
@Nonnull
public AS2ClientSettings setConnectTimeoutMS(int nConnectTimeoutMS)
```
    Set the connection timeout in milliseconds.
    
    Parameters:
    
    nConnectTimeoutMS - Connect timeout milliseconds.
    
    Returns:
    
    this for chaining
    
    Since:
    
    3.0.2
    
    See Also:
    
    getConnectTimeoutMS()
  - getConnectTimeoutMS
```
public int getConnectTimeoutMS()
```
    Returns:
    
    The connection timeout in milliseconds. The default value is DEFAULT_CONNECT_TIMEOUT_MS.
    
    Since:
    
    3.0.2
  - setReadTimeoutMS
```
@Nonnull
public AS2ClientSettings setReadTimeoutMS(int nReadTimeoutMS)
```
    Set the read timeout in milliseconds.
    
    Parameters:
    
    nReadTimeoutMS - Read timeout milliseconds.
    
    Returns:
    
    this for chaining
    
    Since:
    
    3.0.2
    
    See Also:
    
    getReadTimeoutMS()
  - getReadTimeoutMS
```
public int getReadTimeoutMS()
```
    Returns:
    
    The read timeout in milliseconds. The default value is DEFAULT_READ_TIMEOUT_MS.
    
    Since:
    
    3.0.2
  - customHeaders
```
@Nonnull
 @ReturnsMutableObject
public com.helger.commons.http.HttpHeaderMap customHeaders()
```
    Returns:
    
    The mutable custom header map. Never null.
    
    Since:
    
    3.0.5
  - isLargeFileSupport
```
public boolean isLargeFileSupport()
```
  - setLargeFileSupport
```
@Nonnull
public AS2ClientSettings setLargeFileSupport(boolean bLargeFileSupport)
```
    Parameters:
    
    bLargeFileSupport - true to enable support for large files, i.e. avoid holding all file in memory
    
    Returns:
    
    this for chaining
    
    Since:
    
    4.2.0

Class AS2ClientSettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_COMPRESS_BEFORE_SIGNING

DEFAULT_IS_MDN_REQUESTED

DEFAULT_MDN_OPTIONS

DEFAULT_MESSAGE_ID_FORMAT

DEFAULT_RETRY_COUNT

DEFAULT_CONNECT_TIMEOUT_MS

DEFAULT_READ_TIMEOUT_MS

DEFAULT_LARGE_FILE_SUPPORT_ENABLED

Constructor Detail

AS2ClientSettings

Method Detail

setKeyStore

getKeyStoreType

getKeyStoreFile

getKeyStorePassword

setSaveKeyStoreChangesToFile

isSaveKeyStoreChangesToFile

setSenderData

getSenderAS2ID

getSenderEmailAddress

getSenderKeyAlias

setReceiverData

getReceiverAS2ID

getReceiverKeyAlias

getDestinationAS2URL

setReceiverCertificate

getReceiverCertificate

setEncryptAndSign

getCryptAlgo

getCryptAlgoID

getSignAlgo

getSignAlgoID

setCompress

getCompressionType

isCompressBeforeSigning

setPartnershipName

getPartnershipName

setMDNRequested

isMDNRequested

setMDNOptions

setMDNOptions

getMDNOptions

hasMDNOptions

setAsyncMDNUrl

getAsyncMDNUrl

isAsyncMDNRequested

setMessageIDFormat

getMessageIDFormat

setRetryCount

getRetryCount

setConnectTimeoutMS

getConnectTimeoutMS

setReadTimeoutMS

getReadTimeoutMS

customHeaders

isLargeFileSupport

setLargeFileSupport