com.onlinepayments

Class Client

java.lang.Object

com.onlinepayments.ApiResource

com.onlinepayments.Client

All Implemented Interfaces:

ClientInterface, LoggingCapable, Closeable, AutoCloseable

public class Client
extends ApiResource
implements ClientInterface

Base class of all Online Payments platform API resources.

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_VERSION

Fields inherited from class com.onlinepayments.ApiResource

clientMetaInfo, communicator

Constructor Summary

Constructors

Constructor and Description
Client(Communicator communicator)

Method Summary

Modifier and Type	Method and Description
void	close() Releases any system resources associated with this object.
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.
void	disableLogging() Turns off logging.
void	enableLogging(CommunicatorLogger communicatorLogger) Turns on logging using the given communicator logger.
MerchantClient	merchant(String merchantId) Resource /v2/{merchantId}
Client	withClientMetaInfo(String clientMetaInfo) Returns a new Client which uses the passed meta data for the X-GCS-ClientMetaInfo header.

Methods inherited from class com.onlinepayments.ApiResource

createException, getClientHeaders, instantiateUri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

API_VERSION

public static final String API_VERSION

See Also:

Constant Field Values

Constructor Detail

Client

public Client(Communicator communicator)

Method Detail

withClientMetaInfo

public Client withClientMetaInfo(String clientMetaInfo)

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

Specified by:

withClientMetaInfo in interface ClientInterface

Parameters:

clientMetaInfo - JSON string containing the meta data for the client

closeIdleConnections

public void closeIdleConnections(long idleTime,
                                 TimeUnit timeUnit)

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

Specified by:

closeIdleConnections in interface ClientInterface

See Also:

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

closeExpiredConnections

public void closeExpiredConnections()

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

Specified by:

closeExpiredConnections in interface ClientInterface

See Also:

Communicator.closeExpiredConnections(), PooledConnection.closeExpiredConnections()

enableLogging

public void enableLogging(CommunicatorLogger communicatorLogger)

Description copied from interface: LoggingCapable

Turns on logging using the given communicator logger.

Specified by:

enableLogging in interface LoggingCapable

disableLogging

public void disableLogging()

Description copied from interface: LoggingCapable

Turns off logging.

Specified by:

disableLogging in interface LoggingCapable

close

public void close()
           throws IOException

Releases any system resources associated with this object.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

merchant

public MerchantClient merchant(String merchantId)

Resource /v2/{merchantId}

Specified by:

merchant in interface ClientInterface