org.apache.ignite.internal.jdbc.thin

Class ConnectionPropertiesImpl

java.lang.Object

org.apache.ignite.internal.jdbc.thin.ConnectionPropertiesImpl

All Implemented Interfaces:

Serializable, ConnectionProperties

public class ConnectionPropertiesImpl
extends Object
implements ConnectionProperties, Serializable

Holds JDBC connection properties.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_PREFIX Prefix for property names.

Fields inherited from interface org.apache.ignite.internal.jdbc.thin.ConnectionProperties

SSL_MODE_DISABLE, SSL_MODE_REQUIRE

Constructor Summary

Constructors

Constructor and Description
ConnectionPropertiesImpl()

Method Summary

Modifier and Type	Method and Description
HostAndPortRange[]	getAddresses()
DriverPropertyInfo[]	getDriverPropertyInfo()
String	getPassword()
String	getSchema()
int	getSocketReceiveBuffer()
int	getSocketSendBuffer()
String	getSslClientCertificateKeyStorePassword() Gets key store password.
String	getSslClientCertificateKeyStoreType() Gets key store type used for context creation.
String	getSslClientCertificateKeyStoreUrl() Gets the key store URL.
String	getSslFactory() Gets the class name of the custom implementation of the Factory<SSLSocketFactory>.
String	getSslKeyAlgorithm() Gets algorithm that will be used to create a key manager.
String	getSslMode() Gets SSL connection mode.
String	getSslProtocol() Gets protocol for secure transport.
String	getSslTrustCertificateKeyStorePassword() Gets trust store password.
String	getSslTrustCertificateKeyStoreType() Gets trust store type.
String	getSslTrustCertificateKeyStoreUrl() Gets the trust store URL.
String	getUrl()
String	getUsername()
void	init(String url, Properties props)
boolean	isAutoCloseServerCursor()
boolean	isCollocated()
boolean	isDistributedJoins()
boolean	isEnforceJoinOrder()
boolean	isLazy()
boolean	isReplicatedOnly()
boolean	isSkipReducerOnUpdate()
boolean	isSslTrustAll() Gets trust any server certificate flag.
boolean	isTcpNoDelay()
void	setAddresses(HostAndPortRange[] addrs)
void	setAutoCloseServerCursor(boolean val)
void	setCollocated(boolean val)
void	setDistributedJoins(boolean val)
void	setEnforceJoinOrder(boolean val)
void	setLazy(boolean val)
void	setPassword(String passwd)
void	setReplicatedOnly(boolean val)
void	setSchema(String schema)
void	setSkipReducerOnUpdate(boolean val)
void	setSocketReceiveBuffer(int size)
void	setSocketSendBuffer(int size)
void	setSslClientCertificateKeyStorePassword(String passwd) Sets key store password.
void	setSslClientCertificateKeyStoreType(String ksType) Sets key store type used in context initialization.
void	setSslClientCertificateKeyStoreUrl(String url) Sets path to the key store file.
void	setSslFactory(String sslFactory) Sets the class name of the custom implementation of the Factory<SSLSocketFactory>.
void	setSslKeyAlgorithm(String keyAlgorithm) Sets key manager algorithm that will be used to create a key manager.
void	setSslMode(String mode) Use SSL connection to Ignite node.
void	setSslProtocol(String sslProtocol) Sets protocol for secure transport.
void	setSslTrustAll(boolean trustAll) Sets to true to trust any server certificate (revoked, expired or self-signed SSL certificates).
void	setSslTrustCertificateKeyStorePassword(String passwd) Sets trust store password.
void	setSslTrustCertificateKeyStoreType(String ksType) Sets trust store type.
void	setSslTrustCertificateKeyStoreUrl(String url) Sets path to the trust store file.
void	setTcpNoDelay(boolean val)
void	setUrl(String url)
void	setUsername(String name)

Methods inherited from class java.lang.Object

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

Field Detail

PROP_PREFIX

public static final String PROP_PREFIX

Prefix for property names.

See Also:

Constant Field Values

Constructor Detail

ConnectionPropertiesImpl

public ConnectionPropertiesImpl()

Method Detail

getSchema

public String getSchema()

Specified by:

getSchema in interface ConnectionProperties

Returns:

Schema name of the connection.

setSchema

public void setSchema(String schema)

Specified by:

setSchema in interface ConnectionProperties

Parameters:

schema - Schema name of the connection.

getUrl

public String getUrl()

Specified by:

getUrl in interface ConnectionProperties

Returns:

The URL of the connection.

setUrl

public void setUrl(String url)
            throws SQLException

Specified by:

setUrl in interface ConnectionProperties

Parameters:

url - The URL of the connection.

Throws:

SQLException - On invalid URL.

getAddresses

public HostAndPortRange[] getAddresses()

Specified by:

getAddresses in interface ConnectionProperties

Returns:

Ignite nodes addresses.

setAddresses

public void setAddresses(HostAndPortRange[] addrs)

Specified by:

setAddresses in interface ConnectionProperties

Parameters:

addrs - Ignite nodes addresses.

isDistributedJoins

public boolean isDistributedJoins()

Specified by:

isDistributedJoins in interface ConnectionProperties

Returns:

Distributed joins flag.

setDistributedJoins

public void setDistributedJoins(boolean val)

Specified by:

setDistributedJoins in interface ConnectionProperties

Parameters:

val - Distributed joins flag.

isEnforceJoinOrder

public boolean isEnforceJoinOrder()

Specified by:

isEnforceJoinOrder in interface ConnectionProperties

Returns:

Enforce join order flag.

setEnforceJoinOrder

public void setEnforceJoinOrder(boolean val)

Specified by:

setEnforceJoinOrder in interface ConnectionProperties

Parameters:

val - Enforce join order flag.

isCollocated

public boolean isCollocated()

Specified by:

isCollocated in interface ConnectionProperties

Returns:

Collocated flag.

setCollocated

public void setCollocated(boolean val)

Specified by:

setCollocated in interface ConnectionProperties

Parameters:

val - Collocated flag.

isReplicatedOnly

public boolean isReplicatedOnly()

Specified by:

isReplicatedOnly in interface ConnectionProperties

Returns:

Replicated only flag.

setReplicatedOnly

public void setReplicatedOnly(boolean val)

Specified by:

setReplicatedOnly in interface ConnectionProperties

Parameters:

val - Replicated only flag.

isAutoCloseServerCursor

public boolean isAutoCloseServerCursor()

Specified by:

isAutoCloseServerCursor in interface ConnectionProperties

Returns:

Auto close server cursors flag.

setAutoCloseServerCursor

public void setAutoCloseServerCursor(boolean val)

Specified by:

setAutoCloseServerCursor in interface ConnectionProperties

Parameters:

val - Auto close server cursors flag.

getSocketSendBuffer

public int getSocketSendBuffer()

Specified by:

getSocketSendBuffer in interface ConnectionProperties

Returns:

Socket send buffer size.

setSocketSendBuffer

public void setSocketSendBuffer(int size)
                         throws SQLException

Specified by:

setSocketSendBuffer in interface ConnectionProperties

Parameters:

size - Socket send buffer size.

Throws:

SQLException - On error.

getSocketReceiveBuffer

public int getSocketReceiveBuffer()

Specified by:

getSocketReceiveBuffer in interface ConnectionProperties

Returns:

Socket receive buffer size.

setSocketReceiveBuffer

public void setSocketReceiveBuffer(int size)
                            throws SQLException

Specified by:

setSocketReceiveBuffer in interface ConnectionProperties

Parameters:

size - Socket receive buffer size.

Throws:

SQLException - On error.

isTcpNoDelay

public boolean isTcpNoDelay()

Specified by:

isTcpNoDelay in interface ConnectionProperties

Returns:

TCP no delay flag.

setTcpNoDelay

public void setTcpNoDelay(boolean val)

Specified by:

setTcpNoDelay in interface ConnectionProperties

Parameters:

val - TCP no delay flag.

isLazy

public boolean isLazy()

Specified by:

isLazy in interface ConnectionProperties

Returns:

Lazy query execution flag.

setLazy

public void setLazy(boolean val)

Specified by:

setLazy in interface ConnectionProperties

Parameters:

val - Lazy query execution flag.

isSkipReducerOnUpdate

public boolean isSkipReducerOnUpdate()

Specified by:

isSkipReducerOnUpdate in interface ConnectionProperties

Returns:

Skip reducer on update flag.

setSkipReducerOnUpdate

public void setSkipReducerOnUpdate(boolean val)

Specified by:

setSkipReducerOnUpdate in interface ConnectionProperties

Parameters:

val - Skip reducer on update flag.

getSslMode

public String getSslMode()

Gets SSL connection mode.

Specified by:

getSslMode in interface ConnectionProperties

Returns:

Use SSL flag.

See Also:

ConnectionProperties.setSslMode(String).

setSslMode

public void setSslMode(String mode)

Use SSL connection to Ignite node. In case set to "require" SSL context must be configured. ConnectionProperties.setSslClientCertificateKeyStoreUrl(java.lang.String) property and related properties must be set up or JSSE properties must be set up (see javax.net.ssl.keyStore and other javax.net.ssl.* properties) In case set to "disable" plain connection is used. Available modes: "disable", "require". Default value is "disable"

Specified by:

setSslMode in interface ConnectionProperties

Parameters:

mode - SSL mode.

getSslProtocol

public String getSslProtocol()

Gets protocol for secure transport.

Specified by:

getSslProtocol in interface ConnectionProperties

Returns:

SSL protocol name.

setSslProtocol

public void setSslProtocol(String sslProtocol)

Sets protocol for secure transport. If not specified, TLS protocol will be used. Protocols implementations supplied by JSEE: SSLv3 (SSL), TLSv1 (TLS), TLSv1.1, TLSv1.2

See more at JSSE Reference Guide.

Specified by:

setSslProtocol in interface ConnectionProperties

Parameters:

sslProtocol - SSL protocol name.

getSslKeyAlgorithm

public String getSslKeyAlgorithm()

Gets algorithm that will be used to create a key manager.

Specified by:

getSslKeyAlgorithm in interface ConnectionProperties

Returns:

Key manager algorithm.

setSslKeyAlgorithm

public void setSslKeyAlgorithm(String keyAlgorithm)

Sets key manager algorithm that will be used to create a key manager. Notice that in most cased default value suites well, however, on Android platform this value need to be set to X509. Algorithms implementations supplied by JSEE: PKIX (X509 or SunPKIX), SunX509

See more at JSSE Reference Guide.

Specified by:

setSslKeyAlgorithm in interface ConnectionProperties

Parameters:

keyAlgorithm - Key algorithm name.

getSslClientCertificateKeyStoreUrl

public String getSslClientCertificateKeyStoreUrl()

Gets the key store URL.

Specified by:

getSslClientCertificateKeyStoreUrl in interface ConnectionProperties

Returns:

Client certificate KeyStore URL.

setSslClientCertificateKeyStoreUrl

public void setSslClientCertificateKeyStoreUrl(String url)

Sets path to the key store file. This is a mandatory parameter since ssl context could not be initialized without key manager. In case ConnectionProperties.getSslMode() is required and key store URL isn't specified by Ignite properties (e.g. at JDBC URL) the JSSE property javax.net.ssl.keyStore will be used.

Specified by:

setSslClientCertificateKeyStoreUrl in interface ConnectionProperties

Parameters:

url - Client certificate KeyStore URL.

getSslClientCertificateKeyStorePassword

public String getSslClientCertificateKeyStorePassword()

Gets key store password.

Specified by:

getSslClientCertificateKeyStorePassword in interface ConnectionProperties

Returns:

Client certificate KeyStore password.

setSslClientCertificateKeyStorePassword

public void setSslClientCertificateKeyStorePassword(String passwd)

Sets key store password. In case ConnectionProperties.getSslMode() is required and key store password isn't specified by Ignite properties (e.g. at JDBC URL) the JSSE property javax.net.ssl.keyStorePassword will be used.

Specified by:

setSslClientCertificateKeyStorePassword in interface ConnectionProperties

Parameters:

passwd - Client certificate KeyStore password.

getSslClientCertificateKeyStoreType

public String getSslClientCertificateKeyStoreType()

Gets key store type used for context creation.

Specified by:

getSslClientCertificateKeyStoreType in interface ConnectionProperties

Returns:

Client certificate KeyStore type.

setSslClientCertificateKeyStoreType

public void setSslClientCertificateKeyStoreType(String ksType)

Sets key store type used in context initialization. In case ConnectionProperties.getSslMode() is required and key store type isn't specified by Ignite properties (e.g. at JDBC URL)the JSSE property javax.net.ssl.keyStoreType will be used. In case both Ignite properties and JSSE properties are not set the default 'JKS' type is used.

See more at JSSE Reference Guide.

Specified by:

setSslClientCertificateKeyStoreType in interface ConnectionProperties

Parameters:

ksType - Client certificate KeyStore type.

getSslTrustCertificateKeyStoreUrl

public String getSslTrustCertificateKeyStoreUrl()

Gets the trust store URL.

Specified by:

getSslTrustCertificateKeyStoreUrl in interface ConnectionProperties

Returns:

Trusted certificate KeyStore URL.

setSslTrustCertificateKeyStoreUrl

public void setSslTrustCertificateKeyStoreUrl(String url)

Sets path to the trust store file. This is an optional parameter, however one of the setSslTrustCertificateKeyStoreUrl(String), ConnectionProperties.setSslTrustAll(boolean) properties must be set. In case ConnectionProperties.getSslMode() is required and trust store URL isn't specified by Ignite properties (e.g. at JDBC URL) the JSSE property javax.net.ssl.trustStore will be used.

Specified by:

setSslTrustCertificateKeyStoreUrl in interface ConnectionProperties

Parameters:

url - Trusted certificate KeyStore URL.

getSslTrustCertificateKeyStorePassword

public String getSslTrustCertificateKeyStorePassword()

Gets trust store password.

Specified by:

getSslTrustCertificateKeyStorePassword in interface ConnectionProperties

Returns:

Trusted certificate KeyStore password.

setSslTrustCertificateKeyStorePassword

public void setSslTrustCertificateKeyStorePassword(String passwd)

Sets trust store password. In case ConnectionProperties.getSslMode() is required and trust store password isn't specified by Ignite properties (e.g. at JDBC URL) the JSSE property javax.net.ssl.trustStorePassword will be used.

Specified by:

setSslTrustCertificateKeyStorePassword in interface ConnectionProperties

Parameters:

passwd - Trusted certificate KeyStore password.

getSslTrustCertificateKeyStoreType

public String getSslTrustCertificateKeyStoreType()

Gets trust store type.

Specified by:

getSslTrustCertificateKeyStoreType in interface ConnectionProperties

Returns:

Trusted certificate KeyStore type.

setSslTrustCertificateKeyStoreType

public void setSslTrustCertificateKeyStoreType(String ksType)

Sets trust store type. In case ConnectionProperties.getSslMode() is required and trust store type isn't specified by Ignite properties (e.g. at JDBC URL) the JSSE property javax.net.ssl.trustStoreType will be used. In case both Ignite properties and JSSE properties are not set the default 'JKS' type is used.

Specified by:

setSslTrustCertificateKeyStoreType in interface ConnectionProperties

Parameters:

ksType - Trusted certificate KeyStore type.

isSslTrustAll

public boolean isSslTrustAll()

Gets trust any server certificate flag.

Specified by:

isSslTrustAll in interface ConnectionProperties

Returns:

Trust all certificates flag.

setSslTrustAll

public void setSslTrustAll(boolean trustAll)

Sets to true to trust any server certificate (revoked, expired or self-signed SSL certificates).

Defaults is false. Note: Do not enable this option in production you are ever going to use on a network you do not entirely trust. Especially anything going over the public internet.

Specified by:

setSslTrustAll in interface ConnectionProperties

Parameters:

trustAll - Trust all certificates flag.

getSslFactory

public String getSslFactory()

Gets the class name of the custom implementation of the Factory<SSLSocketFactory>.

Specified by:

getSslFactory in interface ConnectionProperties

Returns:

Custom class name that implements Factory<SSLSocketFactory>.

setSslFactory

public void setSslFactory(String sslFactory)

Sets the class name of the custom implementation of the Factory<SSLSocketFactory>. If ConnectionProperties.getSslMode() is required and factory is specified the custom factory will be used instead of JSSE socket factory. So, other SSL properties will be ignored.

Specified by:

setSslFactory in interface ConnectionProperties

Parameters:

sslFactory - Custom class name that implements Factory<SSLSocketFactory>.

setUsername

public void setUsername(String name)

Specified by:

setUsername in interface ConnectionProperties

Parameters:

name - User name to authentication.

getUsername

public String getUsername()

Specified by:

getUsername in interface ConnectionProperties

Returns:

User name to authentication.

setPassword

public void setPassword(String passwd)

Specified by:

setPassword in interface ConnectionProperties

Parameters:

passwd - User's password.

getPassword

public String getPassword()

Specified by:

getPassword in interface ConnectionProperties

Returns:

User's password.

init

public void init(String url,
                 Properties props)
          throws SQLException

Parameters:

url - URL connection.

props - Environment properties.

Throws:

SQLException - On error.

getDriverPropertyInfo

public DriverPropertyInfo[] getDriverPropertyInfo()

Returns:

Driver's properties info array.