com.pcloud.networking.client

Class PCloudAPIClient

java.lang.Object

com.pcloud.networking.client.PCloudAPIClient

public class PCloudAPIClient
extends java.lang.Object

An implementation of a client used to make network calls

Used to produce Call and MultiCall objects to make network requests to the server

See Also:

MultiCall, Call, Request, Response, MultiResponse, RequestInterceptor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PCloudAPIClient.Builder Builds instances of the PCloudAPIClient and allows different properties to be set as needed

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.ExecutorService	callExecutor() Returns the ExecutorService for this client
ConnectionPool	connectionPool() Returns the ConnectionPool for this client
int	connectTimeout() Returns the maximum amount of time a connection should take to establish itself in milliseconds as an int
EndpointProvider	endpointProvider() Get the EndpointProvider set for this client instance
javax.net.ssl.HostnameVerifier	hostnameVerifier() Returns the HostnameVerifier for this client
java.util.List<RequestInterceptor>	interceptors() Returns a List of RequestInterceptor for this client
PCloudAPIClient.Builder	newBuilder() Returns a new PCloudAPIClient.Builder to construct the PCloudAPIClient
MultiCall	newCall(java.util.Collection<Request> requests) Produces a new instance of a MultiCall object to make multiple network calls efficiently.
MultiCall	newCall(java.util.Collection<Request> requests, Endpoint endpoint) Produces a new instance of a MultiCall object to make multiple network calls efficiently.
Call	newCall(Request request) Produces a new instance of a Call object to make a network call
ApiChannel	newChannel() Create a new ApiChannel for a given Endpoint.
ApiChannel	newChannel(Endpoint endpoint) Create a new ApiChannel for a given Endpoint.
static PCloudAPIClient.Builder	newClient() Create a new PCloudAPIClient.Builder instance
int	readTimeout() Returns the read timeout in milliseconds
void	shutdown() Shuts down the client clearing up resources such as idle connections
javax.net.SocketFactory	socketFactory() Returns the SocketFactory for of this client
javax.net.ssl.SSLSocketFactory	sslSocketFactory() Returns the SSLSocketFactory for this client
int	writeTimeout() Returns the write timeout in milliseconds

Methods inherited from class java.lang.Object

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

Method Detail

newCall

public Call newCall(Request request)

Produces a new instance of a Call object to make a network call

The returned Call object will send the request to the Endpoint returned by Request.endpoint() or if null, it will send to the endpoint returned from this PCloudAPIClient instance's EndpointProvider at the time of execution.

Parameters:

request - A Request for this call

Returns:

A new instance of a Call object with the specified Request

Throws:

java.lang.IllegalArgumentException - on a null Request argument

newCall

public MultiCall newCall(java.util.Collection<Request> requests)

Produces a new instance of a MultiCall object to make multiple network calls efficiently.

The returned MultiCall instance will batch the provided Request objects and will send them over a single connection, reducing the round-trips and response times.

The batched calls will be sent to the Endpoint returned from this PCloudAPIClient instance's EndpointProvider at the time of execution.

Parameters:

requests - A non-null Collection of Request

Returns:

A new instance of a MultiCall object with the specified requests

Throws:

java.lang.IllegalArgumentException - on a null Collection, on an empty Collection, on a Collection containing null elements

newCall

public MultiCall newCall(java.util.Collection<Request> requests,
                         Endpoint endpoint)

Produces a new instance of a MultiCall object to make multiple network calls efficiently.

The returned MultiCall instance will batch the provided Request objects and will send them over a single connection, reducing the round-trips and response times.

The batched calls will be sent to the provided Endpoint.

Parameters:

requests - A non-null Collection of Request

endpoint - A target Endpoint for the MultiCall

Returns:

A new instance of a MultiCall object with the specified requests

Throws:

java.lang.IllegalArgumentException - on a null Collection, on an empty Collection, on a Collection containing null elements

newChannel

public ApiChannel newChannel()
                      throws java.io.IOException

Create a new ApiChannel for a given Endpoint.

Same as calling newChannel(Endpoint) with the endpoint returned by this client's EndpointProvider instance.

Returns:

a non-null ApiChannel instance

Throws:

java.io.IOException - on a connection error

See Also:

ApiChannel, newChannel(Endpoint), EndpointProvider

newChannel

public ApiChannel newChannel(Endpoint endpoint)
                      throws java.io.IOException

Create a new ApiChannel for a given Endpoint.

The call will create and initialize an ApiChannel instance to a given endpoint, or throw an IOException on error.

Parameters:

endpoint - a target Endpoint

Returns:

a non-null ApiChannel instance

Throws:

java.io.IOException - on a connection error

See Also:

ApiChannel

connectTimeout

public int connectTimeout()

Returns the maximum amount of time a connection should take to establish itself in milliseconds as an int

Returns:

The maximum amount of time a connection should take to establish itself in milliseconds as an int

writeTimeout

public int writeTimeout()

Returns the write timeout in milliseconds

Returns:

The write timeout in milliseconds

readTimeout

public int readTimeout()

Returns the read timeout in milliseconds

Returns:

The read timeout in milliseconds

socketFactory

public javax.net.SocketFactory socketFactory()

Returns the SocketFactory for of this client

Returns:

The SocketFactory for this client

sslSocketFactory

public javax.net.ssl.SSLSocketFactory sslSocketFactory()

Returns the SSLSocketFactory for this client

Returns:

The SSLSocketFactory for this client

hostnameVerifier

public javax.net.ssl.HostnameVerifier hostnameVerifier()

Returns the HostnameVerifier for this client

Returns:

The HostnameVerifier for this client

connectionPool

public ConnectionPool connectionPool()

Returns the ConnectionPool for this client

Returns:

The ConnectionPool for this client

callExecutor

public java.util.concurrent.ExecutorService callExecutor()

Returns the ExecutorService for this client

Returns:

The ExecutorService for this client

interceptors

public java.util.List<RequestInterceptor> interceptors()

Returns a List of RequestInterceptor for this client

Returns:

A List of RequestInterceptor for this client

endpointProvider

public EndpointProvider endpointProvider()

Get the EndpointProvider set for this client instance

This will return the EndpointProvider instance given in endpointProvider() or EndpointProvider.DEFAULT if none has been set.

Returns:

A non-null EndpointProvider object

shutdown

public void shutdown()

Shuts down the client clearing up resources such as idle connections

newBuilder

public PCloudAPIClient.Builder newBuilder()

Returns a new PCloudAPIClient.Builder to construct the PCloudAPIClient

Returns:

A new PCloudAPIClient.Builder to construct the PCloudAPIClient

newClient

public static PCloudAPIClient.Builder newClient()

Create a new PCloudAPIClient.Builder instance

Use this method to start configuring a new PCloudAPIClient instance.

Returns:

a new PCloudAPIClient.Builder instance