JdbcUrlUtil (Cassandra JDBC Wrapper 4.13.0 API)

java.lang.Object
- com.ing.data.cassandra.jdbc.utils.JdbcUrlUtil

```
public final class JdbcUrlUtil
extends Object
```
A set of static utility methods and constants used to parse the JDBC URL used to establish a connection to a Cassandra database.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_PORT` Default Cassandra cluster port.
`static String`	`KEY_ACTIVE_PROFILE` JDBC URL parameter key for the active execution profile.
`static String`	`KEY_CLOUD_SECURE_CONNECT_BUNDLE` JDBC URL parameter key for the cloud secure connect bundle.
`static String`	`KEY_COMPLIANCE_MODE` JDBC URL parameter key for the compliance mode.
`static String`	`KEY_CONFIG_FILE` JDBC URL parameter key for the configuration file.
`static String`	`KEY_CONNECT_TIMEOUT` JDBC URL parameter key for the connection timeout.
`static String`	`KEY_CONSISTENCY` JDBC URL parameter key for the consistency.
`static String`	`KEY_DEBUG` JDBC URL parameter key for the debug mode.
`static String`	`KEY_ENABLE_SSL` JDBC URL parameter key for SSL enabling.
`static String`	`KEY_FETCH_SIZE` JDBC URL parameter key for the fetch size (request page size).
`static String`	`KEY_KEEP_ALIVE` JDBC URL parameter key for the TCP keep-alive enabling.
`static String`	`KEY_LOAD_BALANCING_POLICY` JDBC URL parameter key for the load balancing policy.
`static String`	`KEY_LOCAL_DATACENTER` JDBC URL parameter key for the local data center.
`static String`	`KEY_PASSWORD` JDBC URL parameter key for the user password.
`static String`	`KEY_RECONNECT_POLICY` JDBC URL parameter key for the reconnection policy.
`static String`	`KEY_REQUEST_TIMEOUT` JDBC URL parameter key for the request timeout.
`static String`	`KEY_RETRY_POLICY` JDBC URL parameter key for the retry policy.
`static String`	`KEY_SSL_ENGINE_FACTORY` JDBC URL parameter key for the custom SSL engine factory (`SslEngineFactory`).
`static String`	`KEY_SSL_HOSTNAME_VERIFICATION` JDBC URL parameter key for SSL hostname verification disabling.
`static String`	`KEY_TCP_NO_DELAY` JDBC URL parameter key for the Nagle's algorithm enabling.
`static String`	`KEY_USE_KERBEROS` JDBC URL parameter key for Kerberos auth provider enabling.
`static String`	`KEY_USER` JDBC URL parameter key for the username.
`static String`	`PROTOCOL` JDBC protocol for Cassandra connection.
`static String`	`PROTOCOL_DBAAS` JDBC protocol for Cassandra DBaaS connection.
`static String`	`TAG_ACTIVE_PROFILE` Property name used to retrieve the execution profile to use when the connection to Cassandra is created.
`static String`	`TAG_CLOUD_SECURE_CONNECT_BUNDLE` Property name used to retrieve the secure connect Bundle when the connection to Cassandra DBaaS is established.
`static String`	`TAG_COMPLIANCE_MODE` Property name used to retrieve the compliance mode to use when the connection to Cassandra is established.
`static String`	`TAG_CONFIG_FILE` Property name used to retrieve the configuration file when the connection to Cassandra is established.
`static String`	`TAG_CONNECT_TIMEOUT` Property name used to retrieve the connection timeout when the connection to Cassandra is established.
`static String`	`TAG_CONSISTENCY_LEVEL` Property name used to retrieve the consistency when the connection to Cassandra is established.
`static String`	`TAG_CONTACT_POINTS` Property name used to retrieve the contact points when the connection to Cassandra is established.
`static String`	`TAG_DATABASE_NAME` Property name used to retrieve the keyspace name when the connection to Cassandra is established.
`static String`	`TAG_DBAAS_CONNECTION` Property name used to determine if the current connection is established to a cloud database.
`static String`	`TAG_DEBUG` Property name used to retrieve the debug mode value when the connection to Cassandra is established.
`static String`	`TAG_ENABLE_SSL` Property name used to retrieve the SSL enabling value when the connection to Cassandra is established.
`static String`	`TAG_FETCH_SIZE` Property name used to retrieve the fetch size (request page size) when the connection to Cassandra is established.
`static String`	`TAG_KEEP_ALIVE` Property name used to retrieve the TCP keep-alive enabling when the connection to Cassandra is established.
`static String`	`TAG_LOAD_BALANCING_POLICY` Property name used to retrieve the load balancing policy when the connection to Cassandra is established.
`static String`	`TAG_LOCAL_DATACENTER` Property name used to retrieve the local data center when the connection to Cassandra is established.
`static String`	`TAG_PASSWORD` Property name used to retrieve the user password when the connection to Cassandra is established.
`static String`	`TAG_RECONNECT_POLICY` Property name used to retrieve the reconnection policy when the connection to Cassandra is established.
`static String`	`TAG_REQUEST_TIMEOUT` Property name used to retrieve the request timeout when the connection to Cassandra is established.
`static String`	`TAG_RETRY_POLICY` Property name used to retrieve the retry policy when the connection to Cassandra is established.
`static String`	`TAG_SSL_ENGINE_FACTORY` Property name used to retrieve the custom SSL engine factory when the connection to Cassandra is established.
`static String`	`TAG_SSL_HOSTNAME_VERIFICATION` Property name used to retrieve the SSL hostname verification enabling when the connection to Cassandra is established.
`static String`	`TAG_TCP_NO_DELAY` Property name used to retrieve the Nagle's algorithm enabling when the connection to Cassandra is established.
`static String`	`TAG_USE_KERBEROS` Property name used to retrieve the Kerberos auth provider enabling when the connection to Cassandra is established.
`static String`	`TAG_USER` Property name used to retrieve the username when the connection to Cassandra is established.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`createSubName(Properties props)` Creates a "sub-name" portion of a JDBC URL from properties.
`static Map<com.datastax.oss.driver.api.core.config.DriverOption,Object>`	`parseReconnectionPolicy(String reconnectionPolicyString)` Parses the reconnection policy from a given string.
`static Properties`	`parseURL(String url)` Parses a URL for the Cassandra JDBC Driver.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    Default Cassandra cluster port.
    
    See Also:
    
    Constant Field Values
  - PROTOCOL
```
public static final String PROTOCOL
```
    JDBC protocol for Cassandra connection.
    
    See Also:
    
    Constant Field Values
  - PROTOCOL_DBAAS
```
public static final String PROTOCOL_DBAAS
```
    JDBC protocol for Cassandra DBaaS connection.
    
    See Also:
    
    Constant Field Values
  - KEY_CONSISTENCY
```
public static final String KEY_CONSISTENCY
```
    JDBC URL parameter key for the consistency.
    
    See Also:
    
    Constant Field Values
  - TAG_CONSISTENCY_LEVEL
```
public static final String TAG_CONSISTENCY_LEVEL
```
    Property name used to retrieve the consistency when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter consistency.
    
    See Also:
    
    Constant Field Values
  - KEY_FETCH_SIZE
```
public static final String KEY_FETCH_SIZE
```
    JDBC URL parameter key for the fetch size (request page size).
    
    See Also:
    
    Constant Field Values
  - TAG_FETCH_SIZE
```
public static final String TAG_FETCH_SIZE
```
    Property name used to retrieve the fetch size (request page size) when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter fetchsize.
    
    See Also:
    
    Constant Field Values
  - KEY_LOAD_BALANCING_POLICY
```
public static final String KEY_LOAD_BALANCING_POLICY
```
    JDBC URL parameter key for the load balancing policy.
    
    See Also:
    
    Constant Field Values
  - TAG_LOAD_BALANCING_POLICY
```
public static final String TAG_LOAD_BALANCING_POLICY
```
    Property name used to retrieve the load balancing policy when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter loadbalancing.
    
    See Also:
    
    Constant Field Values
  - KEY_LOCAL_DATACENTER
```
public static final String KEY_LOCAL_DATACENTER
```
    JDBC URL parameter key for the local data center.
    
    See Also:
    
    Constant Field Values
  - TAG_LOCAL_DATACENTER
```
public static final String TAG_LOCAL_DATACENTER
```
    Property name used to retrieve the local data center when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter localdatacenter.
    
    See Also:
    
    Constant Field Values
  - KEY_RETRY_POLICY
```
public static final String KEY_RETRY_POLICY
```
    JDBC URL parameter key for the retry policy.
    
    See Also:
    
    Constant Field Values
  - TAG_RETRY_POLICY
```
public static final String TAG_RETRY_POLICY
```
    Property name used to retrieve the retry policy when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter retry.
    
    See Also:
    
    Constant Field Values
  - KEY_RECONNECT_POLICY
```
public static final String KEY_RECONNECT_POLICY
```
    JDBC URL parameter key for the reconnection policy.
    
    See Also:
    
    Constant Field Values
  - TAG_RECONNECT_POLICY
```
public static final String TAG_RECONNECT_POLICY
```
    Property name used to retrieve the reconnection policy when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter reconnection.
    
    See Also:
    
    Constant Field Values
  - KEY_DEBUG
```
public static final String KEY_DEBUG
```
    JDBC URL parameter key for the debug mode.
    
    See Also:
    
    Constant Field Values
  - TAG_DEBUG
```
public static final String TAG_DEBUG
```
    Property name used to retrieve the debug mode value when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter debug.
    
    See Also:
    
    Constant Field Values
  - KEY_ENABLE_SSL
```
public static final String KEY_ENABLE_SSL
```
    JDBC URL parameter key for SSL enabling.
    
    See Also:
    
    Constant Field Values
  - TAG_ENABLE_SSL
```
public static final String TAG_ENABLE_SSL
```
    Property name used to retrieve the SSL enabling value when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter enablessl.
    
    See Also:
    
    Constant Field Values
  - KEY_SSL_ENGINE_FACTORY
```
public static final String KEY_SSL_ENGINE_FACTORY
```
    JDBC URL parameter key for the custom SSL engine factory (SslEngineFactory).
    
    See Also:
    
    Constant Field Values
  - TAG_SSL_ENGINE_FACTORY
```
public static final String TAG_SSL_ENGINE_FACTORY
```
    Property name used to retrieve the custom SSL engine factory when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter sslenginefactory.
    
    See Also:
    
    Constant Field Values
  - KEY_SSL_HOSTNAME_VERIFICATION
```
public static final String KEY_SSL_HOSTNAME_VERIFICATION
```
    JDBC URL parameter key for SSL hostname verification disabling.
    
    See Also:
    
    Constant Field Values
  - TAG_SSL_HOSTNAME_VERIFICATION
```
public static final String TAG_SSL_HOSTNAME_VERIFICATION
```
    Property name used to retrieve the SSL hostname verification enabling when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter hostnameverification.
    
    See Also:
    
    Constant Field Values
  - KEY_CLOUD_SECURE_CONNECT_BUNDLE
```
public static final String KEY_CLOUD_SECURE_CONNECT_BUNDLE
```
    JDBC URL parameter key for the cloud secure connect bundle.
    
    See Also:
    
    Constant Field Values
  - TAG_CLOUD_SECURE_CONNECT_BUNDLE
```
public static final String TAG_CLOUD_SECURE_CONNECT_BUNDLE
```
    Property name used to retrieve the secure connect Bundle when the connection to Cassandra DBaaS is established. This property is mapped from the JDBC URL parameter secureconnectbundle.
    
    See Also:
    
    Constant Field Values
  - KEY_USER
```
public static final String KEY_USER
```
    JDBC URL parameter key for the username.
    
    See Also:
    
    Constant Field Values
  - TAG_USER
```
public static final String TAG_USER
```
    Property name used to retrieve the username when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter user.
    
    See Also:
    
    Constant Field Values
  - KEY_PASSWORD
```
public static final String KEY_PASSWORD
```
    JDBC URL parameter key for the user password.
    
    See Also:
    
    Constant Field Values
  - TAG_PASSWORD
```
public static final String TAG_PASSWORD
```
    Property name used to retrieve the user password when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter password.
    
    See Also:
    
    Constant Field Values
  - KEY_USE_KERBEROS
```
public static final String KEY_USE_KERBEROS
```
    JDBC URL parameter key for Kerberos auth provider enabling.
    
    See Also:
    
    Constant Field Values
  - TAG_USE_KERBEROS
```
public static final String TAG_USE_KERBEROS
```
    Property name used to retrieve the Kerberos auth provider enabling when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter usekrb5.
    
    See Also:
    
    Constant Field Values
  - KEY_REQUEST_TIMEOUT
```
public static final String KEY_REQUEST_TIMEOUT
```
    JDBC URL parameter key for the request timeout.
    
    See Also:
    
    Constant Field Values
  - TAG_REQUEST_TIMEOUT
```
public static final String TAG_REQUEST_TIMEOUT
```
    Property name used to retrieve the request timeout when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter requesttimeout.
    
    See Also:
    
    Constant Field Values
  - KEY_CONNECT_TIMEOUT
```
public static final String KEY_CONNECT_TIMEOUT
```
    JDBC URL parameter key for the connection timeout.
    
    See Also:
    
    Constant Field Values
  - TAG_CONNECT_TIMEOUT
```
public static final String TAG_CONNECT_TIMEOUT
```
    Property name used to retrieve the connection timeout when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter connecttimeout.
    
    See Also:
    
    Constant Field Values
  - KEY_TCP_NO_DELAY
```
public static final String KEY_TCP_NO_DELAY
```
    JDBC URL parameter key for the Nagle's algorithm enabling.
    
    See Also:
    
    Constant Field Values
  - TAG_TCP_NO_DELAY
```
public static final String TAG_TCP_NO_DELAY
```
    Property name used to retrieve the Nagle's algorithm enabling when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter tcpnodelay.
    
    See Also:
    
    Constant Field Values
  - KEY_KEEP_ALIVE
```
public static final String KEY_KEEP_ALIVE
```
    JDBC URL parameter key for the TCP keep-alive enabling.
    
    See Also:
    
    Constant Field Values
  - TAG_KEEP_ALIVE
```
public static final String TAG_KEEP_ALIVE
```
    Property name used to retrieve the TCP keep-alive enabling when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter keepalive.
    
    See Also:
    
    Constant Field Values
  - KEY_CONFIG_FILE
```
public static final String KEY_CONFIG_FILE
```
    JDBC URL parameter key for the configuration file.
    
    See Also:
    
    Constant Field Values
  - TAG_CONFIG_FILE
```
public static final String TAG_CONFIG_FILE
```
    Property name used to retrieve the configuration file when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter configfile.
    
    See Also:
    
    Constant Field Values
  - KEY_COMPLIANCE_MODE
```
public static final String KEY_COMPLIANCE_MODE
```
    JDBC URL parameter key for the compliance mode.
    
    See Also:
    
    Constant Field Values
  - TAG_COMPLIANCE_MODE
```
public static final String TAG_COMPLIANCE_MODE
```
    Property name used to retrieve the compliance mode to use when the connection to Cassandra is established. This property is mapped from the JDBC URL parameter compliancemode.
    
    See Also:
    
    Constant Field Values
  - TAG_DATABASE_NAME
```
public static final String TAG_DATABASE_NAME
```
    Property name used to retrieve the keyspace name when the connection to Cassandra is established. This property is mapped from the JDBC URL keyspace path parameter.
    
    See Also:
    
    Constant Field Values
  - TAG_CONTACT_POINTS
```
public static final String TAG_CONTACT_POINTS
```
    Property name used to retrieve the contact points when the connection to Cassandra is established. This property is mapped from the JDBC URL host.
    
    See Also:
    
    Constant Field Values
  - TAG_ACTIVE_PROFILE
```
public static final String TAG_ACTIVE_PROFILE
```
    Property name used to retrieve the execution profile to use when the connection to Cassandra is created. This property is mapped from the JDBC URL parameter activeprofile.
    
    See Also:
    
    Constant Field Values
  - KEY_ACTIVE_PROFILE
```
public static final String KEY_ACTIVE_PROFILE
```
    JDBC URL parameter key for the active execution profile.
    
    See Also:
    
    Constant Field Values
  - TAG_DBAAS_CONNECTION
```
public static final String TAG_DBAAS_CONNECTION
```
    Property name used to determine if the current connection is established to a cloud database. In such a case, the hostname can be ignored. This property is mapped from the JDBC URL protocol (see PROTOCOL_DBAAS).
    
    See Also:
    
    Constant Field Values
- Method Detail
  - parseURL
```
public static Properties parseURL(String url)
                           throws SQLException
```
    Parses a URL for the Cassandra JDBC Driver.
    The URL must start with the protocol "jdbc:cassandra:" or "jdbc:cassandra:dbaas:" for a connection to a cloud database. The URI part (the "sub-name") must contain a host, an optional port and optional keyspace name, for example: "//localhost:9160/Test1", except for a connection to a cloud database, in this case, a simple keyspace with a secure connect bundle is sufficient, for example: "///Test1?secureconnectbundle=/path/to/bundle.zip".
    
    Parameters:
    
    url - The full JDBC URL to be parsed.
    
    Returns:
    
    A list of properties that were parsed from the "subname".
    
    Throws:
    
    SQLException - when something went wrong during the URL parsing.
    
    SQLSyntaxErrorException - when the URL syntax is invalid.
    
    SQLNonTransientConnectionException - when the host is missing in the URL.
  - createSubName
```
public static String createSubName(Properties props)
                            throws SQLException
```
    Creates a "sub-name" portion of a JDBC URL from properties.
    
    Parameters:
    
    props - A Properties instance containing all the properties to be considered.
    
    Returns:
    
    A "sub-name" portion of a JDBC URL (for example: //myhost:9160/Test1?localdatacenter=DC1).
    
    Throws:
    
    SQLException - when something went wrong during the "sub-name" creation.
    
    SQLNonTransientConnectionException - when the host name is missing.
  - parseReconnectionPolicy
```
public static Map<com.datastax.oss.driver.api.core.config.DriverOption,Object> parseReconnectionPolicy(String reconnectionPolicyString)
```
    Parses the reconnection policy from a given string.
    
    Parameters:
    
    reconnectionPolicyString - The string containing the reconnection policy value.
    
    Returns:
    
    A map of DriverOption values parsed from the given string.

Class JdbcUrlUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PORT

PROTOCOL

PROTOCOL_DBAAS

KEY_CONSISTENCY

TAG_CONSISTENCY_LEVEL

KEY_FETCH_SIZE

TAG_FETCH_SIZE

KEY_LOAD_BALANCING_POLICY

TAG_LOAD_BALANCING_POLICY

KEY_LOCAL_DATACENTER

TAG_LOCAL_DATACENTER

KEY_RETRY_POLICY

TAG_RETRY_POLICY

KEY_RECONNECT_POLICY

TAG_RECONNECT_POLICY

KEY_DEBUG

TAG_DEBUG

KEY_ENABLE_SSL

TAG_ENABLE_SSL

KEY_SSL_ENGINE_FACTORY

TAG_SSL_ENGINE_FACTORY

KEY_SSL_HOSTNAME_VERIFICATION

TAG_SSL_HOSTNAME_VERIFICATION

KEY_CLOUD_SECURE_CONNECT_BUNDLE

TAG_CLOUD_SECURE_CONNECT_BUNDLE

KEY_USER

TAG_USER

KEY_PASSWORD

TAG_PASSWORD

KEY_USE_KERBEROS

TAG_USE_KERBEROS

KEY_REQUEST_TIMEOUT

TAG_REQUEST_TIMEOUT

KEY_CONNECT_TIMEOUT

TAG_CONNECT_TIMEOUT

KEY_TCP_NO_DELAY

TAG_TCP_NO_DELAY

KEY_KEEP_ALIVE

TAG_KEEP_ALIVE

KEY_CONFIG_FILE

TAG_CONFIG_FILE

KEY_COMPLIANCE_MODE

TAG_COMPLIANCE_MODE

TAG_DATABASE_NAME

TAG_CONTACT_POINTS

TAG_ACTIVE_PROFILE

KEY_ACTIVE_PROFILE

TAG_DBAAS_CONNECTION

Method Detail

parseURL

createSubName

parseReconnectionPolicy