TerminalSettingsImmutable

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

public final class TerminalSettingsImmutable
extends Object

Immutable Terminal Settings.

Constructor Summary

Constructors
Constructor and Description

TerminalSettingsImmutable(TerminalSettings settings)
Create immutable terminal settings from TerminalSettings instance.

Constructors
Constructor and Description
`TerminalSettingsImmutable(TerminalSettings settings)` Create immutable terminal settings from `TerminalSettings` instance.

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.
`String`	`toString()` String representation for debugging purpose.

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

- Constructor Detail
  - TerminalSettingsImmutable
```
public TerminalSettingsImmutable(TerminalSettings settings)
```
    Create immutable terminal settings from TerminalSettings instance.
    
    Parameters:
    
    settings - Terminal settings instance. May not be null.
- Method Detail
  - getLogDir
```
public String getLogDir()
```
    Defines 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.
  - getLogFileCountPerArchive
```
public int getLogFileCountPerArchive()
```
    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.
  - getTerminalId
```
public String getTerminalId()
```
    Terminal ID to be broadcasted in case of ConnectionMode Broadcast.
  - getConnectionMode
```
public ConnectionMode getConnectionMode()
```
    Broadcast (default) or OnFixIP.
  - getConnectionIPString
```
public String getConnectionIPString()
```
    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.
  - getBroadcastInterface
```
public String getBroadcastInterface()
```
    Interface to use for broadcasting or empty string to broadcast on all available interfaces.
  - getProtocolType
```
public ProtocolType getProtocolType()
```
    Protocol type.
  - getIntegratorId
```
public String getIntegratorId()
```
    Integrator identifier.
  - 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.
  - getManufacturerFlags
```
public int getManufacturerFlags()
```
    Manufacturer flags.
  - isFetchBrands
```
public boolean isFetchBrands()
```
    Automatically retrieves application information during logging in.
  - isAutoCommit
```
public boolean isAutoCommit()
```
    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.
  - isAutoShutterManagement
```
public boolean isAutoShutterManagement()
```
    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.
  - getCardRemovalTimeout
```
public int getCardRemovalTimeout()
```
    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.
  - isDcc
```
public boolean isDcc()
```
    Dcc shall be supported.
  - isPartialApproval
```
public boolean isPartialApproval()
```
    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.
  - isAllowClosedCardInsert
```
public boolean isAllowClosedCardInsert()
```
    Allow card to be inserted before activation.
  - isTipAllowed
```
public boolean isTipAllowed()
```
    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.
  - getRequestRepetition
```
public int getRequestRepetition()
```
    Number of send request repetitions or 0 to disable. Default is 0. Affects these functions: - Commit - Rollback
  - isEnabledKeepAlive
```
public boolean isEnabledKeepAlive()
```
    Enable Keep-Alive handling. Default is true.
  - getSaferpayTerminalId
```
public String getSaferpayTerminalId()
```
    Saferpay: Terminal Id.
  - getSaferpayCredentials
```
public String getSaferpayCredentials()
```
    Saferpay: Base64 encoded user name + password.
  - getSaferpayCustomerId
```
public String getSaferpayCustomerId()
```
    Saferpay: Customer ID.
  - getSaferpayBaseUrl
```
public String getSaferpayBaseUrl()
```
    Saferpay: Base URL.
  - toString
```
public String toString()
```
    String representation for debugging purpose.
    
    Overrides:
    
    toString in class Object

Class TerminalSettingsImmutable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TerminalSettingsImmutable

Method Detail

getLogDir

getLogRetainFileCount

getLogFileCountPerArchive

getLogRetainArchiveCount

getTerminalId

getConnectionMode

getConnectionIPString

getConnectionIPPort

getBroadcastInterface

getProtocolType

getIntegratorId

getGuides

getManufacturerFlags

isFetchBrands

isAutoCommit

isAutoShiftManagement

isAutoShutterManagement

getCardInsertionTimeout

getCardRemovalTimeout

getCommitTimeout

isDcc

isPartialApproval

getProceedTimeout

isAllowClosedCardInsert

isTipAllowed

isFastNtfMode

getRequestRepetition

isEnabledKeepAlive

getSaferpayTerminalId

getSaferpayCredentials

getSaferpayCustomerId

getSaferpayBaseUrl

toString