com.spectralogic.ds3client

Class Ds3ClientBuilder

java.lang.Object

com.spectralogic.ds3client.Ds3ClientBuilder

All Implemented Interfaces:

Builder<Ds3Client>

public class Ds3ClientBuilder
extends java.lang.Object
implements Builder<Ds3Client>

A Builder class used to create a Ds3Client instance. This allows you to customize the behavior of a Ds3Client. For instance, the number of times that the Ds3Client instance will perform a 307 redirect before throwing an error can be customized with the withRedirectRetries(int) as well as setting a proxy with withProxy(String).

Method Summary

Modifier and Type	Method and Description
Ds3Client	build() Returns a new Ds3Client instance.
static Ds3ClientBuilder	create(java.lang.String endpoint, Credentials creds) Returns a Builder which is used to customize the behavior of the Ds3Client library.
static Ds3ClientBuilder	fromEnv() Returns a Build which already has the endpoint and credentials populated from environment variables.
Ds3ClientBuilder	withBufferSize(int bufferSizeInBytes)
Ds3ClientBuilder	withCertificateVerification(boolean certificateVerification) Specifies if the library should perform SSL certificate validation.
Ds3ClientBuilder	withConnectionTimeout(int timeoutInMillis) Sets the number of milliseconds to wait for a connection to be established before timing out.
Ds3ClientBuilder	withHttps(boolean secure) Specifies if the library should use HTTP or HTTPS.
Ds3ClientBuilder	withProxy(java.lang.String proxy) Sets a HTTP proxy.
Ds3ClientBuilder	withRedirectRetries(int retries) Sets the number of retries the library will attempt to perform when it receives 307 redirects from a DS3 appliance.
Ds3ClientBuilder	withSocketTimeout(int timeoutInMillis) Sets the number of milliseconds to wait between data packets before timing out a request.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Ds3ClientBuilder create(java.lang.String endpoint,
                                      Credentials creds)

Returns a Builder which is used to customize the behavior of the Ds3Client library.

Parameters:

endpoint - The DS3 endpoint the library should connect to.

creds - The Credentials used for connecting to a DS3 endpoint.

Returns:

The Builder for the Ds3ClientImpl object.

fromEnv

public static Ds3ClientBuilder fromEnv()
                                throws java.lang.IllegalArgumentException

Returns a Build which already has the endpoint and credentials populated from environment variables. DS3_ENDPOINT, DS3_ACCESS_KEY, and DS3_SECRET_KEY are all used when creating the builder. This will also detect if http_proxy is set, and if it is will us it when creating the client and set the proxy variable accordingly.

Returns:

Throws:

java.lang.IllegalArgumentException

withHttps

public Ds3ClientBuilder withHttps(boolean secure)

Specifies if the library should use HTTP or HTTPS. The default is HTTP.

Parameters:

secure - True will use HTTPS, false will use HTTP.

Returns:

The current builder.

withBufferSize

public Ds3ClientBuilder withBufferSize(int bufferSizeInBytes)

Parameters:

bufferSizeInBytes - The size of the buffer to be used when writing content out to DS3.

Returns:

The current builder.

withCertificateVerification

public Ds3ClientBuilder withCertificateVerification(boolean certificateVerification)

Specifies if the library should perform SSL certificate validation.

withProxy

public Ds3ClientBuilder withProxy(java.lang.String proxy)
                           throws java.lang.IllegalArgumentException

Sets a HTTP proxy.

Parameters:

proxy - The endpoint of the HTTP proxy.

Returns:

The current builder.

Throws:

java.lang.IllegalArgumentException - This will be thrown if the proxy endpoint is not a valid URI.

withRedirectRetries

public Ds3ClientBuilder withRedirectRetries(int retries)

Sets the number of retries the library will attempt to perform when it receives 307 redirects from a DS3 appliance. The default is 5.

Parameters:

retries - The number of times the library should perform retries on 307.

Returns:

The current builder.

withConnectionTimeout

public Ds3ClientBuilder withConnectionTimeout(int timeoutInMillis)

Sets the number of milliseconds to wait for a connection to be established before timing out. Default: 5 minutes

withSocketTimeout

public Ds3ClientBuilder withSocketTimeout(int timeoutInMillis)

Sets the number of milliseconds to wait between data packets before timing out a request. Default: 60 minutes

build

public Ds3Client build()

Returns a new Ds3Client instance.

Specified by:

build in interface Builder<Ds3Client>