TerminalSettings

java.lang.Object
- com.six.timapi.TerminalSettings

```
public class TerminalSettings
extends Object
```
The per terminal configuration can be done on two ways:
- In a configuration file "TimApi.cfg"
- With the API TerminalSettings done from the application.
TIMApi reads the configuration file when the first Terminal instance is created.

The class TerminalSettings allows the setting from Application. Each instance of the Terminal class is initialized using an own instance of TerminalSettings containing the configuration relevant for this terminal. The Terminal instances read only the configuration file section with the matching terminal identifier. Multiple terminals can be configured as long as their terminal identifier are different.

All configuration has to be done before an instance of TerminalSettings is used to create a Terminal class instance.

Defines also automatic behavior for interacting with EFT terminals. By default all automatic behaviors are enabled.

Constructor Summary

Constructors
Constructor and Description
`TerminalSettings()` Create terminal settings loading the configuration from the global section in the configuration file.
`TerminalSettings(InputStreamReader inputReader)` Create terminal settings loading the configuration from the global section in the configuration file.
`TerminalSettings(InputStreamReader inputReader, String deviceId)` Create terminal settings loading the configuration from the device specific section in the configuration file.
`TerminalSettings(String deviceId)` Create terminal settings loading the configuration from the device specific section in the configuration file.
`TerminalSettings(TerminalSettings settings)` Create copy of terminal settings.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBroadcastInterface()` Interface to use for broadcasting or empty string to broadcast on all available interfaces.
`int`	`getCardInsertionTimeout()` Timeout in seconds the terminal waits for a card to be inserted before canceling an open transaction request.
`int`	`getCardRemovalTimeout()` Timeout in seconds the terminal waits for a card to be removed before requesting attendant interaction.
`int`	`getCommitTimeout()` Timeout in seconds the terminal waits until the technical auto-reversal is processed, if no commit received.
`int`	`getConnectionIPPort()` Listening Port of the EFT terminal in case of ConnectionMode OnFixIP.
`String`	`getConnectionIPString()` IP address of the EFT terminal in case of ConnectionMode OnFixIP.
`ConnectionMode`	`getConnectionMode()` Broadcast (default) or OnFixIP.
`EnumSet<Guides>`	`getGuides()` Required guides.
`String`	`getIntegratorId()` Integrator identifier.
`String`	`getLogDir()` Defines where the Log File has to be generated.
`int`	`getLogFileCountPerArchive()` Number of log files to keep before per archive file.
`int`	`getLogRetainArchiveCount()` Number of log file archives to keep before deleting them.
`int`	`getLogRetainFileCount()` Number of log files to keep before archiving them.
`int`	`getManufacturerFlags()` Manufacturer flags.
`int`	`getProceedTimeout()` Timeout in seconds the terminal waits in WaitForProceed state for an additional function until an error is returned.
`ProtocolType`	`getProtocolType()` Protocol type.
`int`	`getRequestRepetition()` Number of send request repetitions or 0 to disable.
`String`	`getSaferpayBaseUrl()` Saferpay: Base URL.
`String`	`getSaferpayCredentials()` Saferpay: Base64 encoded user name + password.
`String`	`getSaferpayCustomerId()` Saferpay: Customer ID.
`String`	`getSaferpayTerminalId()` Saferpay: Terminal Id.
`String`	`getTerminalId()` Terminal ID to be broadcasted in case of ConnectionMode Broadcast.
`boolean`	`isAllowClosedCardInsert()` Allow card to be inserted before activation.
`boolean`	`isAutoCommit()` After executing the Transaction- function the API commits the transaction automatically.
`boolean`	`isAutoShiftManagement()` Shift management is handled automatically.
`boolean`	`isAutoShutterManagement()` Shutter management is handled automatically.
`boolean`	`isDcc()` Dcc shall be supported.
`boolean`	`isEnabledKeepAlive()` Enable Keep-Alive handling.
`boolean`	`isFastNtfMode()` Enable fast notification mode.
`boolean`	`isFetchBrands()` Automatically retrieves application information during logging in.
`boolean`	`isPartialApproval()` Partial approval shall be supported.
`boolean`	`isTipAllowed()` Tip is allowed for purchase transactions.
`void`	`setAllowClosedCardInsert(boolean allowClosedCardInsert)` Set if it is allowed to insert the card before activation.
`void`	`setAutoCommit(boolean autoCommit)` After executing the Transaction- function the API commits the transaction automatically.
`void`	`setAutoShiftManagement(boolean autoShiftManagement)` Set if shift management is handled automatically.
`void`	`setAutoShutterManagement(boolean autoShutterManagement)` Set if shutter management is handled automatically.
`void`	`setBroadcastInterface(String broadcastInterface)` Set interface to use for broadcasting or empty string to broadcast on all available interfaces.
`void`	`setCardInsertionTimeout(int timeout)` Set timeout in seconds the terminal waits for a card to be inserted before canceling an open transaction request.
`void`	`setCardRemovalTimeout(int timeout)` Set timeout in seconds the terminal waits for a card to be removed before requesting attendant interaction.
`void`	`setCommitTimeout(int timeout)` Set timeout in seconds the terminal waits until the technical auto-reversal is processed, if no commit received.
`void`	`setConnectionIPPort(int connectionIPPort)` Set listening Port of the EFT terminal in case of ConnectionMode OnFixIP.
`void`	`setConnectionIPString(String connectionIPString)` Set IP address of the EFT terminal in case of ConnectionMode OnFixIP.
`void`	`setConnectionMode(ConnectionMode connectionMode)` Set broadcast (default) or OnFixIP.
`void`	`setDcc(boolean dcc)` Set if Dcc shall be supported.
`void`	`setEnableKeepAlive(boolean enableKeepAlive)` Set if Keep-Alive handling is enabled.
`void`	`setFastNtfMode(boolean fastNtfMode)` Set enable fast notification mode.
`void`	`setFetchBrands(boolean fetchBrands)` Automatically retrieves application information during logging in.
`void`	`setGuides(EnumSet<Guides> guides)` Set required guides.
`void`	`setIntegratorId(String integratorId)` Set integrator identifier.
`void`	`setLogDir(String logDir)` Set where the Log File has to be generated.
`void`	`setLogFileCountPerArchive(int logFileCountPerArchive)` Set number of log files to keep before per archive file.
`void`	`setLogRetainArchiveCount(int logRetainArchiveCount)` Set number of log file archives to keep before deleting them.
`void`	`setLogRetainFileCount(int logRetainFileCount)` Set number of log files to keep before archiving them.
`void`	`setManufacturerFlags(int manufacturerFlags)` Set manufacturer flags.
`void`	`setPartialApproval(boolean partialApproval)` Partial approval shall be supported.
`void`	`setProceedTimeout(int timeout)` Set timeout in seconds the terminal waits in WaitForProceed state for an additional function until an error is returned.
`void`	`setProtocolType(ProtocolType protocolType)` Set protocol type.
`void`	`setRequestRepetition(int requestRepetition)` Set number of send request repetitions or 0 to disable.
`void`	`setSaferpayBaseUrl(String baseUrl)` Saferpay: Set base URL.
`void`	`setSaferpayCredentials(String credentials)` Saferpay: Set Base64 encoded user name + password.
`void`	`setSaferpayCustomerId(String customerId)` Saferpay: Set customer ID.
`void`	`setSaferpayTerminalId(String terminalId)` Saferpay: Set terminal Id.
`void`	`setTerminalId(String terminalId)` Set terminal ID to be broadcasted in case of ConnectionMode Broadcast.
`void`	`setTipAllowed(boolean tipAllowed)` Set if tip is allowed for purchase transactions.
`String`	`toString()` String representation for debugging purpose.

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

- Constructor Detail
  - TerminalSettings
```
public TerminalSettings()
```
    Create terminal settings loading the configuration from the global section in the configuration file.
  - TerminalSettings
```
public TerminalSettings(String deviceId)
```
    Create terminal settings loading the configuration from the device specific section in the configuration file. If not found the global section is loaded instead.
  - TerminalSettings
```
public TerminalSettings(InputStreamReader inputReader)
```
    Create terminal settings loading the configuration from the global section in the configuration file.
  - TerminalSettings
```
public TerminalSettings(InputStreamReader inputReader,
                        String deviceId)
```
    Create terminal settings loading the configuration from the device specific section in the configuration file. If not found the global section is loaded instead.
  - TerminalSettings
```
public TerminalSettings(TerminalSettings settings)
```
    Create copy of terminal settings.
    
    Parameters:
    
    settings - Settings to copy
- Method Detail
  - getLogDir
```
public String getLogDir()
```
    Defines where the Log File has to be generated. Overrides the LogDir defined in GlobalSettings.
  - setLogDir
```
public void setLogDir(String logDir)
```
    Set where the Log File has to be generated. Overrides the LogDir defined in GlobalSettings.
  - getLogRetainFileCount
```
public int getLogRetainFileCount()
```
    Number of log files to keep before archiving them. 0 to disable using log files.
  - setLogRetainFileCount
```
public void setLogRetainFileCount(int logRetainFileCount)
```
    Set number of log files to keep before archiving them. Use 0 to disable using log files.
  - getLogFileCountPerArchive
```
public int getLogFileCountPerArchive()
```
    Number of log files to keep before per archive file.
  - setLogFileCountPerArchive
```
public void setLogFileCountPerArchive(int logFileCountPerArchive)
```
    Set number of log files to keep before per archive file.
  - getLogRetainArchiveCount
```
public int getLogRetainArchiveCount()
```
    Number of log file archives to keep before deleting them. 0 to disable using archive files.
  - setLogRetainArchiveCount
```
public void setLogRetainArchiveCount(int logRetainArchiveCount)
```
    Set number of log file archives to keep before deleting them. Use 0 to disable using archive files.
  - getTerminalId
```
public String getTerminalId()
```
    Terminal ID to be broadcasted in case of ConnectionMode Broadcast.
  - setTerminalId
```
public void setTerminalId(String terminalId)
```
    Set terminal ID to be broadcasted in case of ConnectionMode Broadcast.
  - getConnectionMode
```
public ConnectionMode getConnectionMode()
```
    Broadcast (default) or OnFixIP.
  - setConnectionMode
```
public void setConnectionMode(ConnectionMode connectionMode)
```
    Set broadcast (default) or OnFixIP.
  - getConnectionIPString
```
public String getConnectionIPString()
```
    IP address of the EFT terminal in case of ConnectionMode OnFixIP.
  - setConnectionIPString
```
public void setConnectionIPString(String connectionIPString)
```
    Set IP address of the EFT terminal in case of ConnectionMode OnFixIP.
  - getConnectionIPPort
```
public int getConnectionIPPort()
```
    Listening Port of the EFT terminal in case of ConnectionMode OnFixIP.
  - setConnectionIPPort
```
public void setConnectionIPPort(int connectionIPPort)
```
    Set listening Port of the EFT terminal in case of ConnectionMode OnFixIP.
  - getBroadcastInterface
```
public String getBroadcastInterface()
```
    Interface to use for broadcasting or empty string to broadcast on all available interfaces.
  - setBroadcastInterface
```
public void setBroadcastInterface(String broadcastInterface)
```
    Set interface to use for broadcasting or empty string to broadcast on all available interfaces.
  - getProtocolType
```
public ProtocolType getProtocolType()
```
    Protocol type.
  - setProtocolType
```
public void setProtocolType(ProtocolType protocolType)
```
    Set protocol type.
  - getIntegratorId
```
public String getIntegratorId()
```
    Integrator identifier.
  - setIntegratorId
```
public void setIntegratorId(String integratorId)
```
    Set integrator identifier. Can not be set using configuration file.
  - getGuides
```
public EnumSet<Guides> getGuides()
```
    Required guides. Login succeeds only if the terminal is able to provide all requested guides.
    
    Returns:
    
    Copy of guides save to be modified.
  - setGuides
```
public void setGuides(EnumSet<Guides> guides)
```
    Set required guides. Login succeeds only if the terminal is able to provide all requested guides. Guides.RETAIL has to be always enabled. Can not be set using configuration file.
    
    Parameters:
    
    guides - Guides to enable. Stores copy. It is safe to change the value of guides after this call.
    
    Throws:
    
    IllegalArgumentException - guides does not contain Guides.RETAIL.
  - getManufacturerFlags
```
public int getManufacturerFlags()
```
    Manufacturer flags.
  - setManufacturerFlags
```
public void setManufacturerFlags(int manufacturerFlags)
```
    Set manufacturer flags. Can not be set using configuration file.
  - isFetchBrands
```
public boolean isFetchBrands()
```
    Automatically retrieves application information during logging in.
  - setFetchBrands
```
public void setFetchBrands(boolean fetchBrands)
```
    Automatically retrieves application information during logging in.
  - isAutoCommit
```
public boolean isAutoCommit()
```
    After executing the Transaction- function the API commits the transaction automatically.
  - setAutoCommit
```
public void setAutoCommit(boolean autoCommit)
```
    After executing the Transaction- function the API commits the transaction automatically.
  - isAutoShiftManagement
```
public boolean isAutoShiftManagement()
```
    Shift management is handled automatically. Required if device does not support Activate and Deactivate functions.
  - setAutoShiftManagement
```
public void setAutoShiftManagement(boolean autoShiftManagement)
```
    Set if shift management is handled automatically. Required if device does not support Activate and Deactivate functions.
  - isAutoShutterManagement
```
public boolean isAutoShutterManagement()
```
    Shutter management is handled automatically.
  - setAutoShutterManagement
```
public void setAutoShutterManagement(boolean autoShutterManagement)
```
    Set if shutter management is handled automatically.
  - getCardInsertionTimeout
```
public int getCardInsertionTimeout()
```
    Timeout in seconds the terminal waits for a card to be inserted before canceling an open transaction request.
  - setCardInsertionTimeout
```
public void setCardInsertionTimeout(int timeout)
```
    Set timeout in seconds the terminal waits for a card to be inserted before canceling an open transaction request.
  - getCardRemovalTimeout
```
public int getCardRemovalTimeout()
```
    Timeout in seconds the terminal waits for a card to be removed before requesting attendant interaction.
  - setCardRemovalTimeout
```
public void setCardRemovalTimeout(int timeout)
```
    Set timeout in seconds the terminal waits for a card to be removed before requesting attendant interaction.
  - getCommitTimeout
```
public int getCommitTimeout()
```
    Timeout in seconds the terminal waits until the technical auto-reversal is processed, if no commit received. Timer starts with response and is reset in case client enters information in the terminal.
  - setCommitTimeout
```
public void setCommitTimeout(int timeout)
```
    Set timeout in seconds the terminal waits until the technical auto-reversal is processed, if no commit received. Timer starts with response and is reset in case client enters information in the terminal.
  - isDcc
```
public boolean isDcc()
```
    Dcc shall be supported.
  - setDcc
```
public void setDcc(boolean dcc)
```
    Set if Dcc shall be supported.
  - isPartialApproval
```
public boolean isPartialApproval()
```
    Partial approval shall be supported.
  - setPartialApproval
```
public void setPartialApproval(boolean partialApproval)
```
    Partial approval shall be supported.
  - getProceedTimeout
```
public int getProceedTimeout()
```
    Timeout in seconds the terminal waits in WaitForProceed state for an additional function until an error is returned.
  - setProceedTimeout
```
public void setProceedTimeout(int timeout)
```
    Set timeout in seconds the terminal waits in WaitForProceed state for an additional function until an error is returned.
  - isAllowClosedCardInsert
```
public boolean isAllowClosedCardInsert()
```
    Allow card to be inserted before activation.
  - setAllowClosedCardInsert
```
public void setAllowClosedCardInsert(boolean allowClosedCardInsert)
```
    Set if it is allowed to insert the card before activation.
  - isTipAllowed
```
public boolean isTipAllowed()
```
    Tip is allowed for purchase transactions. This parameter is only used if Guides.GASTRO is enabled.
  - setTipAllowed
```
public void setTipAllowed(boolean tipAllowed)
```
    Set if tip is allowed for purchase transactions. This parameter is only used if Guides.GASTRO is enabled.
  - isFastNtfMode
```
public boolean isFastNtfMode()
```
    Enable fast notification mode. This parameter is only used if Guides.AUSTRIAN_USE_CASES is enabled.
  - setFastNtfMode
```
public void setFastNtfMode(boolean fastNtfMode)
```
    Set enable fast notification mode. This parameter is only used if Guides.AUSTRIAN_USE_CASES is enabled.
  - getRequestRepetition
```
public int getRequestRepetition()
```
    Number of send request repetitions or 0 to disable. Default is 0. Affects these functions: - Commit - Rollback
  - setRequestRepetition
```
public void setRequestRepetition(int requestRepetition)
```
    Set number of send request repetitions or 0 to disable. Default is 0. Affects these functions: - Commit - Rollback
    
    Throws:
    
    IllegalArgumentException - requestRepetition is less than 0.
  - isEnabledKeepAlive
```
public boolean isEnabledKeepAlive()
```
    Enable Keep-Alive handling. Default is true.
  - setEnableKeepAlive
```
public void setEnableKeepAlive(boolean enableKeepAlive)
```
    Set if Keep-Alive handling is enabled. Default is true.
  - getSaferpayTerminalId
```
public String getSaferpayTerminalId()
```
    Saferpay: Terminal Id.
  - setSaferpayTerminalId
```
public void setSaferpayTerminalId(String terminalId)
```
    Saferpay: Set terminal Id.
  - getSaferpayCredentials
```
public String getSaferpayCredentials()
```
    Saferpay: Base64 encoded user name + password.
  - setSaferpayCredentials
```
public void setSaferpayCredentials(String credentials)
```
    Saferpay: Set Base64 encoded user name + password.
  - getSaferpayCustomerId
```
public String getSaferpayCustomerId()
```
    Saferpay: Customer ID.
  - setSaferpayCustomerId
```
public void setSaferpayCustomerId(String customerId)
```
    Saferpay: Set customer ID.
  - getSaferpayBaseUrl
```
public String getSaferpayBaseUrl()
```
    Saferpay: Base URL.
  - setSaferpayBaseUrl
```
public void setSaferpayBaseUrl(String baseUrl)
```
    Saferpay: Set base URL.
  - toString
```
public String toString()
```
    String representation for debugging purpose.
    
    Overrides:
    
    toString in class Object

Class TerminalSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TerminalSettings

TerminalSettings

TerminalSettings

TerminalSettings

TerminalSettings

Method Detail

getLogDir

setLogDir

getLogRetainFileCount

setLogRetainFileCount

getLogFileCountPerArchive

setLogFileCountPerArchive

getLogRetainArchiveCount

setLogRetainArchiveCount

getTerminalId

setTerminalId

getConnectionMode

setConnectionMode

getConnectionIPString

setConnectionIPString

getConnectionIPPort

setConnectionIPPort

getBroadcastInterface

setBroadcastInterface

getProtocolType

setProtocolType

getIntegratorId

setIntegratorId

getGuides

setGuides

getManufacturerFlags

setManufacturerFlags

isFetchBrands

setFetchBrands

isAutoCommit

setAutoCommit

isAutoShiftManagement

setAutoShiftManagement

isAutoShutterManagement

setAutoShutterManagement

getCardInsertionTimeout

setCardInsertionTimeout

getCardRemovalTimeout

setCardRemovalTimeout

getCommitTimeout

setCommitTimeout

isDcc

setDcc

isPartialApproval

setPartialApproval

getProceedTimeout

setProceedTimeout

isAllowClosedCardInsert

setAllowClosedCardInsert

isTipAllowed

setTipAllowed

isFastNtfMode

setFastNtfMode

getRequestRepetition

setRequestRepetition

isEnabledKeepAlive

setEnableKeepAlive

getSaferpayTerminalId

setSaferpayTerminalId

getSaferpayCredentials

setSaferpayCredentials

getSaferpayCustomerId

setSaferpayCustomerId

getSaferpayBaseUrl

setSaferpayBaseUrl

toString