Package io.vertx.oracleclient

Class OracleConnectOptions

java.lang.Object

io.vertx.core.net.NetworkOptions

io.vertx.core.net.TCPSSLOptions

io.vertx.core.net.ClientOptionsBase

io.vertx.core.net.NetClientOptions

io.vertx.sqlclient.SqlConnectOptions

io.vertx.oracleclient.OracleConnectOptions

public class OracleConnectOptions
extends SqlConnectOptions

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_DATABASE
static String	DEFAULT_HOST
static String	DEFAULT_PASSWORD
static int	DEFAULT_PORT
static String	DEFAULT_USER

Fields inherited from class io.vertx.sqlclient.SqlConnectOptions

DEFAULT_CACHE_PREPARED_STATEMENTS, DEFAULT_PREPARED_STATEMENT_CACHE_FILTER, DEFAULT_PREPARED_STATEMENT_CACHE_MAX_SIZE, DEFAULT_PREPARED_STATEMENT_CACHE_SQL_LIMIT

Fields inherited from class io.vertx.core.net.NetClientOptions

DEFAULT_HOSTNAME_VERIFICATION_ALGORITHM, DEFAULT_RECONNECT_ATTEMPTS, DEFAULT_RECONNECT_INTERVAL, DEFAULT_REGISTER_WRITE_HANDLER

Fields inherited from class io.vertx.core.net.ClientOptionsBase

DEFAULT_CONNECT_TIMEOUT, DEFAULT_METRICS_NAME, DEFAULT_TRUST_ALL

Fields inherited from class io.vertx.core.net.TCPSSLOptions

DEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS, DEFAULT_IDLE_TIMEOUT, DEFAULT_IDLE_TIMEOUT_TIME_UNIT, DEFAULT_READ_IDLE_TIMEOUT, DEFAULT_SO_LINGER, DEFAULT_SSL, DEFAULT_SSL_ENGINE, DEFAULT_SSL_HANDSHAKE_TIMEOUT, DEFAULT_SSL_HANDSHAKE_TIMEOUT_TIME_UNIT, DEFAULT_TCP_CORK, DEFAULT_TCP_FAST_OPEN, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_NO_DELAY, DEFAULT_TCP_QUICKACK, DEFAULT_TCP_USER_TIMEOUT, DEFAULT_USE_ALPN, DEFAULT_WRITE_IDLE_TIMEOUT

Fields inherited from class io.vertx.core.net.NetworkOptions

DEFAULT_LOG_ACTIVITY_FORMAT, DEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_REUSE_PORT, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS

Constructor Summary

Constructors

Constructor	Description
OracleConnectOptions()
OracleConnectOptions(JsonObject json)
OracleConnectOptions(OracleConnectOptions other)
OracleConnectOptions(SqlConnectOptions options)

Method Summary

Modifier and Type	Method	Description
OracleConnectOptions	addProperty(String key, String value)
static OracleConnectOptions	fromUri(String connectionUri)	Provide a OracleConnectOptions configured from a connection URI.
boolean	getCachePreparedStatements()
String	getDatabase()
String	getHost()
String	getInstanceName()
String	getPassword()
int	getPort()
int	getPreparedStatementCacheMaxSize()
Predicate<String>	getPreparedStatementCacheSqlFilter()
Map<String,String>	getProperties()
ServerMode	getServerMode()
String	getServiceId()
String	getServiceName()
SocketAddress	getSocketAddress()
String	getTnsAdmin()
String	getTnsAlias()
TracingPolicy	getTracingPolicy()
String	getUser()
protected void	init()
OracleConnectOptions	merge(JsonObject other)
OracleConnectOptions	setCachePreparedStatements(boolean cachePreparedStatements)
OracleConnectOptions	setDatabase(String database)	Set the database name.
OracleConnectOptions	setHost(String host)
OracleConnectOptions	setInstanceName(String instanceName)	Set the Oracle instance name.
OracleConnectOptions	setPassword(String password)
OracleConnectOptions	setPort(int port)
OracleConnectOptions	setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)
OracleConnectOptions	setPreparedStatementCacheSqlFilter(Predicate<String> predicate)
OracleConnectOptions	setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)
OracleConnectOptions	setProperties(Map<String,String> properties)
OracleConnectOptions	setServerMode(ServerMode serverMode)	Set the server connection mode.
OracleConnectOptions	setServiceId(String serviceId)	Set the Oracle service identifier (SID).
OracleConnectOptions	setServiceName(String serviceName)	Set the Oracle service name.
OracleConnectOptions	setSsl(boolean ssl)
OracleConnectOptions	setTnsAdmin(String tnsAdmin)	Set the path of the directory that contains the tnsnames.ora file.
OracleConnectOptions	setTnsAlias(String tnsAlias)	Set the name of an alias configured in the tnsnames.ora file.
OracleConnectOptions	setTracingPolicy(TracingPolicy tracingPolicy)
OracleConnectOptions	setUser(String user)
JsonObject	toJson()
static OracleConnectOptions	wrap(SqlConnectOptions options)

Methods inherited from class io.vertx.sqlclient.SqlConnectOptions

isUsingDomainSocket

Methods inherited from class io.vertx.core.net.NetClientOptions

addCrlPath, addCrlValue, addEnabledCipherSuite, addEnabledSecureTransportProtocol, addNonProxyHost, getApplicationLayerProtocols, getHostnameVerificationAlgorithm, getReconnectAttempts, getReconnectInterval, isRegisterWriteHandler, removeEnabledCipherSuite, removeEnabledSecureTransportProtocol, setActivityLogDataFormat, setApplicationLayerProtocols, setConnectTimeout, setEnabledSecureTransportProtocols, setHostnameVerificationAlgorithm, setIdleTimeout, setIdleTimeoutUnit, setJdkSslEngineOptions, setKeyCertOptions, setKeyStoreOptions, setLocalAddress, setLogActivity, setMetricsName, setNonProxyHosts, setOpenSslEngineOptions, setPemKeyCertOptions, setPemTrustOptions, setPfxKeyCertOptions, setPfxTrustOptions, setProxyOptions, setReadIdleTimeout, setReceiveBufferSize, setReconnectAttempts, setReconnectInterval, setRegisterWriteHandler, setReuseAddress, setReusePort, setSendBufferSize, setSoLinger, setSslEngineOptions, setSslHandshakeTimeout, setSslHandshakeTimeoutUnit, setTcpCork, setTcpFastOpen, setTcpKeepAlive, setTcpNoDelay, setTcpQuickAck, setTrafficClass, setTrustAll, setTrustOptions, setTrustStoreOptions, setUseAlpn, setWriteIdleTimeout

Methods inherited from class io.vertx.core.net.ClientOptionsBase

getConnectTimeout, getLocalAddress, getMetricsName, getNonProxyHosts, getProxyOptions, isTrustAll, setTcpUserTimeout

Methods inherited from class io.vertx.core.net.TCPSSLOptions

getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getReadIdleTimeout, getSoLinger, getSslEngineOptions, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getSslOptions, getTcpUserTimeout, getTrustOptions, getTrustStoreOptions, getWriteIdleTimeout, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn

Methods inherited from class io.vertx.core.net.NetworkOptions

getActivityLogDataFormat, getLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePort

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HOST

public static final String DEFAULT_HOST

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_USER

public static final String DEFAULT_USER

See Also:

Constant Field Values

DEFAULT_PASSWORD

public static final String DEFAULT_PASSWORD

See Also:

Constant Field Values

DEFAULT_DATABASE

public static final String DEFAULT_DATABASE

See Also:

Constant Field Values

Constructor Detail

OracleConnectOptions

public OracleConnectOptions()

OracleConnectOptions

public OracleConnectOptions(OracleConnectOptions other)

OracleConnectOptions

public OracleConnectOptions(SqlConnectOptions options)

OracleConnectOptions

public OracleConnectOptions(JsonObject json)

Method Detail

wrap

public static OracleConnectOptions wrap(SqlConnectOptions options)

Returns:

the options as Oracle specific connect options

fromUri

public static OracleConnectOptions fromUri(String connectionUri)
                                    throws IllegalArgumentException

Provide a OracleConnectOptions configured from a connection URI.

Parameters:

connectionUri - the connection URI to configure from

Returns:

a OracleConnectOptions parsed from the connection URI

Throws:

IllegalArgumentException - when the connectionUri is in an invalid format

getServiceId

public String getServiceId()

Returns:

the Oracle service identifier (SID)

setServiceId

public OracleConnectOptions setServiceId(String serviceId)

Set the Oracle service identifier (SID). If set, the client will build an Oracle connection URL using SID instead of the EZConnect format.

Parameters:

serviceId - the service identifier

Returns:

a reference to this, so the API can be used fluently

getServiceName

public String getServiceName()

Returns:

the Oracle service name

setServiceName

public OracleConnectOptions setServiceName(String serviceName)

Set the Oracle service name. If set, the client will build an Oracle connection URL in the EZConnect format.

Parameters:

serviceName - the Oracle service name

Returns:

a reference to this, so the API can be used fluently

getServerMode

public ServerMode getServerMode()

Returns:

the server connection mode

setServerMode

public OracleConnectOptions setServerMode(ServerMode serverMode)

Set the server connection mode.

Parameters:

serverMode - the connection mode

Returns:

a reference to this, so the API can be used fluently

getInstanceName

public String getInstanceName()

Returns:

the Oracle instance name

setInstanceName

public OracleConnectOptions setInstanceName(String instanceName)

Set the Oracle instance name.

Parameters:

instanceName - the instance name

Returns:

a reference to this, so the API can be used fluently

getTnsAlias

public String getTnsAlias()

Returns:

name of the alias configured in the tnsnames.ora file

setTnsAlias

public OracleConnectOptions setTnsAlias(String tnsAlias)

Set the name of an alias configured in the tnsnames.ora file.

Parameters:

tnsAlias - the instance name

Returns:

a reference to this, so the API can be used fluently

getTnsAdmin

public String getTnsAdmin()

Returns:

the path of the directory that contains the tnsnames.ora file

setTnsAdmin

public OracleConnectOptions setTnsAdmin(String tnsAdmin)

Set the path of the directory that contains the tnsnames.ora file.

Parameters:

tnsAdmin - path of the directory

Returns:

a reference to this, so the API can be used fluently

getHost

public String getHost()

Overrides:

getHost in class SqlConnectOptions

setHost

public OracleConnectOptions setHost(String host)

Overrides:

setHost in class SqlConnectOptions

getPort

public int getPort()

Overrides:

getPort in class SqlConnectOptions

setPort

public OracleConnectOptions setPort(int port)

Overrides:

setPort in class SqlConnectOptions

getUser

public String getUser()

Overrides:

getUser in class SqlConnectOptions

setUser

public OracleConnectOptions setUser(String user)

Overrides:

setUser in class SqlConnectOptions

getPassword

public String getPassword()

Overrides:

getPassword in class SqlConnectOptions

setPassword

public OracleConnectOptions setPassword(String password)

Overrides:

setPassword in class SqlConnectOptions

getDatabase

public String getDatabase()

Overrides:

getDatabase in class SqlConnectOptions

setDatabase

public OracleConnectOptions setDatabase(String database)

Set the database name. If set, the client will build an Oracle connection URL in the EZConnect format using the database value as service name.

Overrides:

setDatabase in class SqlConnectOptions

Parameters:

database - the database name to specify

Returns:

a reference to this, so the API can be used fluently

getCachePreparedStatements

public boolean getCachePreparedStatements()

Overrides:

getCachePreparedStatements in class SqlConnectOptions

setCachePreparedStatements

public OracleConnectOptions setCachePreparedStatements(boolean cachePreparedStatements)

Overrides:

setCachePreparedStatements in class SqlConnectOptions

getPreparedStatementCacheMaxSize

public int getPreparedStatementCacheMaxSize()

Overrides:

getPreparedStatementCacheMaxSize in class SqlConnectOptions

setPreparedStatementCacheMaxSize

public OracleConnectOptions setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)

Overrides:

setPreparedStatementCacheMaxSize in class SqlConnectOptions

getPreparedStatementCacheSqlFilter

public Predicate<String> getPreparedStatementCacheSqlFilter()

Overrides:

getPreparedStatementCacheSqlFilter in class SqlConnectOptions

setPreparedStatementCacheSqlFilter

public OracleConnectOptions setPreparedStatementCacheSqlFilter(Predicate<String> predicate)

Overrides:

setPreparedStatementCacheSqlFilter in class SqlConnectOptions

setPreparedStatementCacheSqlLimit

public OracleConnectOptions setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)

Overrides:

setPreparedStatementCacheSqlLimit in class SqlConnectOptions

getProperties

public Map<String,String> getProperties()

Overrides:

getProperties in class SqlConnectOptions

setProperties

public OracleConnectOptions setProperties(Map<String,String> properties)

Overrides:

setProperties in class SqlConnectOptions

addProperty

public OracleConnectOptions addProperty(String key,
                                        String value)

Overrides:

addProperty in class SqlConnectOptions

getSocketAddress

public SocketAddress getSocketAddress()

Overrides:

getSocketAddress in class SqlConnectOptions

getTracingPolicy

public TracingPolicy getTracingPolicy()

Overrides:

getTracingPolicy in class SqlConnectOptions

setTracingPolicy

public OracleConnectOptions setTracingPolicy(TracingPolicy tracingPolicy)

Overrides:

setTracingPolicy in class SqlConnectOptions

setSsl

public OracleConnectOptions setSsl(boolean ssl)

Overrides:

setSsl in class NetClientOptions

toJson

public JsonObject toJson()

Overrides:

toJson in class SqlConnectOptions

init

protected void init()

Overrides:

init in class SqlConnectOptions

merge

public OracleConnectOptions merge(JsonObject other)

Overrides:

merge in class SqlConnectOptions