java.lang.Object
- 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 boolean`	`DEFAULT_SSL`
`static String`	`DEFAULT_USER`

Fields inherited from class io.vertx.sqlclient.SqlConnectOptions
DEFAULT_CACHE_PREPARED_STATEMENTS, DEFAULT_METRICS_NAME, DEFAULT_PREPARED_STATEMENT_CACHE_FILTER, DEFAULT_PREPARED_STATEMENT_CACHE_MAX_SIZE, DEFAULT_PREPARED_STATEMENT_CACHE_SQL_LIMIT, DEFAULT_RECONNECT_ATTEMPTS, DEFAULT_RECONNECT_INTERVAL

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()`
`boolean`	`isSsl()`
`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)`	Set whether SSL/TLS is enabled
`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
getMetricsName, getReconnectAttempts, getReconnectInterval, getSslOptions, isUsingDomainSocket, setMetricsName, setReconnectAttempts, setReconnectInterval, setSslOptions

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
  - DEFAULT_SSL
```
public static final boolean DEFAULT_SSL
```
    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
  - isSsl
```
public boolean isSsl()
```
    Returns:
    
    is SSL/TLS enabled?
  - setSsl
```
public OracleConnectOptions setSsl(boolean ssl)
```
    Set whether SSL/TLS is enabled
    
    Parameters:
    
    ssl - true if enabled
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - 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

Class OracleConnectOptions

Field Summary

Fields inherited from class io.vertx.sqlclient.SqlConnectOptions

Constructor Summary

Method Summary

Methods inherited from class io.vertx.sqlclient.SqlConnectOptions

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_HOST

DEFAULT_PORT

DEFAULT_USER

DEFAULT_PASSWORD

DEFAULT_DATABASE

DEFAULT_SSL

Constructor Detail

OracleConnectOptions

OracleConnectOptions

OracleConnectOptions

OracleConnectOptions

Method Detail

wrap

fromUri

getServiceId

setServiceId

getServiceName

setServiceName

getServerMode

setServerMode

getInstanceName

setInstanceName

getTnsAlias

setTnsAlias

getTnsAdmin

setTnsAdmin

getHost

setHost

getPort

setPort

getUser

setUser

getPassword

setPassword

getDatabase

setDatabase

getCachePreparedStatements

setCachePreparedStatements

getPreparedStatementCacheMaxSize

setPreparedStatementCacheMaxSize

getPreparedStatementCacheSqlFilter

setPreparedStatementCacheSqlFilter

setPreparedStatementCacheSqlLimit

getProperties

setProperties

addProperty

getSocketAddress

getTracingPolicy

setTracingPolicy

isSsl

setSsl

toJson

init

merge