com.gpudb

Class GPUdbBase.Options

java.lang.Object

com.gpudb.GPUdbBase.Options

Enclosing class:

GPUdbBase

public static final class GPUdbBase.Options
extends Object

A set of configurable options for the GPUdb API. May be passed into the GPUdb constructor to override the default options.

Constructor Summary

Constructors

Constructor and Description
Options()

Method Summary

Modifier and Type	Method and Description
GPUdbBase.Options	addHttpHeader(String header, String value) Adds an HTTP header to the map of additional HTTP headers to send to GPUdb with each request.
boolean	getBypassSslCertCheck() Gets the value of the flag indicating whether to verify the SSL certificate for HTTPS connections.
int	getConnectionInactivityValidationTimeout() Gets the period of inactivity (in milliseconds) after which connection validity would be checked before reusing it.
ExecutorService	getExecutor() Gets the executor service used for managing threads during data encoding and decoding operations.
int	getHostManagerPort() Gets the host manager port number.
Map<String,String>	getHttpHeaders() Gets the map of additional HTTP headers to send to GPUdb with each request.
int	getMaxConnectionsPerHost() Gets the maximum number of connections, per host, allowed at any given time.
int	getMaxTotalConnections() Gets the maximum number of connections, across all hosts, allowed at any given time.
String	getPassword() Gets the password to be used for authentication to GPUdb.
String	getPrimaryUrl() Gets the URL of the primary cluster of the HA environment.
int	getServerConnectionTimeout() Gets the server connection timeout value, in milliseconds, after which an inability to establish a connection with the GPUdb server will result in requests being aborted.
int	getThreadCount() Gets the number of threads that will be used during data encoding and decoding operations.
int	getTimeout() Gets the timeout value, in milliseconds, after which a lack of response from the GPUdb server will result in requests being aborted.
String	getUsername() Gets the username to be used for authentication to GPUdb.
boolean	getUseSnappy() Gets the value of the flag indicating whether to use Snappy compression for certain GPUdb requests that potentially submit large amounts of data.
GPUdbBase.Options	setBypassSslCertCheck(boolean value) Sets the flag indicating whether to verify the SSL certificate for HTTPS connections.
GPUdbBase.Options	setConnectionInactivityValidationTimeout(int value) Sets the period of inactivity (in milliseconds) after which connection validity would be checked before reusing it.
GPUdbBase.Options	setExecutor(ExecutorService value) Sets the executor service used for managing threads during data encoding and decoding operations.
GPUdbBase.Options	setHostManagerPort(int value) Sets the host manager port number.
GPUdbBase.Options	setHttpHeaders(Map<String,String> value) Replaces the contents of the map of additional HTTP headers to send to GPUdb with each request with the contents of the specified map.
GPUdbBase.Options	setMaxConnectionsPerHost(int value) Sets the maximum number of connections, per host, allowed at any given time.
GPUdbBase.Options	setMaxTotalConnections(int value) Sets the maximum number of connections, across all hosts, allowed at any given time.
GPUdbBase.Options	setPassword(String value) Sets the password to be used for authentication to GPUdb.
GPUdbBase.Options	setPrimaryUrl(String value) Sets the URL of the primary cluster to use amongst the HA clusters.
GPUdbBase.Options	setServerConnectionTimeout(int value) Sets the server connection timeout value, in milliseconds, after which an inability to establish a connection with the GPUdb server will result in requests being aborted.
GPUdbBase.Options	setThreadCount(int value) Sets the number of threads that will be used during data encoding and decoding operations.
GPUdbBase.Options	setTimeout(int value) Sets the timeout value, in milliseconds, after which a lack of response from the GPUdb server will result in requests being aborted.
GPUdbBase.Options	setUsername(String value) Sets the username to be used for authentication to GPUdb.
GPUdbBase.Options	setUseSnappy(boolean value) Sets the flag indicating whether to use Snappy compression for certain GPUdb requests that potentially submit large amounts of data.

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options()

Method Detail

getPrimaryUrl

public String getPrimaryUrl()

Gets the URL of the primary cluster of the HA environment.

Returns:

the primary URL

See Also:

setPrimaryUrl(String)

getUsername

public String getUsername()

Gets the username to be used for authentication to GPUdb.

Returns:

the username

See Also:

setUsername(String)

getPassword

public String getPassword()

Gets the password to be used for authentication to GPUdb.

Returns:

the password

See Also:

setPassword(String)

getUseSnappy

public boolean getUseSnappy()

Gets the value of the flag indicating whether to use Snappy compression for certain GPUdb requests that potentially submit large amounts of data.

Returns:

the value of the Snappy compression flag

See Also:

setUseSnappy(boolean)

getBypassSslCertCheck

public boolean getBypassSslCertCheck()

Gets the value of the flag indicating whether to verify the SSL certificate for HTTPS connections.

Returns:

the value of the SSL certificate verification bypass flag

See Also:

setBypassSslCertCheck(boolean)

getThreadCount

public int getThreadCount()

Gets the number of threads that will be used during data encoding and decoding operations.

Returns:

the number of threads

See Also:

setThreadCount(int), setExecutor(ExecutorService)

getExecutor

public ExecutorService getExecutor()

Gets the executor service used for managing threads during data encoding and decoding operations. If null, threads will be created on demand; not used if thread count equals 1.

Returns:

the executor service

See Also:

setExecutor(ExecutorService), setThreadCount(int)

getHttpHeaders

public Map<String,String> getHttpHeaders()

Gets the map of additional HTTP headers to send to GPUdb with each request. If empty, no additional headers will be sent.

Returns:

the map

See Also:

addHttpHeader(String, String), setHttpHeaders(Map)

getHostManagerPort

public int getHostManagerPort()

Gets the host manager port number. Some endpoints are supported only at the host manager, rather than the head node of the database.

Returns:

the host manager port

See Also:

setHostManagerPort(int)

getConnectionInactivityValidationTimeout

public int getConnectionInactivityValidationTimeout()

Gets the period of inactivity (in milliseconds) after which connection validity would be checked before reusing it. This is for fine-tuning server connection parameters. Using the default of 200ms should suffice for most users.

Returns:

the connection inactivity period (in ms)

See Also:

setConnectionInactivityValidationTimeout(int)

getTimeout

public int getTimeout()

Gets the timeout value, in milliseconds, after which a lack of response from the GPUdb server will result in requests being aborted. A timeout of zero is interpreted as an infinite timeout. Note that this applies independently to various stages of communication, so overall a request may run for longer than this without being aborted.

Returns:

the timeout value

See Also:

setTimeout(int), getServerConnectionTimeout()

getServerConnectionTimeout

public int getServerConnectionTimeout()

Gets the server connection timeout value, in milliseconds, after which an inability to establish a connection with the GPUdb server will result in requests being aborted. A timeout of zero is interpreted as an infinite timeout. Note that this is different from the request timeout.

Returns:

the connection timeout value

See Also:

getTimeout(), setServerConnectionTimeout(int)

getMaxTotalConnections

public int getMaxTotalConnections()

Gets the maximum number of connections, across all hosts, allowed at any given time.

Returns:

the maxTotalConnections value

See Also:

setMaxTotalConnections(int)

getMaxConnectionsPerHost

public int getMaxConnectionsPerHost()

Gets the maximum number of connections, per host, allowed at any given time.

Returns:

the maxConnectionsPerHost value

See Also:

setMaxConnectionsPerHost(int)

setPrimaryUrl

public GPUdbBase.Options setPrimaryUrl(String value)

Sets the URL of the primary cluster to use amongst the HA clusters. This cluster will always be used first. It can be part of the URLs used to create the GPUdb object, or be a different one. In either case, this URL will always be chosen first to work against. Also, the GPUdb constructors will ensure that no duplicate of this URL exists in the full set of URLs to use. If this is not set, then all available clusters will be treated with equal probability. Must be given in the form of 'http[s]://X.X.X.X:PORT[/httpd-path]'.

Parameters:

value - the URL of the primary cluster

Returns:

the current GPUdbBase.Options instance

See Also:

getPrimaryUrl()

setUsername

public GPUdbBase.Options setUsername(String value)

Sets the username to be used for authentication to GPUdb. This username will be sent with every GPUdb request made via the API along with the password and may be used for authorization decisions by the server if it is so configured. If both the username and password are null (the default) or empty strings, no authentication will be performed.

Parameters:

value - the username

Returns:

the current GPUdbBase.Options instance

See Also:

getUsername(), setPassword(String)

setPassword

public GPUdbBase.Options setPassword(String value)

Sets the password to be used for authentication to GPUdb. This password will be sent with every GPUdb request made via the API along with the username and may be used for authorization decisions by the server if it is so configured. If both the username and password are null (the default) or empty strings, no authentication will be performed.

Parameters:

value - the password

Returns:

the current GPUdbBase.Options instance

See Also:

getPassword(), setUsername(String)

setUseSnappy

public GPUdbBase.Options setUseSnappy(boolean value)

Sets the flag indicating whether to use Snappy compression for certain GPUdb requests that potentially submit large amounts of data. If true, such requests will be automatically compressed before being sent to the server; the default is false.

Parameters:

value - the new value for the Snappy compression flag

Returns:

the current GPUdbBase.Options instance

See Also:

getUseSnappy()

setBypassSslCertCheck

public GPUdbBase.Options setBypassSslCertCheck(boolean value)

Sets the flag indicating whether to verify the SSL certificate for HTTPS connections. If true, then the SSL certificate sent by the server during HTTPS connection handshake will not be verified; the public key sent by the server will be blindly trusted and used to encrypt the packets. The default is false.

Parameters:

value - the value of the SSL certificate verification bypass flag

Returns:

the current GPUdbBase.Options instance

See Also:

getBypassSslCertCheck()

setThreadCount

public GPUdbBase.Options setThreadCount(int value)

Sets the number of threads that will be used during data encoding and decoding operations. If set to one (the default), all encoding and decoding will be performed in the calling thread. If an executor service is provided, it will be used for thread management, and up to this many operations will be submitted to it at a time for execution. (Note that if the provided executor service supports fewer than this many threads, fewer operations will actually be executed simultaneously.) If no executor service is provided, any required threads will be created on demand.

Parameters:

value - the number of threads

Returns:

the current GPUdbBase.Options instance

Throws:

IllegalArgumentException - if value is less than one

See Also:

getThreadCount(), setExecutor(ExecutorService)

setExecutor

public GPUdbBase.Options setExecutor(ExecutorService value)

Sets the executor service used for managing threads during data encoding and decoding operations. If null, threads will be created on demand; not used if thread count equals 1. If the provided executor service supports fewer threads than the thread count, fewer operations will actually be executed simultaneously.

Parameters:

value - the executor service

Returns:

the current GPUdbBase.Options instance

See Also:

getExecutor(), setThreadCount(int)

setHttpHeaders

public GPUdbBase.Options setHttpHeaders(Map<String,String> value)

Replaces the contents of the map of additional HTTP headers to send to GPUdb with each request with the contents of the specified map. If empty, no additional headers will be sent.

Parameters:

value - the map

Returns:

the current GPUdbBase.Options instance

See Also:

addHttpHeader(String, String), getHttpHeaders()

addHttpHeader

public GPUdbBase.Options addHttpHeader(String header,
                                       String value)

Adds an HTTP header to the map of additional HTTP headers to send to GPUdb with each request. If the header is already in the map, its value is replaced with the specified value.

Parameters:

header - the HTTP header

value - the value of the HTTP header

Returns:

the current GPUdbBase.Options instance

See Also:

getHttpHeaders(), setHttpHeaders(Map)

setHostManagerPort

public GPUdbBase.Options setHostManagerPort(int value)

Sets the host manager port number. Some endpoints are supported only at the host manager, rather than the head node of the database.

Parameters:

value - the host manager port number

Returns:

the current GPUdbBase.Options instance

See Also:

getHostManagerPort()

setTimeout

public GPUdbBase.Options setTimeout(int value)

Sets the timeout value, in milliseconds, after which a lack of response from the GPUdb server will result in requests being aborted. A timeout of zero is interpreted as an infinite timeout. Note that this applies independently to various stages of communication, so overall a request may run for longer than this without being aborted.

Parameters:

value - the timeout value

Returns:

the current GPUdbBase.Options instance

See Also:

getTimeout()

setServerConnectionTimeout

public GPUdbBase.Options setServerConnectionTimeout(int value)

Sets the server connection timeout value, in milliseconds, after which an inability to establish a connection with the GPUdb server will result in requests being aborted. A timeout of zero is interpreted as an infinite timeout. Note that this is different from the request The default is 10000, which is equivalent to 10 seconds.

Parameters:

value - the server connection timeout value

Returns:

the current GPUdbBase.Options instance

See Also:

getServerConnectionTimeout()

setConnectionInactivityValidationTimeout

public GPUdbBase.Options setConnectionInactivityValidationTimeout(int value)

Sets the period of inactivity (in milliseconds) after which connection validity would be checked before reusing it. This is for fine-tuning server connection parameters. Using the default of 200ms should suffice for most users. The default is 200 (in milliseconds). *Note*: Non-positive value passed to this method disables connection validation. So, use with great caution!

Parameters:

value - the connection inactivity timeout (in ms)

Returns:

the current GPUdbBase.Options instance

See Also:

getServerConnectionTimeout()

setMaxTotalConnections

public GPUdbBase.Options setMaxTotalConnections(int value)

Sets the maximum number of connections, across all hosts, allowed at any given time. Must be 1 at a minimum. The default value is 40.

Parameters:

value - the maxTotalConnections value

Returns:

the current GPUdbBase.Options instance

See Also:

getMaxTotalConnections()

setMaxConnectionsPerHost

public GPUdbBase.Options setMaxConnectionsPerHost(int value)

Sets the maximum number of connections, per host, allowed at any given time. Must be 1 at a minimum. The default value is 10.

Parameters:

value - the maxConnectionsPerHost value

Returns:

the current GPUdbBase.Options instance

See Also:

getMaxConnectionsPerHost()