HandlerSettings (OnixS Eurex ETI Handler 1.16.0 API)

java.lang.Object
- biz.onixs.eurex.eti.handler.core.HandlerSettings

public class HandlerSettings
extends Object

Handler settings.

Constructor Summary

Constructors
Constructor and Description

HandlerSettings()

Constructors
Constructor and Description
`HandlerSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConnectionSettings`	`getConnectionSettings()` Returns the connection settings.
`int`	`getHeartbeatInterval()` Returns the heartbeat interval in milliseconds.
`String`	`getLicenseContent()` Returns license file content if set explicitly.
`String`	`getLicenseDirectory()` Returns license directory.
`String`	`getLicenseFile()` Returns license file.
`int`	`getLogonTimeout()` Returns how long the handler waits for the exchange to answer a logon, in seconds.
`int[]`	`getReceivingThreadAffinity()` Returns a processor affinity mask for the receiving thread.
`ReconnectionSettings`	`getReconnectionSettings()` Returns reconnection settings.
`String`	`getRSAKeyPath()` Returns RSA Public Key path.
`int[]`	`getSendingThreadAffinity()` Returns a processor affinity mask for the sending thread.
`int`	`getTimeout()` Returns timeout in seconds.
`void`	`init(biz.onixs.util.settings.Settings settings)` Initializes the handler settings.
`void`	`init(String settingsResource)` Initializes the handler settings.
`void`	`setConnectionSettings(ConnectionSettings connectionSettings)` Sets the connection settings.
`void`	`setHeartbeatInterval(int heartbeatInterval)` Sets the heartbeat interval in milliseconds.
`void`	`setLicenseContent(String licenseContent)` Sets license file content explicitly.
`void`	`setLicenseDirectory(String licenseDirectory)` Sets license directory.
`void`	`setLicenseFile(String licenseFile)` Sets license file.
`void`	`setLogonTimeout(int timeoutInSeconds)` Sets how long the handler waits for the exchange to answer a logon, in seconds.
`void`	`setReceivingThreadAffinity(int[] affinity)` Sets a processor affinity mask for the receiving thread.
`void`	`setReconnectionSettings(ReconnectionSettings reconnectionSettings)` Sets reconnection settings.
`void`	`setRSAKeyPath(String rsaKeyPath)` Sets RSA Public Key path.
`void`	`setSendingThreadAffinity(int[] affinity)` Sets a processor affinity mask for the sending thread.
`void`	`setTimeout(int timeoutInSeconds)` Sets timeout in seconds.
`String`	`toString()`

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

- Constructor Detail
  - HandlerSettings
```
public HandlerSettings()
```
- Method Detail
  - init
```
public void init(String settingsResource)
          throws HandlerException
```
    Initializes the handler settings.
    
    Parameters:
    
    settingsResource - settings resource to load from
    
    Throws:
    
    HandlerException - if a setting the resource carries is not usable - a Host left at its placeholder value, or an RSAKeyPath naming a file that does not exist
  - init
```
public void init(biz.onixs.util.settings.Settings settings)
          throws HandlerException
```
    Initializes the handler settings.
    
    Parameters:
    
    settings - to apply
    
    Throws:
    
    HandlerException - if a setting is not usable - a Host left at its placeholder value, or an RSAKeyPath naming a file that does not exist
  - getSendingThreadAffinity
```
public int[] getSendingThreadAffinity()
```
    Returns a processor affinity mask for the sending thread.
    The default value is null.
    
    Returns:
    
    affinity mask for the sending thread.
  - setSendingThreadAffinity
```
public void setSendingThreadAffinity(int[] affinity)
```
    Sets a processor affinity mask for the sending thread.
    The default value is null.
    
    Parameters:
    
    affinity - affinity mask for the sending thread.
  - getReceivingThreadAffinity
```
public int[] getReceivingThreadAffinity()
```
    Returns a processor affinity mask for the receiving thread.
    The default value is null.
    
    Returns:
    
    affinity mask for the receiving thread.
  - setReceivingThreadAffinity
```
public void setReceivingThreadAffinity(int[] affinity)
```
    Sets a processor affinity mask for the receiving thread.
    The default value is null.
    
    Parameters:
    
    affinity - affinity mask for the receiving thread.
  - getHeartbeatInterval
```
public int getHeartbeatInterval()
```
    Returns the heartbeat interval in milliseconds.
    
    Returns:
    
    heartbeat interval in milliseconds
  - setHeartbeatInterval
```
public void setHeartbeatInterval(int heartbeatInterval)
```
    Sets the heartbeat interval in milliseconds.
    
    Parameters:
    
    heartbeatInterval - heartbeat interval, from 100 till 60000, default is 30000.
  - getConnectionSettings
```
public ConnectionSettings getConnectionSettings()
```
    Returns the connection settings.
    
    Returns:
    
    connection settings
  - setConnectionSettings
```
public void setConnectionSettings(ConnectionSettings connectionSettings)
```
    Sets the connection settings.
    
    Parameters:
    
    connectionSettings - connection settings
  - getLicenseFile
```
public String getLicenseFile()
```
    Returns license file.
    
    Returns:
    
    license file
  - setLicenseFile
```
public void setLicenseFile(String licenseFile)
```
    Sets license file. The default is "OnixS.lic".
    
    Parameters:
    
    licenseFile - license file.
  - getLicenseDirectory
```
public String getLicenseDirectory()
```
    Returns license directory.
    
    Returns:
    
    license directory
  - setLicenseDirectory
```
public void setLicenseDirectory(String licenseDirectory)
```
    Sets license directory. The default is "./".
    
    Parameters:
    
    licenseDirectory - license directory
  - getLicenseContent
```
public String getLicenseContent()
```
    Returns license file content if set explicitly.
    
    Returns:
    
    license file content
  - setLicenseContent
```
public void setLicenseContent(String licenseContent)
```
    Sets license file content explicitly. The default is "" (empty string).
    
    Parameters:
    
    licenseContent - license file content
  - getReconnectionSettings
```
public ReconnectionSettings getReconnectionSettings()
```
    Returns reconnection settings.
    
    Returns:
    
    reconnection settings
  - setReconnectionSettings
```
public void setReconnectionSettings(ReconnectionSettings reconnectionSettings)
```
    Sets reconnection settings.
    
    Parameters:
    
    reconnectionSettings - reconnection settings
  - getTimeout
```
public int getTimeout()
```
    Returns timeout in seconds.
    
    Returns:
    
    timeout in seconds
  - setTimeout
```
public void setTimeout(int timeoutInSeconds)
```
    Sets timeout in seconds. The default is 1 second.
    This bounds establishing the connection; setLogonTimeout(int) bounds the logon that follows it.
    
    Parameters:
    
    timeoutInSeconds - timeout in seconds, from 1 to 2147483
    
    Throws:
    
    IllegalArgumentException - if the value is outside that range
  - getLogonTimeout
```
public int getLogonTimeout()
```
    Returns how long the handler waits for the exchange to answer a logon, in seconds.
    
    Returns:
    
    logon timeout in seconds
  - setLogonTimeout
```
public void setLogonTimeout(int timeoutInSeconds)
```
    Sets how long the handler waits for the exchange to answer a logon, in seconds. The default is 30 seconds.
    A gateway that accepts the connection and then fails to answer the logon - saying nothing, or sending part of an answer and stopping - ends the attempt once this elapses, rather than leaving the handler HandlerState.CONNECTING indefinitely. The attempt then fails like any other, so the reconnection settings apply to it.
    This is separate from setTimeout(int), which bounds establishing the connection rather than the logon that follows it, and it holds whether the exchange stays silent or sends part of an answer and stops. Setting Timeout higher than this value does not weaken it.
    
    Parameters:
    
    timeoutInSeconds - logon timeout in seconds, from 1 to 86400
    
    Throws:
    
    IllegalArgumentException - if the value is outside that range
  - getRSAKeyPath
```
public String getRSAKeyPath()
```
    Returns RSA Public Key path.
    
    Returns:
    
    RSA Public Key path.
  - setRSAKeyPath
```
public void setRSAKeyPath(String rsaKeyPath)
```
    Sets RSA Public Key path. The default is null.
    
    Parameters:
    
    rsaKeyPath - RSA Public Key path.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class HandlerSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HandlerSettings

Method Detail

init

init

getSendingThreadAffinity

setSendingThreadAffinity

getReceivingThreadAffinity

setReceivingThreadAffinity

getHeartbeatInterval

setHeartbeatInterval

getConnectionSettings

setConnectionSettings

getLicenseFile

setLicenseFile

getLicenseDirectory

setLicenseDirectory

getLicenseContent

setLicenseContent

getReconnectionSettings

setReconnectionSettings

getTimeout

setTimeout

getLogonTimeout

setLogonTimeout

getRSAKeyPath

setRSAKeyPath

toString