org.apache.ignite.configuration

Class ClientConnectorConfiguration

java.lang.Object

org.apache.ignite.configuration.ClientConnectorConfiguration

Direct Known Subclasses:

ClientConnectorConfigurationEx

public class ClientConnectorConfiguration
extends Object

Client connector configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DFLT_IDLE_TIMEOUT Default idle timeout.
static int	DFLT_MAX_OPEN_CURSORS_PER_CONN Default max number of open cursors per connection.
static int	DFLT_PORT Default port.
static int	DFLT_PORT_RANGE Default port range.
static int	DFLT_SOCK_BUF_SIZE Default socket send and receive buffer size.
static boolean	DFLT_TCP_NO_DELAY Default value for TCP_NODELAY socket option (value is true).
static int	DFLT_THREAD_POOL_SIZE Default size of thread pool.

Constructor Summary

Constructors

Constructor and Description
ClientConnectorConfiguration() Creates SQL connector configuration with all default values.
ClientConnectorConfiguration(ClientConnectorConfiguration cfg) Creates SQL connector configuration by copying all properties from given configuration.

Method Summary

Modifier and Type	Method and Description
String	getHost() Get host.
long	getIdleTimeout() Gets idle timeout for client connections.
int	getMaxOpenCursorsPerConnection() Gets maximum number of opened cursors per connection.
int	getPort() Get port.
int	getPortRange() Get port range.
int	getSocketReceiveBufferSize() Gets socket receive buffer size.
int	getSocketSendBufferSize() Gets socket send buffer size.
int	getThreadPoolSize() Size of thread pool that is in charge of processing SQL requests.
boolean	isJdbcEnabled() Gets whether access through JDBC is enabled.
boolean	isOdbcEnabled() Gets whether access through ODBC is enabled.
boolean	isTcpNoDelay() Get TCP NO_DELAY flag.
boolean	isThinClientEnabled() Gets whether access through thin client is enabled.
ClientConnectorConfiguration	setHost(String host) Set host.
ClientConnectorConfiguration	setIdleTimeout(long idleTimeout) Sets idle timeout for client connections.
ClientConnectorConfiguration	setJdbcEnabled(boolean jdbcEnabled) Sets whether access through JDBC is enabled.
ClientConnectorConfiguration	setMaxOpenCursorsPerConnection(int maxOpenCursorsPerConn) Sets maximum number of opened cursors per connection.
ClientConnectorConfiguration	setOdbcEnabled(boolean odbcEnabled) Sets whether access through ODBC is enabled.
ClientConnectorConfiguration	setPort(int port) Set port.
ClientConnectorConfiguration	setPortRange(int portRange) Set port range.
ClientConnectorConfiguration	setSocketReceiveBufferSize(int sockRcvBufSize) Sets socket receive buffer size.
ClientConnectorConfiguration	setSocketSendBufferSize(int sockSndBufSize) Sets socket send buffer size.
ClientConnectorConfiguration	setTcpNoDelay(boolean tcpNoDelay) Set TCP NO_DELAY flag.
ClientConnectorConfiguration	setThinClientEnabled(boolean thinCliEnabled) Sets whether access through thin client is enabled.
ClientConnectorConfiguration	setThreadPoolSize(int threadPoolSize) Sets thread pool that is in charge of processing SQL requests.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DFLT_PORT

public static final int DFLT_PORT

Default port.

See Also:

Constant Field Values

DFLT_PORT_RANGE

public static final int DFLT_PORT_RANGE

Default port range.

See Also:

Constant Field Values

DFLT_SOCK_BUF_SIZE

public static final int DFLT_SOCK_BUF_SIZE

Default socket send and receive buffer size.

See Also:

Constant Field Values

DFLT_TCP_NO_DELAY

public static final boolean DFLT_TCP_NO_DELAY

Default value for TCP_NODELAY socket option (value is true).

See Also:

Constant Field Values

DFLT_MAX_OPEN_CURSORS_PER_CONN

public static final int DFLT_MAX_OPEN_CURSORS_PER_CONN

Default max number of open cursors per connection.

See Also:

Constant Field Values

DFLT_THREAD_POOL_SIZE

public static final int DFLT_THREAD_POOL_SIZE

Default size of thread pool.

DFLT_IDLE_TIMEOUT

public static final int DFLT_IDLE_TIMEOUT

Default idle timeout.

See Also:

Constant Field Values

Constructor Detail

ClientConnectorConfiguration

public ClientConnectorConfiguration()

Creates SQL connector configuration with all default values.

ClientConnectorConfiguration

public ClientConnectorConfiguration(ClientConnectorConfiguration cfg)

Creates SQL connector configuration by copying all properties from given configuration.

Parameters:

cfg - Configuration to copy.

Method Detail

getHost

@Nullable
public String getHost()

Get host.

Returns:

Host.

setHost

public ClientConnectorConfiguration setHost(@Nullable
                                            String host)

Set host.

Parameters:

host - Host.

Returns:

This instance for chaining.

getPort

public int getPort()

Get port.

Returns:

Port.

setPort

public ClientConnectorConfiguration setPort(int port)

Set port.

Parameters:

port - Port.

Returns:

This instance for chaining.

getPortRange

public int getPortRange()

Get port range.

Returns:

Port range.

setPortRange

public ClientConnectorConfiguration setPortRange(int portRange)

Set port range.

Parameters:

portRange - Port range.

Returns:

This instance for chaining.

getSocketSendBufferSize

public int getSocketSendBufferSize()

Gets socket send buffer size. When set to zero, operation system default will be used.

Defaults to DFLT_SOCK_BUF_SIZE

Returns:

Socket send buffer size in bytes.

setSocketSendBufferSize

public ClientConnectorConfiguration setSocketSendBufferSize(int sockSndBufSize)

Sets socket send buffer size. See getSocketSendBufferSize() for more information.

Parameters:

sockSndBufSize - Socket send buffer size in bytes.

Returns:

This instance for chaining.

getSocketReceiveBufferSize

public int getSocketReceiveBufferSize()

Gets socket receive buffer size. When set to zero, operation system default will be used.

Defaults to DFLT_SOCK_BUF_SIZE.

Returns:

Socket receive buffer size in bytes.

setSocketReceiveBufferSize

public ClientConnectorConfiguration setSocketReceiveBufferSize(int sockRcvBufSize)

Sets socket receive buffer size. See getSocketReceiveBufferSize() for more information.

Parameters:

sockRcvBufSize - Socket receive buffer size in bytes.

Returns:

This instance for chaining.

isTcpNoDelay

public boolean isTcpNoDelay()

Get TCP NO_DELAY flag.

Returns:

TCP NO_DELAY flag.

setTcpNoDelay

public ClientConnectorConfiguration setTcpNoDelay(boolean tcpNoDelay)

Set TCP NO_DELAY flag.

Parameters:

tcpNoDelay - TCP NO_DELAY flag.

Returns:

This instance for chaining.

getMaxOpenCursorsPerConnection

public int getMaxOpenCursorsPerConnection()

Gets maximum number of opened cursors per connection.

Defaults to DFLT_MAX_OPEN_CURSORS_PER_CONN.

Returns:

Maximum number of opened cursors.

setMaxOpenCursorsPerConnection

public ClientConnectorConfiguration setMaxOpenCursorsPerConnection(int maxOpenCursorsPerConn)

Sets maximum number of opened cursors per connection.

Parameters:

maxOpenCursorsPerConn - Maximum number of opened cursors.

Returns:

This instance for chaining.

getThreadPoolSize

public int getThreadPoolSize()

Size of thread pool that is in charge of processing SQL requests.

Defaults DFLT_THREAD_POOL_SIZE.

Returns:

Thread pool that is in charge of processing SQL requests.

setThreadPoolSize

public ClientConnectorConfiguration setThreadPoolSize(int threadPoolSize)

Sets thread pool that is in charge of processing SQL requests. See getThreadPoolSize() for more information.

Parameters:

threadPoolSize - Thread pool that is in charge of processing SQL requests.

Returns:

This instance for chaining.

getIdleTimeout

public long getIdleTimeout()

Gets idle timeout for client connections. If no packets come within idle timeout, the connection is closed. Zero or negative means no timeout.

Returns:

Idle timeout in milliseconds.

setIdleTimeout

public ClientConnectorConfiguration setIdleTimeout(long idleTimeout)

Sets idle timeout for client connections. If no packets come within idle timeout, the connection is closed. Zero or negative means no timeout.

Parameters:

idleTimeout - Idle timeout in milliseconds.

Returns:

this for chaining.

See Also:

getIdleTimeout()

isJdbcEnabled

public boolean isJdbcEnabled()

Gets whether access through JDBC is enabled.

Defaults to true.

Returns:

Whether access through JDBC is enabled.

setJdbcEnabled

public ClientConnectorConfiguration setJdbcEnabled(boolean jdbcEnabled)

Sets whether access through JDBC is enabled.

Defaults to true.

Parameters:

jdbcEnabled - Whether access through JDBC is enabled.

Returns:

this for chaining.

isOdbcEnabled

public boolean isOdbcEnabled()

Gets whether access through ODBC is enabled.

Defaults to true.

Returns:

Whether access through ODBC is enabled.

setOdbcEnabled

public ClientConnectorConfiguration setOdbcEnabled(boolean odbcEnabled)

Sets whether access through ODBC is enabled.

Defaults to true.

Parameters:

odbcEnabled - Whether access through ODBC is enabled.

Returns:

this for chaining.

isThinClientEnabled

public boolean isThinClientEnabled()

Gets whether access through thin client is enabled.

Defaults to true.

Returns:

Whether access through thin client is enabled.

setThinClientEnabled

public ClientConnectorConfiguration setThinClientEnabled(boolean thinCliEnabled)

Sets whether access through thin client is enabled.

Defaults to true.

Parameters:

thinCliEnabled - Whether access through thin client is enabled.

Returns:

this for chaining.

toString

public String toString()

Overrides:

toString in class Object