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
GPUdbBase.Options()

Method Summary

Methods

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.
ExecutorService	getExecutor() Gets the executor service used for managing threads during data encoding and decoding operations.
Map<String,String>	getHttpHeaders() Gets the map of additional HTTP headers to send to GPUdb with each request.
String	getPassword() Gets the password to be used for authentication to GPUdb.
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	setExecutor(ExecutorService value) Sets the executor service used for managing threads during data encoding and decoding operations.
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	setPassword(String value) Sets the password to be used for authentication to GPUdb.
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

GPUdbBase.Options

public GPUdbBase.Options()

Method Detail

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)

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)

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)

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()

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)

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()