Package io.vertx.db2client
Class DB2ConnectOptions
- java.lang.Object
-
- io.vertx.sqlclient.SqlConnectOptions
-
- io.vertx.db2client.DB2ConnectOptions
-
public class DB2ConnectOptions extends SqlConnectOptions
Connect options for configuringDB2ConnectionorDB2Builder.
-
-
Field Summary
Fields Modifier and Type Field Description static StringDEFAULT_CHARSETstatic Map<String,String>DEFAULT_CONNECTION_ATTRIBUTESstatic StringDEFAULT_HOSTstatic intDEFAULT_PIPELINING_LIMITstatic intDEFAULT_PORTstatic booleanDEFAULT_SSLstatic booleanDEFAULT_USE_AFFECTED_ROWS-
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 DB2ConnectOptions()DB2ConnectOptions(JsonObject json)DB2ConnectOptions(DB2ConnectOptions other)DB2ConnectOptions(SqlConnectOptions other)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description DB2ConnectOptionsaddProperty(String key, String value)Add a property for this client, which will be sent to server at the connection start.booleanequals(Object o)static DB2ConnectOptionsfromUri(String connectionUri)Provide aDB2ConnectOptionsconfigured from a connection URI.intgetPipeliningLimit()inthashCode()protected voidinit()Initialize with the default options.booleanisSsl()DB2ConnectOptionsmerge(JsonObject other)Returns new options created after this object and merged with theotherjson config.DB2ConnectOptionssetCachePreparedStatements(boolean cachePreparedStatements)Set whether prepared statements cache should be enabled.DB2ConnectOptionssetDatabase(String database)Specify the default database for the connection.DB2ConnectOptionssetHost(String host)Specify the host for connecting to the server.DB2ConnectOptionssetPassword(String password)Specify the user password to be used for the authentication.DB2ConnectOptionssetPipeliningLimit(int pipeliningLimit)Deprecated.UNSTABLE FEATURE: Current default value is 1, anything higher than 1 will result in errors currently.DB2ConnectOptionssetPort(int port)Specify the port for connecting to the server.DB2ConnectOptionssetPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)Set the maximum number of prepared statements that the connection will cache.DB2ConnectOptionssetPreparedStatementCacheSqlFilter(Predicate<String> predicate)Set a predicate filtering prepared statements that the connection will cache.DB2ConnectOptionssetPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)Set the maximum length of prepared statement SQL string that the connection will cache.DB2ConnectOptionssetProperties(Map<String,String> properties)Set properties for this client, which will be sent to server at the connection start.DB2ConnectOptionssetSsl(boolean ssl)Set whether SSL/TLS is enabledDB2ConnectOptionssetSslOptions(ClientSSLOptions sslOptions)DB2ConnectOptionssetTracingPolicy(TracingPolicy tracingPolicy)Set the tracing policy for the client behavior when Vert.x has tracing enabled.DB2ConnectOptionssetUser(String user)Specify the user account to be used for the authentication.JsonObjecttoJson()static DB2ConnectOptionswrap(SqlConnectOptions options)-
Methods inherited from class io.vertx.sqlclient.SqlConnectOptions
getCachePreparedStatements, getDatabase, getHost, getMetricsName, getPassword, getPort, getPreparedStatementCacheMaxSize, getPreparedStatementCacheSqlFilter, getProperties, getReconnectAttempts, getReconnectInterval, getSocketAddress, getSslOptions, getTracingPolicy, getUser, isUsingDomainSocket, setMetricsName, setReconnectAttempts, setReconnectInterval
-
-
-
-
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_CHARSET
public static final String DEFAULT_CHARSET
- See Also:
- Constant Field Values
-
DEFAULT_USE_AFFECTED_ROWS
public static final boolean DEFAULT_USE_AFFECTED_ROWS
- See Also:
- Constant Field Values
-
DEFAULT_PIPELINING_LIMIT
public static final int DEFAULT_PIPELINING_LIMIT
- See Also:
- Constant Field Values
-
DEFAULT_SSL
public static final boolean DEFAULT_SSL
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
DB2ConnectOptions
public DB2ConnectOptions()
-
DB2ConnectOptions
public DB2ConnectOptions(JsonObject json)
-
DB2ConnectOptions
public DB2ConnectOptions(SqlConnectOptions other)
-
DB2ConnectOptions
public DB2ConnectOptions(DB2ConnectOptions other)
-
-
Method Detail
-
wrap
public static DB2ConnectOptions wrap(SqlConnectOptions options)
- Returns:
- the
optionsas DB2 specific connect options
-
fromUri
public static DB2ConnectOptions fromUri(String connectionUri) throws IllegalArgumentException
Provide aDB2ConnectOptionsconfigured from a connection URI.- Parameters:
connectionUri- the connection URI to configure from- Returns:
- a
DB2ConnectOptionsparsed from the connection URI - Throws:
IllegalArgumentException- when theconnectionUriis in an invalid format
-
setHost
public DB2ConnectOptions setHost(String host)
Description copied from class:SqlConnectOptionsSpecify the host for connecting to the server.- Overrides:
setHostin classSqlConnectOptions- Parameters:
host- the host to specify- Returns:
- a reference to this, so the API can be used fluently
-
setPort
public DB2ConnectOptions setPort(int port)
Description copied from class:SqlConnectOptionsSpecify the port for connecting to the server.- Overrides:
setPortin classSqlConnectOptions- Parameters:
port- the port to specify- Returns:
- a reference to this, so the API can be used fluently
-
setUser
public DB2ConnectOptions setUser(String user)
Description copied from class:SqlConnectOptionsSpecify the user account to be used for the authentication.- Overrides:
setUserin classSqlConnectOptions- Parameters:
user- the user to specify- Returns:
- a reference to this, so the API can be used fluently
-
setPassword
public DB2ConnectOptions setPassword(String password)
Description copied from class:SqlConnectOptionsSpecify the user password to be used for the authentication.- Overrides:
setPasswordin classSqlConnectOptions- Parameters:
password- the password to specify- Returns:
- a reference to this, so the API can be used fluently
-
setDatabase
public DB2ConnectOptions setDatabase(String database)
Description copied from class:SqlConnectOptionsSpecify the default database for the connection.- Overrides:
setDatabasein classSqlConnectOptions- Parameters:
database- the database name to specify- Returns:
- a reference to this, so the API can be used fluently
-
setCachePreparedStatements
public DB2ConnectOptions setCachePreparedStatements(boolean cachePreparedStatements)
Description copied from class:SqlConnectOptionsSet whether prepared statements cache should be enabled.- Overrides:
setCachePreparedStatementsin classSqlConnectOptions- Parameters:
cachePreparedStatements- true if cache should be enabled- Returns:
- a reference to this, so the API can be used fluently
-
setPreparedStatementCacheMaxSize
public DB2ConnectOptions setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)
Description copied from class:SqlConnectOptionsSet the maximum number of prepared statements that the connection will cache.- Overrides:
setPreparedStatementCacheMaxSizein classSqlConnectOptions- Parameters:
preparedStatementCacheMaxSize- the size to set- Returns:
- a reference to this, so the API can be used fluently
-
setPreparedStatementCacheSqlFilter
public DB2ConnectOptions setPreparedStatementCacheSqlFilter(Predicate<String> predicate)
Description copied from class:SqlConnectOptionsSet a predicate filtering prepared statements that the connection will cache.The default predicate accepts predicate having query length <
SqlConnectOptions.DEFAULT_PREPARED_STATEMENT_CACHE_SQL_LIMIT- Overrides:
setPreparedStatementCacheSqlFilterin classSqlConnectOptions- Parameters:
predicate- the filter
-
setPreparedStatementCacheSqlLimit
public DB2ConnectOptions setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)
Description copied from class:SqlConnectOptionsSet the maximum length of prepared statement SQL string that the connection will cache.This is an helper setting the
SqlConnectOptions.setPreparedStatementCacheSqlFilter(Predicate).- Overrides:
setPreparedStatementCacheSqlLimitin classSqlConnectOptions- Parameters:
preparedStatementCacheSqlLimit- the maximum length limit of SQL string to set- Returns:
- a reference to this, so the API can be used fluently
-
isSsl
public boolean isSsl()
- Returns:
- is SSL/TLS enabled?
-
setSsl
public DB2ConnectOptions 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
-
getPipeliningLimit
public int getPipeliningLimit()
-
setPipeliningLimit
@Deprecated public DB2ConnectOptions setPipeliningLimit(int pipeliningLimit)
Deprecated.UNSTABLE FEATURE: Current default value is 1, anything higher than 1 will result in errors currently.- Parameters:
pipeliningLimit- the number of commands that can simultaneously use the same physical socket connection.- Returns:
- A reference to this, so the API can be used fluently
-
setTracingPolicy
public DB2ConnectOptions setTracingPolicy(TracingPolicy tracingPolicy)
Description copied from class:SqlConnectOptionsSet the tracing policy for the client behavior when Vert.x has tracing enabled.- Overrides:
setTracingPolicyin classSqlConnectOptions- Parameters:
tracingPolicy- the tracing policy- Returns:
- a reference to this, so the API can be used fluently
-
setProperties
public DB2ConnectOptions setProperties(Map<String,String> properties)
Description copied from class:SqlConnectOptionsSet properties for this client, which will be sent to server at the connection start.- Overrides:
setPropertiesin classSqlConnectOptions- Parameters:
properties- the value of properties to specify- Returns:
- a reference to this, so the API can be used fluently
-
addProperty
public DB2ConnectOptions addProperty(String key, String value)
Description copied from class:SqlConnectOptionsAdd a property for this client, which will be sent to server at the connection start.- Overrides:
addPropertyin classSqlConnectOptions- Parameters:
key- the value of property keyvalue- the value of property value- Returns:
- a reference to this, so the API can be used fluently
-
setSslOptions
public DB2ConnectOptions setSslOptions(ClientSSLOptions sslOptions)
- Overrides:
setSslOptionsin classSqlConnectOptions
-
init
protected void init()
Initialize with the default options.- Overrides:
initin classSqlConnectOptions
-
toJson
public JsonObject toJson()
- Overrides:
toJsonin classSqlConnectOptions
-
merge
public DB2ConnectOptions merge(JsonObject other)
Description copied from class:SqlConnectOptionsReturns new options created after this object and merged with theotherjson config.- Overrides:
mergein classSqlConnectOptions- Parameters:
other- the other JSON object- Returns:
- new options created after this object and merged with the
otherjson config
-
-