net.quasardb.qdb

Class Session

java.lang.Object

net.quasardb.qdb.Session

All Implemented Interfaces:

AutoCloseable

public class Session
extends Object
implements AutoCloseable

Represents a connection with the QuasarDB cluster. This class is not thread-safe. As instantiations of this class are expensive (especially when secure connections are used), you are encouraged to pool instances of this class are you would do with any other connection pool.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Session.SecurityOptions Optional configuration for establishing a secure connection.

Constructor Summary

Constructors

Constructor and Description
Session() Initialize a new Session without security settings.
Session(Session.SecurityOptions securityOptions) Initialize a new Session with security settings.

Method Summary

Modifier and Type	Method and Description
void	close()
static Session	connect(Session.SecurityOptions options, String uri) Establishes a secure connection
static Session	connect(String uri) Establishes a connection
protected void	finalize()
long	getInputBufferSize() Returns the current input buffer size (in bytes).
long	handle()
boolean	isClosed()
void	setInputBufferSize(long size) Set input buffer size for this session.
void	setTimeout(int timeoutMillis) Set network timeout for this session.
void	throwIfClosed()

Methods inherited from class java.lang.Object

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

Constructor Detail

Session

public Session()

Initialize a new Session without security settings. Connections to the QuasarDB cluster will be insecure and unauthenticated.

Session

public Session(Session.SecurityOptions securityOptions)

Initialize a new Session with security settings. Connections to the QuasarDB will use a secure connection and will be authenticated.

Method Detail

connect

public static Session connect(String uri)

Establishes a connection

Parameters:

uri - Fully qualified quasardb cluster uri, e.g. qdb://127.0.0.1:2836

Returns:

A QuasarDB session

connect

public static Session connect(Session.SecurityOptions options,
                              String uri)

Establishes a secure connection

Parameters:

options - Security options for authenticating with cluster

uri - Fully qualified quasardb cluster uri, e.g. qdb://127.0.0.1:2836

Returns:

A secure QuasarDB session

close

public void close()

Specified by:

close in interface AutoCloseable

isClosed

public boolean isClosed()

throwIfClosed

public void throwIfClosed()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

handle

public long handle()

setTimeout

public void setTimeout(int timeoutMillis)
                throws ClusterClosedException

Set network timeout for this session.

Parameters:

timeoutMillis - The timeout of the operation, in milliseconds

Throws:

ClusterClosedException - If QdbCluster.close() has been called.

setInputBufferSize

public void setInputBufferSize(long size)
                        throws ClusterClosedException

Set input buffer size for this session. Increase this if you encounter InputBufferTooSmallException while retrieving data from the server.

Parameters:

size - The desired size (in bytes) of the input buffer.

Throws:

ClusterClosedException - If the connection to the cluster is currently closed.

getInputBufferSize

public long getInputBufferSize()
                        throws ClusterClosedException

Returns the current input buffer size (in bytes).

Throws:

ClusterClosedException - If the connection to the cluster is currently closed.