com.hds.hcpaw.fss.api

Class AnywhereAPI.Builder

java.lang.Object

com.hds.hcpaw.fss.api.AnywhereAPI.Builder

Enclosing class:

AnywhereAPI

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

Builds an instance of an AnywhereAPI. The Builder provides all the options for customizing the AnywhereAPI as you see fit.

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String serverUrl) Constructs a Builder, setting the initial value of the server to the specified value.

Method Summary

Modifier and Type	Method and Description
AnywhereAPI	build() Generates an AnywhereAPI with the configured parameters.
AnywhereAPI.Builder	insecureSSL() Indicates that all SSL connections should be trusted.
AnywhereAPI.Builder	keepAliveDuration(long keepAliveDuration, java.util.concurrent.TimeUnit timeUnit) Sets the amount of time a connection remains idle before closing.
AnywhereAPI.Builder	maxIdleConnections(int maxIdleConnections) Sets the maximum number of idle connections for this connector.
AnywhereAPI.Builder	proxy(java.net.Proxy proxy) Sets the proxy to use.
AnywhereAPI.Builder	proxy(java.lang.String hostname, int port) Sets the proxy to use, based on the provided hostname and port.
AnywhereAPI.Builder	readTimeoutDuration(long readTimeoutDuration, java.util.concurrent.TimeUnit timeUnit) Sets the amount of time to wait between bytes read before timing out
AnywhereAPI.Builder	server(java.lang.String server) Updates the server URL.
AnywhereAPI.Builder	skipHostnameVerification() Do not perform hostname verification against the certificate returned by the server
AnywhereAPI.Builder	useCertificateChain(java.security.cert.X509Certificate[] certChain) Identifies the certChain that will be used to check and authenticate SSL certificates once a connection to HCP Anywhere has been established.
AnywhereAPI.Builder	useKeyStore(java.security.KeyStore keyStore) Identifies the KeyStore that will be used to check and authenticate SSL certificates once a connection to HCP Anywhere has been established.
AnywhereAPI.Builder	useSSLContext(javax.net.ssl.SSLContext sslContext) Identifies the SSLContext that will be used to check for and authenticate SSL certificates
AnywhereAPI.Builder	writeTimeoutDuration(long writeTimeoutDuration, java.util.concurrent.TimeUnit timeUnit) Sets the amount of time to wait between bytes written before timing out

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(java.lang.String serverUrl)
        throws AnywhereException

Constructs a Builder, setting the initial value of the server to the specified value.

Parameters:

serverUrl - should include the protocol, server hostname or IP, and port if required

Throws:

AnywhereException

Method Detail

build

public AnywhereAPI build()

Generates an AnywhereAPI with the configured parameters.

Returns:

the constructed AnywhereAPI

server

public AnywhereAPI.Builder server(java.lang.String server)
                           throws AnywhereException

Updates the server URL.

Parameters:

server - should include the protocol, server hostname or IP, and port if required.

Returns:

this Builder

Throws:

AnywhereException

maxIdleConnections

public AnywhereAPI.Builder maxIdleConnections(int maxIdleConnections)

Sets the maximum number of idle connections for this connector.

Parameters:

maxIdleConnections - maximum number of idle connections for this connector

Returns:

this Builder

keepAliveDuration

public AnywhereAPI.Builder keepAliveDuration(long keepAliveDuration,
                                             java.util.concurrent.TimeUnit timeUnit)

Sets the amount of time a connection remains idle before closing.

Parameters:

keepAliveDuration - amount of time a connection remains idle before closing

timeUnit - the unit of time (e.g., minutes, hours, etc.)

Returns:

this Builder

useKeyStore

public AnywhereAPI.Builder useKeyStore(java.security.KeyStore keyStore)
                                throws java.security.KeyManagementException,
                                       java.security.NoSuchAlgorithmException,
                                       java.security.KeyStoreException

Identifies the KeyStore that will be used to check and authenticate SSL certificates once a connection to HCP Anywhere has been established.

Parameters:

keyStore - KeyStore to be used to check and authenticate SSL certificates

Returns:

this Builder

Throws:

java.security.KeyManagementException

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

useCertificateChain

public AnywhereAPI.Builder useCertificateChain(java.security.cert.X509Certificate[] certChain)
                                        throws java.security.KeyManagementException,
                                               java.security.NoSuchAlgorithmException,
                                               java.security.KeyStoreException,
                                               java.security.cert.CertificateException,
                                               java.io.IOException

Identifies the certChain that will be used to check and authenticate SSL certificates once a connection to HCP Anywhere has been established.

Parameters:

certChain - certChain to be used to check and authenticate SSL certificates

Returns:

this Builder

Throws:

java.security.KeyManagementException

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.io.IOException

java.security.cert.CertificateException

insecureSSL

public AnywhereAPI.Builder insecureSSL()
                                throws java.security.KeyManagementException,
                                       java.security.NoSuchAlgorithmException

Indicates that all SSL connections should be trusted. This means that there is no SSL security provided by this implementation and therefore should never be used.

Returns:

this Builder

Throws:

java.security.KeyManagementException

java.security.NoSuchAlgorithmException

useSSLContext

public AnywhereAPI.Builder useSSLContext(javax.net.ssl.SSLContext sslContext)
                                  throws java.security.KeyManagementException,
                                         java.security.NoSuchAlgorithmException

Identifies the SSLContext that will be used to check for and authenticate SSL certificates

Parameters:

sslContext - The sslContext used to check and authenticate SSL certificates

Returns:

this Builder

Throws:

java.security.KeyManagementException

java.security.NoSuchAlgorithmException

skipHostnameVerification

public AnywhereAPI.Builder skipHostnameVerification()

Do not perform hostname verification against the certificate returned by the server

Returns:

this Builder

readTimeoutDuration

public AnywhereAPI.Builder readTimeoutDuration(long readTimeoutDuration,
                                               java.util.concurrent.TimeUnit timeUnit)

Sets the amount of time to wait between bytes read before timing out

Parameters:

readTimeoutDuration - The amount of time to wait between bytes read before timing out

timeUnit - the unit of time (e.g., minutes, hours, etc.)

Returns:

this Builder

writeTimeoutDuration

public AnywhereAPI.Builder writeTimeoutDuration(long writeTimeoutDuration,
                                                java.util.concurrent.TimeUnit timeUnit)

Sets the amount of time to wait between bytes written before timing out

Parameters:

writeTimeoutDuration - The amount of time to wait between bytes written before timing out

timeUnit - the unit of time (e.g., minutes, hours, etc.)

Returns:

this Builder

proxy

public AnywhereAPI.Builder proxy(java.lang.String hostname,
                                 int port)

Sets the proxy to use, based on the provided hostname and port. Note that this will replace proxy(Proxy)

Parameters:

hostname - The hostname of the proxy

port - The port of the proxy

Returns:

this Builder

proxy

public AnywhereAPI.Builder proxy(java.net.Proxy proxy)

Sets the proxy to use. Note this will replace proxy(String, int)

Parameters:

proxy - The proxy to use

Returns:

this Builder