com.pcloud.networking.client

Class PCloudAPIClient.Builder

java.lang.Object

com.pcloud.networking.client.PCloudAPIClient.Builder

Enclosing class:

PCloudAPIClient

public static class PCloudAPIClient.Builder
extends java.lang.Object

Builds instances of the PCloudAPIClient and allows different properties to be set as needed

Method Summary

Modifier and Type	Method and Description
PCloudAPIClient.Builder	addInterceptor(RequestInterceptor interceptor) Adds a new RequestInterceptor
PCloudAPIClient.Builder	addInterceptorAtFront(RequestInterceptor interceptor) Adds a RequestInterceptor to the front of the List of interceptors
PCloudAPIClient.Builder	addInterceptors(java.util.Collection<RequestInterceptor> interceptors) The same as addInterceptor(RequestInterceptor) but allows adding an entire List of RequestInterceptor
PCloudAPIClient.Builder	callExecutor(java.util.concurrent.ExecutorService executorService) Sets a ExecutorService for the client
PCloudAPIClient.Builder	connectionPool(ConnectionPool connectionPool) Sets a ConnectionPool for the client
PCloudAPIClient	create() Creates the PCloudAPIClient with all the parameters set with the PCloudAPIClient.Builder
PCloudAPIClient.Builder	endpointProvider(EndpointProvider endpointProvider) Sets a EndpointProvider for the client
PCloudAPIClient.Builder	setConnectTimeout(int timeout, java.util.concurrent.TimeUnit timeUnit) Sets the connection timeout duration
PCloudAPIClient.Builder	setHostnameVerifier(javax.net.ssl.HostnameVerifier hostnameVerifier) Sets the HostnameVerifier for the client
PCloudAPIClient.Builder	setReadTimeout(int timeout, java.util.concurrent.TimeUnit timeUnit) Sets the read timeout duration
PCloudAPIClient.Builder	setSocketFactory(javax.net.SocketFactory socketFactory) Sets the SocketFactory for the client
PCloudAPIClient.Builder	setSslSocketFactory(javax.net.ssl.SSLSocketFactory sslSocketFactory) Sets the SSLSocketFactory for the client
PCloudAPIClient.Builder	setWriteTimeout(int timeout, java.util.concurrent.TimeUnit timeUnit) Sets the write timeout duration

Methods inherited from class java.lang.Object

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

Method Detail

addInterceptor

public PCloudAPIClient.Builder addInterceptor(RequestInterceptor interceptor)

Adds a new RequestInterceptor

Parameters:

interceptor - A new RequestInterceptor to be added to the client

Returns:

A reference to the PCloudAPIClient.Builder object

Throws:

java.lang.IllegalArgumentException - on a null RequestInterceptor argument

addInterceptors

public PCloudAPIClient.Builder addInterceptors(java.util.Collection<RequestInterceptor> interceptors)

The same as addInterceptor(RequestInterceptor) but allows adding an entire List of RequestInterceptor

Parameters:

interceptors - A List of RequestInterceptor to be added to the client

Returns:

A reference to the PCloudAPIClient.Builder object

Throws:

java.lang.IllegalArgumentException - on a null Collection or one containing null elements

addInterceptorAtFront

public PCloudAPIClient.Builder addInterceptorAtFront(RequestInterceptor interceptor)

Adds a RequestInterceptor to the front of the List of interceptors

Parameters:

interceptor - A RequestInterceptor to be added to the front of the List

Returns:

A reference to the PCloudAPIClient.Builder object

Throws:

java.lang.IllegalArgumentException - on a null RequestInterceptor

setConnectTimeout

public PCloudAPIClient.Builder setConnectTimeout(int timeout,
                                                 java.util.concurrent.TimeUnit timeUnit)

Sets the connection timeout duration

Parameters:

timeout - The maximum amount of time a connection should take to establish itself

timeUnit - The unit in which you provided the duration argument

Returns:

A reference to the PCloudAPIClient.Builder

Throws:

java.lang.IllegalArgumentException - on a null TimeUnit, 0 or a negative value for the duration argument or a duration argument greater than Integer.MAX_VALUE

setWriteTimeout

public PCloudAPIClient.Builder setWriteTimeout(int timeout,
                                               java.util.concurrent.TimeUnit timeUnit)

Sets the write timeout duration

Parameters:

timeout - The duration for the write timeout

timeUnit - The unit in which you specified the duration argument

Returns:

A reference to the PCloudAPIClient.Builder object

Throws:

java.lang.IllegalArgumentException - on a null TimeUnit, 0 or a negative value for the duration argument or a duration argument greater than Integer.MAX_VALUE

setReadTimeout

public PCloudAPIClient.Builder setReadTimeout(int timeout,
                                              java.util.concurrent.TimeUnit timeUnit)

Sets the read timeout duration

Parameters:

timeout - The duration for the read timeout

timeUnit - The unit in which specified the duration argument

Returns:

A reference to the PCloudAPIClient.Builder object

Throws:

java.lang.IllegalArgumentException - on a null TimeUnit, 0 or a negative value for the duration argument or a duration argument greater than Integer.MAX_VALUE

connectionPool

public PCloudAPIClient.Builder connectionPool(ConnectionPool connectionPool)

Sets a ConnectionPool for the client

Parameters:

connectionPool - A ConnectionPool to be set to the client

Returns:

A reference to the PCloudAPIClient.Builder object

Throws:

java.lang.IllegalArgumentException - on a null ConnectionPool argument

endpointProvider

public PCloudAPIClient.Builder endpointProvider(EndpointProvider endpointProvider)

Sets a EndpointProvider for the client

Parameters:

endpointProvider - A EndpointProvider to be set to the client

Returns:

A reference to the PCloudAPIClient.Builder object

Throws:

java.lang.IllegalArgumentException - on a null EndpointProvider argument

setSocketFactory

public PCloudAPIClient.Builder setSocketFactory(javax.net.SocketFactory socketFactory)

Sets the SocketFactory for the client

Parameters:

socketFactory - The SocketFactory to be set to the client

Returns:

A reference to the PCloudAPIClient.Builder object

Throws:

java.lang.IllegalArgumentException - on a null SocketFactory argument

setSslSocketFactory

public PCloudAPIClient.Builder setSslSocketFactory(javax.net.ssl.SSLSocketFactory sslSocketFactory)

Sets the SSLSocketFactory for the client

Parameters:

sslSocketFactory - The SSLSocketFactory to be set to the client

Returns:

A reference to the PCloudAPIClient.Builder object

Throws:

java.lang.IllegalArgumentException - on a null SSLSocketFactory argument

setHostnameVerifier

public PCloudAPIClient.Builder setHostnameVerifier(javax.net.ssl.HostnameVerifier hostnameVerifier)

Sets the HostnameVerifier for the client

Parameters:

hostnameVerifier - The HostnameVerifier to be set to the client

Returns:

A reference to the PCloudAPIClient.Builder object

Throws:

java.lang.IllegalArgumentException - on a null HostnameVerifier argument

callExecutor

public PCloudAPIClient.Builder callExecutor(java.util.concurrent.ExecutorService executorService)

Sets a ExecutorService for the client

If no executor is provided or this method is called with a null argument a default ExecutorService will be set

Parameters:

executorService - The ExecutorService to be set to the client

Returns:

A reference to the PCloudAPIClient.Builder object

create

public PCloudAPIClient create()

Creates the PCloudAPIClient with all the parameters set with the PCloudAPIClient.Builder

Returns:

A new instance of the PCloudAPIClient with the parameters set via the PCloudAPIClient.Builder