Package com.onlinepayments

Interface ClientInterface

All Superinterfaces:

AutoCloseable, Closeable, LoggingCapable, ObfuscationCapable

All Known Implementing Classes:

Client

public interface ClientInterface
extends Closeable, LoggingCapable, ObfuscationCapable

Payment platform client.

This client and all its child clients are bound to one specific value for the X-GCS-ClientMetaInfo header. To get a new client with a different header value, use withClientMetaInfo(String).

Thread-safe.

Method Summary

Modifier and Type	Method	Description
void	closeExpiredConnections()	Utility method that delegates the call to this client's communicator.
void	closeIdleConnections(long idleTime, TimeUnit timeUnit)	Utility method that delegates the call to this client's communicator.
MerchantClientInterface	merchant(String merchantId)	Resource /v2/{merchantId}
ClientInterface	withClientMetaInfo(String clientMetaInfo)	Returns a new ClientInterface instance which uses the passed meta data for the X-GCS-ClientMetaInfo header.

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface com.onlinepayments.logging.LoggingCapable

disableLogging, enableLogging

Methods inherited from interface com.onlinepayments.logging.ObfuscationCapable

setBodyObfuscator, setHeaderObfuscator

Method Details

withClientMetaInfo

ClientInterface withClientMetaInfo(String clientMetaInfo)

Returns a new ClientInterface instance which uses the passed meta data for the X-GCS-ClientMetaInfo header.

Parameters:

clientMetaInfo - JSON string containing the meta data for the client

Throws:

MarshallerSyntaxException - if the given clientMetaInfo is not a valid JSON string

closeIdleConnections

void closeIdleConnections(long idleTime,
 TimeUnit timeUnit)

Utility method that delegates the call to this client's communicator.

See Also:

• Communicator.closeIdleConnections(long, TimeUnit)
• PooledConnection.closeIdleConnections(long, TimeUnit)

closeExpiredConnections

void closeExpiredConnections()

Utility method that delegates the call to this client's communicator.

See Also:

• Communicator.closeExpiredConnections()
• PooledConnection.closeExpiredConnections()

merchant

MerchantClientInterface merchant(String merchantId)

Resource /v2/{merchantId}

Parameters:

merchantId - String

Returns:

MerchantClientInterface