HandlerSettings (OnixS CME iLink3 Handler Parent 1.0.8 API)

java.lang.Object
- biz.onixs.cme.ilink3.handler.HandlerSettings

public class HandlerSettings
extends Object

The handler configuration settings.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ASYNC_FILE_STORAGE_QUEUE_SIZE_DEFAULT`
`static String`	`ASYNC_FILE_STORAGE_QUEUE_SIZE_PROP`
`static int`	`ASYNC_FILE_STORAGE_WRITE_ERROR_RETRIES_NUMBER_DEFAULT`
`static String`	`ASYNC_FILE_STORAGE_WRITE_ERROR_RETRIES_NUMBER_PROP`
`static boolean`	`EVENT_ARG_REUSE_DEFAULT`
`static String`	`EVENT_ARG_REUSE_PROP`
`static boolean`	`IGNORE_FILE_BASED_STORAGE_INTEGRITY_ERRORS_DEFAULT`
`static String`	`IGNORE_FILE_BASED_STORAGE_INTEGRITY_ERRORS_PROP`
`static String`	`LICENSE_FILE_DEFAULT`
`static String`	`LICENSE_FILE_PROP`
`static int`	`LISTENER_DELAY_WARNING_THRESHOLD_DEFAULT`
`static String`	`LISTENER_DELAY_WARNING_THRESHOLD_PROP`
`static int`	`RESENDING_QUEUE_SIZE_DEFAULT`
`static String`	`RESENDING_QUEUE_SIZE_PROP`
`static boolean`	`SHUTDOWN_HOOK_DEFAULT`
`static String`	`SHUTDOWN_HOOK_PROP`
`static String`	`STORAGE_FOLDER_DEFAULT`
`static String`	`STORAGE_FOLDER_PROP`

Constructor Summary

Constructors
Constructor and Description

HandlerSettings()
Default constructor.

Constructors
Constructor and Description
`HandlerSettings()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAsyncFileStorageQueueSize()` Returns async file session storage queue size.
`int`	`getAsyncFileStorageWriteErrorRetriesNumber()` Returns async file session storage write error retries number.
`String`	`getFullStorageFolder()` Returns full storage folder path.
`String`	`getLicense()` Returns the content of the license file if it is set explicitly using `setLicense(String)`.
`String`	`getLicenseFile()` Returns the name of the license file resource.
`int`	`getListenerDelayWarningThreshold()` Returns the limit of time to spend in the session listener code.
`int`	`getResendingQueueSize()` Returns the number of sent messages that are available for resending on counterparty's Resend Request(2) message.
`String`	`getStorageFolder()` Returns file-based session storage folder.
`void`	`init(Settings settings)` Initializes the settings.
`boolean`	`isEventArgReuse()` Returns whether to re-use session event argument objects in each session.
`boolean`	`isIgnoreFileBasedStorageIntegrityErrors()` Returns whether to ignore file based storage integrity errors.
`boolean`	`isShutdownHook()` Returns whether to shutdown handler automatically on JVM shutdown.
`void`	`setAsyncFileStorageQueueSize(int asyncFileStorageQueueSize)` Sets async file session storage queue size.
`void`	`setAsyncFileStorageWriteErrorRetriesNumber(int asyncFileStorageWriteErrorRetriesNumber)` Sets async file session storage write error retries number.
`void`	`setEventArgReuse(boolean eventArgReuse)` Sets whether to re-use session event argument objects in each session.
`void`	`setIgnoreFileBasedStorageIntegrityErrors(boolean ignoreFileBasedStorageIntegrityErrors)` Sets whether to ignore file based storage integrity errors.
`void`	`setLicense(String license)` Sets the content of the license file.
`void`	`setLicenseFile(String licenseFile)` Sets the name of the license file resource.
`void`	`setListenerDelayWarningThreshold(int listenerDelayWarningThreshold)` Sets the limit of time to spend in the session listener code.
`void`	`setResendingQueueSize(int resendingQueueSize)` Sets the number of sent messages that are available for resending on counterparty's Resend Request(2) message.
`void`	`setShutdownHook(boolean shutdownHook)` Sets to shutdown handler automatically on JVM shutdown.
`void`	`setStorageFolder(String storageFolder)` Sets file-based session storage folder.
`String`	`toString()`

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

- Field Detail
  - LICENSE_FILE_PROP
```
public static final String LICENSE_FILE_PROP
```
    See Also:
    
    Constant Field Values
  - LICENSE_FILE_DEFAULT
```
public static final String LICENSE_FILE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - EVENT_ARG_REUSE_PROP
```
public static final String EVENT_ARG_REUSE_PROP
```
    See Also:
    
    Constant Field Values
  - EVENT_ARG_REUSE_DEFAULT
```
public static final boolean EVENT_ARG_REUSE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - LISTENER_DELAY_WARNING_THRESHOLD_PROP
```
public static final String LISTENER_DELAY_WARNING_THRESHOLD_PROP
```
    See Also:
    
    Constant Field Values
  - LISTENER_DELAY_WARNING_THRESHOLD_DEFAULT
```
public static final int LISTENER_DELAY_WARNING_THRESHOLD_DEFAULT
```
    See Also:
    
    Constant Field Values
  - STORAGE_FOLDER_PROP
```
public static final String STORAGE_FOLDER_PROP
```
    See Also:
    
    Constant Field Values
  - STORAGE_FOLDER_DEFAULT
```
public static final String STORAGE_FOLDER_DEFAULT
```
    See Also:
    
    Constant Field Values
  - RESENDING_QUEUE_SIZE_PROP
```
public static final String RESENDING_QUEUE_SIZE_PROP
```
    See Also:
    
    Constant Field Values
  - RESENDING_QUEUE_SIZE_DEFAULT
```
public static final int RESENDING_QUEUE_SIZE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - IGNORE_FILE_BASED_STORAGE_INTEGRITY_ERRORS_PROP
```
public static final String IGNORE_FILE_BASED_STORAGE_INTEGRITY_ERRORS_PROP
```
    See Also:
    
    Constant Field Values
  - IGNORE_FILE_BASED_STORAGE_INTEGRITY_ERRORS_DEFAULT
```
public static final boolean IGNORE_FILE_BASED_STORAGE_INTEGRITY_ERRORS_DEFAULT
```
    See Also:
    
    Constant Field Values
  - ASYNC_FILE_STORAGE_QUEUE_SIZE_PROP
```
public static final String ASYNC_FILE_STORAGE_QUEUE_SIZE_PROP
```
    See Also:
    
    Constant Field Values
  - ASYNC_FILE_STORAGE_QUEUE_SIZE_DEFAULT
```
public static final int ASYNC_FILE_STORAGE_QUEUE_SIZE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - ASYNC_FILE_STORAGE_WRITE_ERROR_RETRIES_NUMBER_PROP
```
public static final String ASYNC_FILE_STORAGE_WRITE_ERROR_RETRIES_NUMBER_PROP
```
    See Also:
    
    Constant Field Values
  - ASYNC_FILE_STORAGE_WRITE_ERROR_RETRIES_NUMBER_DEFAULT
```
public static final int ASYNC_FILE_STORAGE_WRITE_ERROR_RETRIES_NUMBER_DEFAULT
```
    See Also:
    
    Constant Field Values
  - SHUTDOWN_HOOK_PROP
```
public static final String SHUTDOWN_HOOK_PROP
```
    See Also:
    
    Constant Field Values
  - SHUTDOWN_HOOK_DEFAULT
```
public static final boolean SHUTDOWN_HOOK_DEFAULT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HandlerSettings
```
public HandlerSettings()
```
    Default constructor.
- Method Detail
  - init
```
public void init(Settings settings)
```
    Initializes the settings.
    
    Parameters:
    
    settings - settings to initialize with
    
    Throws:
    
    NullPointerException - if (settings == null)
    
    IllegalArgumentException - if settings has incorrect value
  - getLicenseFile
```
public String getLicenseFile()
```
    Returns the name of the license file resource.
    The default value is LICENSE_FILE_DEFAULT.
    The property name is LICENSE_FILE_PROP.
    
    Returns:
    
    license file resource
  - setLicenseFile
```
public void setLicenseFile(String licenseFile)
```
    Sets the name of the license file resource.
    The default value is LICENSE_FILE_DEFAULT.
    The property name is LICENSE_FILE_PROP.
    
    Parameters:
    
    licenseFile - license file resource
    
    Throws:
    
    NullPointerException - if (licenseFile == null)
  - setLicense
```
public void setLicense(String license)
```
    Sets the content of the license file. It will have priority over external license file.
    
    Parameters:
    
    license - license file content, null to reset the value
    
    Throws:
    
    NullPointerException - if (license == null)
  - getLicense
```
public String getLicense()
```
    Returns the content of the license file if it is set explicitly using setLicense(String).
    
    Returns:
    
    license file content, null if it is not set explicitly
  - isEventArgReuse
```
public boolean isEventArgReuse()
```
    Returns whether to re-use session event argument objects in each session.
    The default value is EVENT_ARG_REUSE_DEFAULT.
    The property name is EVENT_ARG_REUSE_PROP.
    
    Returns:
    
    whether to re-use session event argument objects
  - setEventArgReuse
```
public void setEventArgReuse(boolean eventArgReuse)
```
    Sets whether to re-use session event argument objects in each session.
    The default value is EVENT_ARG_REUSE_DEFAULT.
    The property name is EVENT_ARG_REUSE_PROP.
    
    Parameters:
    
    eventArgReuse - whether to re-use session event argument objects
  - getListenerDelayWarningThreshold
```
public int getListenerDelayWarningThreshold()
```
    Returns the limit of time to spend in the session listener code.
    If the listener takes longer then the warning is generated.
    
    Returns:
    
    delay in milliseconds
  - setListenerDelayWarningThreshold
```
public void setListenerDelayWarningThreshold(int listenerDelayWarningThreshold)
```
    Sets the limit of time to spend in the session listener code.
    If the listener takes longer then the warning is generated.
    
    Parameters:
    
    listenerDelayWarningThreshold - delay in milliseconds
    
    Throws:
    
    IllegalArgumentException - if (sessionListenerDelayWarningThreshold < 1)
  - getStorageFolder
```
public String getStorageFolder()
```
    Returns file-based session storage folder.
    The default value is STORAGE_FOLDER_DEFAULT.
    The property name is STORAGE_FOLDER_PROP.
    
    Returns:
    
    file-based session storage folder
  - setStorageFolder
```
public void setStorageFolder(String storageFolder)
```
    Sets file-based session storage folder.
    The default value is STORAGE_FOLDER_DEFAULT.
    The property name is STORAGE_FOLDER_PROP.
    
    Parameters:
    
    storageFolder - file-based session storage folder
    
    Throws:
    
    NullPointerException - if (storageFolder == null).
  - getFullStorageFolder
```
public String getFullStorageFolder()
```
    Returns full storage folder path.
    
    Returns:
    
    full storage folder path
  - getResendingQueueSize
```
public int getResendingQueueSize()
```
    Returns the number of sent messages that are available for resending on counterparty's Resend Request(2) message.
    The default value is RESENDING_QUEUE_SIZE_DEFAULT.
    The property name is RESENDING_QUEUE_SIZE_PROP.
    
    Returns:
    
    resending queue size in messages
  - setResendingQueueSize
```
public void setResendingQueueSize(int resendingQueueSize)
```
    Sets the number of sent messages that are available for resending on counterparty's Resend Request(2) message.
    The default value is RESENDING_QUEUE_SIZE_DEFAULT.
    The property name is RESENDING_QUEUE_SIZE_PROP.
    
    Parameters:
    
    resendingQueueSize - resending queue size in messages
    
    Throws:
    
    IllegalArgumentException - if (resendingQueueSize < 0)
  - isIgnoreFileBasedStorageIntegrityErrors
```
public boolean isIgnoreFileBasedStorageIntegrityErrors()
```
    Returns whether to ignore file based storage integrity errors.
    The default value is IGNORE_FILE_BASED_STORAGE_INTEGRITY_ERRORS_DEFAULT.
    The property name is IGNORE_FILE_BASED_STORAGE_INTEGRITY_ERRORS_PROP.
    
    Returns:
    
    ignore file based storage integrity errors.
  - setIgnoreFileBasedStorageIntegrityErrors
```
public void setIgnoreFileBasedStorageIntegrityErrors(boolean ignoreFileBasedStorageIntegrityErrors)
```
    Sets whether to ignore file based storage integrity errors.
    The default value is IGNORE_FILE_BASED_STORAGE_INTEGRITY_ERRORS_DEFAULT.
    The property name is IGNORE_FILE_BASED_STORAGE_INTEGRITY_ERRORS_PROP.
    
    Parameters:
    
    ignoreFileBasedStorageIntegrityErrors - whether to ignore file based storage integrity errors.
  - getAsyncFileStorageQueueSize
```
public int getAsyncFileStorageQueueSize()
```
    Returns async file session storage queue size.
    The default value is ASYNC_FILE_STORAGE_QUEUE_SIZE_DEFAULT.
    The property name is ASYNC_FILE_STORAGE_QUEUE_SIZE_PROP.
    
    Returns:
    
    async file session storage queue size
  - setAsyncFileStorageQueueSize
```
public void setAsyncFileStorageQueueSize(int asyncFileStorageQueueSize)
```
    Sets async file session storage queue size.
    The default value is ASYNC_FILE_STORAGE_QUEUE_SIZE_DEFAULT.
    The property name is ASYNC_FILE_STORAGE_QUEUE_SIZE_PROP.
    
    Parameters:
    
    asyncFileStorageQueueSize - async file session storage queue size
    
    Throws:
    
    IllegalArgumentException - if (asyncFileStorageQueueSize < 1)
  - getAsyncFileStorageWriteErrorRetriesNumber
```
public int getAsyncFileStorageWriteErrorRetriesNumber()
```
    Returns async file session storage write error retries number.
    The default value is ASYNC_FILE_STORAGE_WRITE_ERROR_RETRIES_NUMBER_DEFAULT.
    The property name is ASYNC_FILE_STORAGE_WRITE_ERROR_RETRIES_NUMBER_PROP.
    
    Returns:
    
    async file session storage write error retries number
  - setAsyncFileStorageWriteErrorRetriesNumber
```
public void setAsyncFileStorageWriteErrorRetriesNumber(int asyncFileStorageWriteErrorRetriesNumber)
```
    Sets async file session storage write error retries number.
    The default value is ASYNC_FILE_STORAGE_WRITE_ERROR_RETRIES_NUMBER_DEFAULT.
    The property name is ASYNC_FILE_STORAGE_WRITE_ERROR_RETRIES_NUMBER_PROP.
    
    Parameters:
    
    asyncFileStorageWriteErrorRetriesNumber - async file session storage write error retries number
    
    Throws:
    
    IllegalArgumentException - if (asyncFileStorageWriteErrorRetriesNumber < 0)
  - isShutdownHook
```
public boolean isShutdownHook()
```
    Returns whether to shutdown handler automatically on JVM shutdown.
    The default value is SHUTDOWN_HOOK_DEFAULT.
    The property name is SHUTDOWN_HOOK_PROP.
    
    Returns:
    
    whether to shutdown handler automatically on JVM shutdown
  - setShutdownHook
```
public void setShutdownHook(boolean shutdownHook)
```
    Sets to shutdown handler automatically on JVM shutdown.
    The default value is SHUTDOWN_HOOK_DEFAULT.
    The property name is SHUTDOWN_HOOK_PROP.
    
    Parameters:
    
    shutdownHook - whether to shutdown handler automatically on JVM shutdown
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class HandlerSettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LICENSE_FILE_PROP

LICENSE_FILE_DEFAULT

EVENT_ARG_REUSE_PROP

EVENT_ARG_REUSE_DEFAULT

LISTENER_DELAY_WARNING_THRESHOLD_PROP

LISTENER_DELAY_WARNING_THRESHOLD_DEFAULT

STORAGE_FOLDER_PROP

STORAGE_FOLDER_DEFAULT

RESENDING_QUEUE_SIZE_PROP

RESENDING_QUEUE_SIZE_DEFAULT

IGNORE_FILE_BASED_STORAGE_INTEGRITY_ERRORS_PROP

IGNORE_FILE_BASED_STORAGE_INTEGRITY_ERRORS_DEFAULT

ASYNC_FILE_STORAGE_QUEUE_SIZE_PROP

ASYNC_FILE_STORAGE_QUEUE_SIZE_DEFAULT

ASYNC_FILE_STORAGE_WRITE_ERROR_RETRIES_NUMBER_PROP

ASYNC_FILE_STORAGE_WRITE_ERROR_RETRIES_NUMBER_DEFAULT

SHUTDOWN_HOOK_PROP

SHUTDOWN_HOOK_DEFAULT

Constructor Detail

HandlerSettings

Method Detail

init

getLicenseFile

setLicenseFile

setLicense

getLicense

isEventArgReuse

setEventArgReuse

getListenerDelayWarningThreshold

setListenerDelayWarningThreshold

getStorageFolder

setStorageFolder

getFullStorageFolder

getResendingQueueSize

setResendingQueueSize

isIgnoreFileBasedStorageIntegrityErrors

setIgnoreFileBasedStorageIntegrityErrors

getAsyncFileStorageQueueSize

setAsyncFileStorageQueueSize

getAsyncFileStorageWriteErrorRetriesNumber

setAsyncFileStorageWriteErrorRetriesNumber

isShutdownHook

setShutdownHook

toString