com.worldline.connect.sdk.java

Class Client

java.lang.Object

com.worldline.connect.sdk.java.ApiResource

com.worldline.connect.sdk.java.Client

All Implemented Interfaces:

LoggingCapable, ObfuscationCapable, Closeable, AutoCloseable

public class Client
extends ApiResource
implements Closeable, LoggingCapable, ObfuscationCapable

Worldline Global Collect 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.

Field Summary

Fields inherited from class com.worldline.connect.sdk.java.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.
void	setBodyObfuscator(BodyObfuscator bodyObfuscator) Sets the current non-null body obfuscator to use.
void	setHeaderObfuscator(HeaderObfuscator headerObfuscator) Sets the current non-null header obfuscator to use.
V1Client	v1()
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.worldline.connect.sdk.java.ApiResource

getClientHeaders, instantiateUri

Methods inherited from class java.lang.Object

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

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.

Parameters:

clientMetaInfo - JSON string containing the meta data for the client

Throws:

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

closeIdleConnections

public 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

public void closeExpiredConnections()

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

See Also:

Communicator.closeExpiredConnections(), PooledConnection.closeExpiredConnections()

setBodyObfuscator

public void setBodyObfuscator(BodyObfuscator bodyObfuscator)

Description copied from interface: ObfuscationCapable

Sets the current non-null body obfuscator to use.

Specified by:

setBodyObfuscator in interface ObfuscationCapable

setHeaderObfuscator

public void setHeaderObfuscator(HeaderObfuscator headerObfuscator)

Description copied from interface: ObfuscationCapable

Sets the current non-null header obfuscator to use.

Specified by:

setHeaderObfuscator in interface ObfuscationCapable

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

v1

public V1Client v1()