MerchantConfig (cybersource-sdk-java 6.2.13 API)

java.lang.Object
- com.cybersource.ws.client.MerchantConfig

```
public class MerchantConfig
extends Object
```
An internal class used by the clients to hold and derive the properties applicable to the current transaction.

Constructor Summary

Constructors
Constructor and Description

MerchantConfig(Properties _props, String _merchantID)

Constructors
Constructor and Description
`MerchantConfig(Properties _props, String _merchantID)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getCacertPassword()` Getter method for cacertPassword
`int`	`getConnectionRequestTimeoutMs()` Time taken in milliseconds to get connection request from the pool.
`int`	`getConnectionTimeoutMs()` Specifies the number of milliseconds to wait while a connection is being established.
`String`	`getCustomHttpClass()`
`int`	`getDefaultMaxConnectionsPerRoute()` the maximum number of connections per (any) route
`String`	`getEffectiveNamespaceURI()` Returns the effective namespace URI to be used to parse the request and reply documents.
`String`	`getEffectivePassword()` Returns the effective key password.
`String`	`getEffectiveServerURL()` Returns the effective server URL to which the request will be sent.
`boolean`	`getEnableLog()`
`int`	`getEvictThreadSleepTimeMs()` Specifies time duration in milliseconds between "sweeps" by the "idle connection" evictor thread.
`String`	`getKeyAlias()` If keyAlias not null, return keyAlias, else return merchantId
`File`	`getKeyFile()` Returns a File object representing the key file.
`String`	`getKeyFilename()`
`String`	`getKeyPassword()` If keyPassword not null, return keyPassword, else return merchantId
`String`	`getKeysDirectory()`
`String`	`getLogDirectory()`
`File`	`getLogFile()` Returns a File object representing the log file.
`String`	`getLogFilename()`
`int`	`getLogMaximumSize()`
`boolean`	`getLogSignedData()`
`String`	`getLogString()` Returns a string representation of the properties for logging purposes.
`int`	`getMaxConnections()` Specifies the maximum number of concurrent, active HTTP connections allowed by the resource instance to be opened with the target service.
`int`	`getMaxConnectionsPerRoute()` Specifies the maximum number of concurrent, active HTTP connections allowed by the resource instance to the same host or route.
`int`	`getMaxKeepAliveTimeMs()` Specifies the time duration in milliseconds that a connection can be idle before it is evicted from the pool.
`String`	`getMerchantID()`
`String`	`getNamespaceURI()`
`int`	`getNumberOfRetries()` Getter method for numberOfRetries
`String`	`getPassword()`
`String`	`getProperty(String merchantID, String prop)` Returns the value of the specified property.
`String`	`getProperty(String merchantID, String prop, String defaultVal)` Returns the value of the specified property.
`String`	`getProxyHost()`
`String`	`getProxyPassword()`
`int`	`getProxyPort()`
`String`	`getProxyUser()`
`long`	`getRetryInterval()` Getter method for retryInterval added <=1 check as in previous release(6.2.9 or lower) it was set in seconds.
`boolean`	`getSendToAkamai()`
`boolean`	`getSendToProduction()`
`String`	`getServerURL()`
`int`	`getSocketTimeoutMs()` Specifies the time waiting for data – after establishing the connection; maximum time of inactivity between two data packets.
`String`	`getTargetAPIVersion()`
`int`	`getTimeout()` Deprecated.
`boolean`	`getUseHttpClient()`
`boolean`	`getUseHttpClientWithConnectionPool()`
`boolean`	`getUseSignAndEncrypted()`
`int`	`getValidateAfterInactivityMs()` Defines period of inactivity in milliseconds after which persistent connections must be re-validated prior to being leased to the consumer.
`boolean`	`isAllowRetry()` Getter method for allowRetry
`boolean`	`isCacertEnabled()` Getter method for enableCacert
`boolean`	`isCertificateCacheEnabled()` If this property is set to false then the p12 certificate of a merchant will be reloaded every time a transaction is made
`boolean`	`isCustomHttpClassEnabled()`
`boolean`	`isJdkCertEnabled()` Getter method for enableJdkCert
`boolean`	`isMerchantConfigCacheEnabled()` If this property is set to true (default value is false) it will cache the merchantConfig object based on keyAlias/merchantID If cache enabled is true, for single merchant id, if you change any properties after first initialization, it will not reflect
`boolean`	`isShutdownHookEnabled()` This is to enable shutdown hook in case of httpclient with connection Polling.
`boolean`	`isStaleConnectionCheckEnabled()` It determines whether the stale connection check is to be used.
`boolean`	`retryIfMTIFieldExistEnabled()` retryIfMTIFieldExist If enabled then SDK will retry the transaction in case when connection pooling http client is used and if SDK receives an I/O error/exception, when executing a request over a connection that has been closed at the server side.
`void`	`setAllowRetry(boolean allowRetry)` Setter method for allowRetry

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

- Constructor Detail
  - MerchantConfig
```
public MerchantConfig(Properties _props,
                      String _merchantID)
               throws ConfigException
```
    Parameters:
    
    _props - Properties object to get properties from. May be null, in which case, all properties will be read from the System properties.
    
    _merchantID - merchantID. May be null. If specified, merchant- specific properties will take precedence over the generic ones (i.e. those that do not start with a merchant id prefix). See README for more information.
    
    Throws:
    
    ConfigException - if something is missing of invalid in the configuration.
- Method Detail
  - getUseSignAndEncrypted
```
public boolean getUseSignAndEncrypted()
```
  - getMerchantID
```
public String getMerchantID()
```
  - getKeysDirectory
```
public String getKeysDirectory()
```
    Returns:
    
    String keysDirectory path of p12 files
  - getKeyAlias
```
public String getKeyAlias()
```
    If keyAlias not null, return keyAlias, else return merchantId
    
    Returns:
    
    String
  - getKeyPassword
```
public String getKeyPassword()
```
    If keyPassword not null, return keyPassword, else return merchantId
    
    Returns:
    
    String
  - getSendToProduction
```
public boolean getSendToProduction()
```
  - getSendToAkamai
```
public boolean getSendToAkamai()
```
  - getTargetAPIVersion
```
public String getTargetAPIVersion()
```
  - getKeyFilename
```
public String getKeyFilename()
```
  - getServerURL
```
public String getServerURL()
```
  - getNamespaceURI
```
public String getNamespaceURI()
```
  - getPassword
```
public String getPassword()
```
  - getEnableLog
```
public boolean getEnableLog()
```
  - getLogSignedData
```
public boolean getLogSignedData()
```
  - getLogDirectory
```
public String getLogDirectory()
```
  - getLogFilename
```
public String getLogFilename()
```
  - getLogMaximumSize
```
public int getLogMaximumSize()
```
  - retryIfMTIFieldExistEnabled
```
public boolean retryIfMTIFieldExistEnabled()
```
    retryIfMTIFieldExist If enabled then SDK will retry the transaction in case when connection pooling http client is used and if SDK receives an I/O error/exception, when executing a request over a connection that has been closed at the server side. If not enabled, a transaction may fail(retry wont occur in some cases) if while sending transaction SDK receives an I/O error/exception, when executing a request over a connection that has been closed at the server side.
    
    Returns:
    
    boolean
  - getUseHttpClient
```
public boolean getUseHttpClient()
```
  - getUseHttpClientWithConnectionPool
```
public boolean getUseHttpClientWithConnectionPool()
```
  - getTimeout
```
@Deprecated
public int getTimeout()
```
    Deprecated.
    
    Timeout is set in seconds default is 130seconds And it used as connectionTimeout and SocketTimeout in case of Jdk HttpUrlConnection and Apache's HttpClient.
    
    Returns:
    
    int
  - getMaxConnections
```
public int getMaxConnections()
```
    Specifies the maximum number of concurrent, active HTTP connections allowed by the resource instance to be opened with the target service. There is no default value. For applications that create many long-lived connections, increase the value of this parameter
    
    Returns:
    
    int
  - getDefaultMaxConnectionsPerRoute
```
public int getDefaultMaxConnectionsPerRoute()
```
    the maximum number of connections per (any) route
    
    Returns:
    
    int
  - getMaxConnectionsPerRoute
```
public int getMaxConnectionsPerRoute()
```
    Specifies the maximum number of concurrent, active HTTP connections allowed by the resource instance to the same host or route. In SDK, all above config does same functionality and the same value can be given to these configs as we have only one route. Note: This number cannot be greater than Maximum Total Connections and every connection created here also counts into Maximum Total Connections.
    
    Returns:
    
    int
  - getConnectionRequestTimeoutMs
```
public int getConnectionRequestTimeoutMs()
```
    Time taken in milliseconds to get connection request from the pool. If it times out, it will throw error as Timeout waiting for connection from pool.
    
    Returns:
    
    int
  - getConnectionTimeoutMs
```
public int getConnectionTimeoutMs()
```
    Specifies the number of milliseconds to wait while a connection is being established.
    
    Returns:
    
    int
  - getSocketTimeoutMs
```
public int getSocketTimeoutMs()
```
    Specifies the time waiting for data – after establishing the connection; maximum time of inactivity between two data packets.
    
    Returns:
    
    int
  - getEvictThreadSleepTimeMs
```
public int getEvictThreadSleepTimeMs()
```
    Specifies time duration in milliseconds between "sweeps" by the "idle connection" evictor thread.
    
    Returns:
    
    int
  - getMaxKeepAliveTimeMs
```
public int getMaxKeepAliveTimeMs()
```
    Specifies the time duration in milliseconds that a connection can be idle before it is evicted from the pool.
    
    Returns:
    
    int
  - getValidateAfterInactivityMs
```
public int getValidateAfterInactivityMs()
```
    Defines period of inactivity in milliseconds after which persistent connections must be re-validated prior to being leased to the consumer. Non-positive value passed to this method disables connection validation. This check helps detect connections that have become stale (half-closed) while kept inactive in the pool. By default it is set to 0. This value can be set a positive value, if in case you decide to disable staleConnectionCheckEnabled to get slight better performance. We recommended a value of 2000ms.
    
    Returns:
    
    int
  - getProxyHost
```
public String getProxyHost()
```
  - getProxyPort
```
public int getProxyPort()
```
  - getProxyUser
```
public String getProxyUser()
```
  - getProxyPassword
```
public String getProxyPassword()
```
  - isCertificateCacheEnabled
```
public boolean isCertificateCacheEnabled()
```
    If this property is set to false then the p12 certificate of a merchant will be reloaded every time a transaction is made
    
    Returns:
    
    boolean
  - isMerchantConfigCacheEnabled
```
public boolean isMerchantConfigCacheEnabled()
```
    If this property is set to true (default value is false) it will cache the merchantConfig object based on keyAlias/merchantID If cache enabled is true, for single merchant id, if you change any properties after first initialization, it will not reflect
    
    Returns:
    
    boolean
  - isStaleConnectionCheckEnabled
```
public boolean isStaleConnectionCheckEnabled()
```
    It determines whether the stale connection check is to be used. Disabling the stale connection check can result in slight performance improvement at the risk of getting an I/O error, when executing a request over a connection that has been closed at the server side. By default it is set to true, which means it is enabled.
    
    Returns:
    
    boolean
  - isShutdownHookEnabled
```
public boolean isShutdownHookEnabled()
```
    This is to enable shutdown hook in case of httpclient with connection Polling. ShutdownHook method will call static shutdown api to close connectionManager, httpClient and IdleCleanerThread. By default this is enabled. We should close the connection manager, http client and idle connection cleaner thread when application get shutdown both abruptly and gracefully. If `enabledShutdownHook` is true, then JVM runtime addShutdownHook method will be initialized. Shutdown Hooks are a special construct that allows developers to plug in a piece of code to be executed when the JVM is shutting down. This comes in handy in cases where we need to do special clean-up operations in case the VM is shutting down.
    
    Returns:
    
    boolean
  - getEffectiveServerURL
```
public String getEffectiveServerURL()
```
    Returns the effective server URL to which the request will be sent. If a serverURL is specified, then that is what is returned. Otherwise, the effective server URL is derived from the values of sendToAkamai, sendToProduction and targetAPIVersion.
    
    Returns:
    
    the effective server URL.
  - getEffectiveNamespaceURI
```
public String getEffectiveNamespaceURI()
```
    Returns the effective namespace URI to be used to parse the request and reply documents. If a namespaceURI is specified, then that is what is returned. Otherwise, the effective namespace URI is derived from the value of targetAPIVersion.
    
    Returns:
    
    the effective namespace URI.
  - getEffectivePassword
```
public String getEffectivePassword()
```
    Returns the effective key password. If a password is specified, then that is what is returned. Otherwise, the effective password is the same as the merchantID.
    
    Returns:
    
    the effective key password.
  - getKeyFile
```
public File getKeyFile()
                throws ConfigException
```
    Returns a File object representing the key file. If a keyFilename is specified, that will be the one used. Otherwise, the filename will be derived from the merchantID.
    
    Throws:
    
    ConfigException - if the file is missing, is not a file, or is not readable.
  - getLogFile
```
public File getLogFile()
                throws ConfigException
```
    Returns a File object representing the log file.
    
    Throws:
    
    ConfigException - if the directory specified for the log file is missing or is not a directory.
  - getProperty
```
public String getProperty(String merchantID,
                          String prop)
```
    Returns the value of the specified property. See the other version of this method for the complete behavior.
    
    Parameters:
    
    merchantID - merchant id.
    
    prop - property to search for.
    
    Returns:
    
    the value of the specified property or null if none is found.
  - getProperty
```
public String getProperty(String merchantID,
                          String prop,
                          String defaultVal)
```
    Returns the value of the specified property. The search behavior is as follows:
    1. In the Properties object supplied in the constructor, it looks for the property whose format is "merchantID.prop", e.g. "myMerchant.keysDirectory", unless the merchantID parameter is null, in which case, this step is skipped. If the Properties object is null, this and the second step are skipped.
    2. If it doesn't find one, it looks in the same Properties object for the property without the merchantID prefix, e.g. "keysDirectory".
    3. If it doesn't find one, it repeats steps 1 and 2, but looking in the System properties this time.
    4. If none is found, it returns the default value specified.
    Parameters:
    
    merchantID - merchant id.
    
    prop - property to search for.
    
    defaultVal - default value to return if property is not found (may be null).
    
    Returns:
    
    the value of the specified property or the default value specified if none is found.
  - getLogString
```
public String getLogString()
```
    Returns a string representation of the properties for logging purposes.
    
    Returns:
    
    String
  - getNumberOfRetries
```
public int getNumberOfRetries()
```
    Getter method for numberOfRetries
    
    Returns:
    
    int
  - getRetryInterval
```
public long getRetryInterval()
```
    Getter method for retryInterval added <=1 check as in previous release(6.2.9 or lower) it was set in seconds. User should change retryInterval value to keep it in ms
    
    Returns:
    
    long
  - isAllowRetry
```
public boolean isAllowRetry()
```
    Getter method for allowRetry
    
    Returns:
    
    boolean
  - setAllowRetry
```
public void setAllowRetry(boolean allowRetry)
```
    Setter method for allowRetry
    
    Parameters:
    
    allowRetry -
  - isCacertEnabled
```
public boolean isCacertEnabled()
```
    Getter method for enableCacert
    
    Returns:
    
    boolean
  - isJdkCertEnabled
```
public boolean isJdkCertEnabled()
```
    Getter method for enableJdkCert
    
    Returns:
    
    boolean
  - getCacertPassword
```
public String getCacertPassword()
```
    Getter method for cacertPassword
    
    Returns:
    
    String
  - getCustomHttpClass
```
public String getCustomHttpClass()
```
  - isCustomHttpClassEnabled
```
public boolean isCustomHttpClassEnabled()
```

Class MerchantConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MerchantConfig

Method Detail

getUseSignAndEncrypted

getMerchantID

getKeysDirectory

getKeyAlias

getKeyPassword

getSendToProduction

getSendToAkamai

getTargetAPIVersion

getKeyFilename

getServerURL

getNamespaceURI

getPassword

getEnableLog

getLogSignedData

getLogDirectory

getLogFilename

getLogMaximumSize

retryIfMTIFieldExistEnabled

getUseHttpClient

getUseHttpClientWithConnectionPool

getTimeout

getMaxConnections

getDefaultMaxConnectionsPerRoute

getMaxConnectionsPerRoute

getConnectionRequestTimeoutMs

getConnectionTimeoutMs

getSocketTimeoutMs

getEvictThreadSleepTimeMs

getMaxKeepAliveTimeMs

getValidateAfterInactivityMs

getProxyHost

getProxyPort

getProxyUser

getProxyPassword

isCertificateCacheEnabled

isMerchantConfigCacheEnabled

isStaleConnectionCheckEnabled

isShutdownHookEnabled

getEffectiveServerURL

getEffectiveNamespaceURI

getEffectivePassword

getKeyFile

getLogFile

getProperty

getProperty

getLogString

getNumberOfRetries

getRetryInterval

isAllowRetry

setAllowRetry

isCacertEnabled

isJdkCertEnabled

getCacertPassword

getCustomHttpClass

isCustomHttpClassEnabled