Package com.six.timapi
Class TerminalSettingsImmutable
- java.lang.Object
-
- com.six.timapi.TerminalSettingsImmutable
-
public final class TerminalSettingsImmutable extends Object
Immutable Terminal Settings.
-
-
Constructor Summary
Constructors Constructor Description TerminalSettingsImmutable(TerminalSettings settings)
Create immutable terminal settings fromTerminalSettings
instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.int
getConnectionListenIPPort()
Listening Port of the ECR if listening.String
getConnectionListenIPString()
IP address of the ECR if listening.ConnectionMode
getConnectionMode()
Broadcast (default) or OnFixIP.EnumSet<Guides>
getGuides()
Required guides.String
getIntegratorId()
Integrator identifier.int
getLateCheckinTimeout()
This timeout indicates how long a terminal shall wait in seconds for an AmtAdjustment notification from the ECR in case of a late-checkin.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.String
getOmnichannelAPIKey()
Omnichannel: Key for API access.String
getOmnichannelAPISecret()
Omnichannel: Secret key for API access.int
getOmnichannelHostTimeout()
Omnichannel: Timeout of Omnichannel host communication (in seconds).String
getOmnichannelHostURL()
Omnichannel: Host-URL (for example Ogone's Direct API URL).Set<TransactionType>
getPreferOmniChannel()
Prefer OmniChannel for these functions.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
getQRCTimeout()
Timeout in seconds the terminal displays the loyalty QR code after a "StartCheckout" call before returning to its "Idle" screen.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.int
getWakeupTimeout()
Returns the timeout for terminal wake-up operations.int
hashCode()
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
isAutoSysInfo()
Automatically retrieves system information during logging in.boolean
isConnectionListen()
EFT connects to ECR instead of ECR connecting to EFT, which is the default way to connect.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
isPersistentState()
Enable persistent state if supported.boolean
isTipAllowed()
Tip is allowed for purchase transactions.String
toString()
String representation for debugging purpose.
-
-
-
Constructor Detail
-
TerminalSettingsImmutable
public TerminalSettingsImmutable(TerminalSettings settings)
Create immutable terminal settings fromTerminalSettings
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.
-
getConnectionListenIPString
public String getConnectionListenIPString()
IP address of the ECR if listening.
-
getConnectionListenIPPort
public int getConnectionListenIPPort()
Listening Port of the ECR if listening.
-
getBroadcastInterface
public String getBroadcastInterface()
Interface to use for broadcasting or empty string to broadcast on all available interfaces.
-
isConnectionListen
public boolean isConnectionListen()
EFT connects to ECR instead of ECR connecting to EFT, which is the default way to connect.
-
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.
-
isAutoSysInfo
public boolean isAutoSysInfo()
Automatically retrieves system 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 ifGuides.GASTRO
is enabled.
-
isFastNtfMode
public boolean isFastNtfMode()
Enable fast notification mode. This parameter is only used ifGuides.AUSTRIAN_USE_CASES
is enabled.
-
getQRCTimeout
public int getQRCTimeout()
Timeout in seconds the terminal displays the loyalty QR code after a "StartCheckout" call before returning to its "Idle" screen. Numeric number that specifies the QRCTimeout in seconds.
-
getLateCheckinTimeout
public int getLateCheckinTimeout()
This timeout indicates how long a terminal shall wait in seconds for an AmtAdjustment notification from the ECR in case of a late-checkin.
-
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.
-
isPersistentState
public boolean isPersistentState()
Enable persistent state if supported. Default is false.
-
getWakeupTimeout
public int getWakeupTimeout()
Returns the timeout for terminal wake-up operations. Wake up is only possible on terminals that support wake-up via ECR interface. The wake-up process is transparent to the user and is triggered by calling a function that needs the terminal. Default timeout is 20s.
-
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.
-
getPreferOmniChannel
public Set<TransactionType> getPreferOmniChannel()
Prefer OmniChannel for these functions.
-
getOmnichannelAPIKey
public String getOmnichannelAPIKey()
Omnichannel: Key for API access.
-
getOmnichannelAPISecret
public String getOmnichannelAPISecret()
Omnichannel: Secret key for API access.
-
getOmnichannelHostURL
public String getOmnichannelHostURL()
Omnichannel: Host-URL (for example Ogone's Direct API URL).
-
getOmnichannelHostTimeout
public int getOmnichannelHostTimeout()
Omnichannel: Timeout of Omnichannel host communication (in seconds).
-
toString
public String toString()
String representation for debugging purpose.
-
-