com.hds.hcpaw.fss.api

Class AnywhereConnector.Builder

java.lang.Object

com.hds.hcpaw.fss.api.AnywhereConnector.Builder

Enclosing class:

AnywhereConnector

protected static class AnywhereConnector.Builder
extends java.lang.Object

Builds an instance of an AnywhereConnector.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	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
protected AnywhereConnector	build() Builds an AnywhereConnector.
protected AnywhereConnector.Builder	insecureSSL() Indicates that all SSL connections should be trusted.
protected AnywhereConnector.Builder	keepAliveDuration(long keepAliveDuration, java.util.concurrent.TimeUnit timeUnit) Sets the amount of time a connection remains idle before closing.
protected AnywhereConnector.Builder	maxIdleConnections(int maxIdleConnections) Sets the maximum number of idle connections for this connector.
protected AnywhereConnector.Builder	proxy(java.net.Proxy proxy) Sets the proxy to use.
protected AnywhereConnector.Builder	proxy(java.lang.String hostname, int port) Sets the proxy to use, based on the provided hostname and port.
protected AnywhereConnector.Builder	readTimeoutDuration(long readTimeoutDuration, java.util.concurrent.TimeUnit timeUnit) Sets the amount of time to wait between bytes read before timing out
protected AnywhereConnector.Builder	server(java.lang.String server) Updates the server URL.
protected AnywhereConnector.Builder	skipHostnameVerification() Do not perform hostname verification against the certificate returned by the server
protected AnywhereConnector.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.
protected AnywhereConnector.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.
protected AnywhereConnector.Builder	useSSLContext(javax.net.ssl.SSLContext sslContext) Identifies the SSLContext that will be used to check for and authenticate SSL certificates
protected AnywhereConnector.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

protected 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

protected AnywhereConnector build()

Builds an AnywhereConnector.

Returns:

an instance of an AnywhereConnector

server

protected AnywhereConnector.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

protected AnywhereConnector.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

protected AnywhereConnector.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

protected AnywhereConnector.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

protected AnywhereConnector.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

protected AnywhereConnector.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

protected AnywhereConnector.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

protected AnywhereConnector.Builder skipHostnameVerification()

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

Returns:

this Builder

readTimeoutDuration

protected AnywhereConnector.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

protected AnywhereConnector.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

protected AnywhereConnector.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

protected AnywhereConnector.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