BuiltInConnectionProperty (Apache Calcite Avatica API)

java.lang.Object
- java.lang.Enum<BuiltInConnectionProperty>
- - org.apache.calcite.avatica.BuiltInConnectionProperty

All Implemented Interfaces:

Serializable, Comparable<BuiltInConnectionProperty>, ConnectionProperty
```
public enum BuiltInConnectionProperty
extends Enum<BuiltInConnectionProperty>
implements ConnectionProperty
```
Enumeration of Avatica's built-in connection properties.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.calcite.avatica.ConnectionProperty
  ConnectionProperty.Type

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AUTHENTICATION` The type of authentication to be used
`AVATICA_PASSWORD` Avatica-based authentication password
`AVATICA_USER` Avatica-based authentication user name
`FACTORY` Factory.
`FETCH_SIZE` Number of rows to fetch per call.
`HOSTNAME_VERIFICATION`
`HTTP_CLIENT_FACTORY` Factory for constructing http clients.
`HTTP_CLIENT_IMPL` HttpClient implementation class name.
`HTTP_CONNECTION_TIMEOUT` HTTP Connection Timeout in milliseconds.
`HTTP_RESPONSE_TIMEOUT` HTTP Response Timeout (socket timeout) in milliseconds.
`KEY_PASSWORD` Password for the key inside keystore
`KEYSTORE` Keystore for MTLS authentication
`KEYSTORE_PASSWORD` Password for the keystore
`KEYSTORE_TYPE` Keystore type (applies both to key and truststores)
`KEYTAB` Keytab to use to perform Kerberos login.
`LB_CONNECTION_FAILOVER_RETRIES` The number of retries we need for failover during client side load balancing.
`LB_CONNECTION_FAILOVER_SLEEP_TIME` The amount of time in millis that the driver should wait before attempting connection failover
`LB_STRATEGY` Avatica connection HA property - Load balancing strategy
`LB_URLS` Avatica connection HA property - Load balanced URLs
`PRINCIPAL` Principal to use to perform Kerberos login.
`SCHEMA` Name of initial schema.
`SERIALIZATION` Serialization used over remote connections
`TIME_ZONE` Time zone, for example 'gmt-3'.
`TRANSPARENT_RECONNECTION`
`TRUSTSTORE` Truststore for SSL/TLS communication
`TRUSTSTORE_PASSWORD` Password for the truststore
`URL` Remote URL.
`USE_CLIENT_SIDE_LB` Avatica connection HA property - use client side load balancing

Field Summary

Fields
Modifier and Type Field and Description

static BuiltInConnectionProperty TIMEZONE
Deprecated.

Fields
Modifier and Type	Field and Description
`static BuiltInConnectionProperty`	`TIMEZONE` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`camelName()` The name of this property in camel-case.
`Object`	`defaultValue()` Returns the default value of this property.
`static boolean`	`isLocalProperty(Object propertyName)` Checks if the given property only applicable to the remote driver (should not be sent to the Avatica server).
`boolean`	`required()` Whether the property is mandatory.
`ConnectionProperty.Type`	`type()` Returns the data type of this property.
`Class`	`valueClass()` Class of values that this property can take.
`static BuiltInConnectionProperty`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static BuiltInConnectionProperty[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.
`ConnectionConfigImpl.PropEnv`	`wrap(Properties properties)` Wraps this property with a properties object from which its value can be obtained when needed.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.calcite.avatica.ConnectionProperty
name

- Enum Constant Detail
  - FACTORY
```
public static final BuiltInConnectionProperty FACTORY
```
    Factory.
  - SCHEMA
```
public static final BuiltInConnectionProperty SCHEMA
```
    Name of initial schema.
  - TIME_ZONE
```
public static final BuiltInConnectionProperty TIME_ZONE
```
    Time zone, for example 'gmt-3'. Default is the JVM's time zone.
  - URL
```
public static final BuiltInConnectionProperty URL
```
    Remote URL.
  - SERIALIZATION
```
public static final BuiltInConnectionProperty SERIALIZATION
```
    Serialization used over remote connections
  - AUTHENTICATION
```
public static final BuiltInConnectionProperty AUTHENTICATION
```
    The type of authentication to be used
  - AVATICA_USER
```
public static final BuiltInConnectionProperty AVATICA_USER
```
    Avatica-based authentication user name
  - AVATICA_PASSWORD
```
public static final BuiltInConnectionProperty AVATICA_PASSWORD
```
    Avatica-based authentication password
  - HTTP_CLIENT_FACTORY
```
public static final BuiltInConnectionProperty HTTP_CLIENT_FACTORY
```
    Factory for constructing http clients.
  - HTTP_CLIENT_IMPL
```
public static final BuiltInConnectionProperty HTTP_CLIENT_IMPL
```
    HttpClient implementation class name.
  - PRINCIPAL
```
public static final BuiltInConnectionProperty PRINCIPAL
```
    Principal to use to perform Kerberos login.
  - KEYTAB
```
public static final BuiltInConnectionProperty KEYTAB
```
    Keytab to use to perform Kerberos login.
  - TRUSTSTORE
```
public static final BuiltInConnectionProperty TRUSTSTORE
```
    Truststore for SSL/TLS communication
  - TRUSTSTORE_PASSWORD
```
public static final BuiltInConnectionProperty TRUSTSTORE_PASSWORD
```
    Password for the truststore
  - KEYSTORE_TYPE
```
public static final BuiltInConnectionProperty KEYSTORE_TYPE
```
    Keystore type (applies both to key and truststores)
  - KEYSTORE
```
public static final BuiltInConnectionProperty KEYSTORE
```
    Keystore for MTLS authentication
  - KEYSTORE_PASSWORD
```
public static final BuiltInConnectionProperty KEYSTORE_PASSWORD
```
    Password for the keystore
  - KEY_PASSWORD
```
public static final BuiltInConnectionProperty KEY_PASSWORD
```
    Password for the key inside keystore
  - HOSTNAME_VERIFICATION
```
public static final BuiltInConnectionProperty HOSTNAME_VERIFICATION
```
  - TRANSPARENT_RECONNECTION
```
public static final BuiltInConnectionProperty TRANSPARENT_RECONNECTION
```
  - FETCH_SIZE
```
public static final BuiltInConnectionProperty FETCH_SIZE
```
    Number of rows to fetch per call.
  - USE_CLIENT_SIDE_LB
```
public static final BuiltInConnectionProperty USE_CLIENT_SIDE_LB
```
    Avatica connection HA property - use client side load balancing
  - LB_URLS
```
public static final BuiltInConnectionProperty LB_URLS
```
    Avatica connection HA property - Load balanced URLs
  - LB_STRATEGY
```
public static final BuiltInConnectionProperty LB_STRATEGY
```
    Avatica connection HA property - Load balancing strategy
  - LB_CONNECTION_FAILOVER_RETRIES
```
public static final BuiltInConnectionProperty LB_CONNECTION_FAILOVER_RETRIES
```
    The number of retries we need for failover during client side load balancing.
  - LB_CONNECTION_FAILOVER_SLEEP_TIME
```
public static final BuiltInConnectionProperty LB_CONNECTION_FAILOVER_SLEEP_TIME
```
    The amount of time in millis that the driver should wait before attempting connection failover
  - HTTP_CONNECTION_TIMEOUT
```
public static final BuiltInConnectionProperty HTTP_CONNECTION_TIMEOUT
```
    HTTP Connection Timeout in milliseconds.
  - HTTP_RESPONSE_TIMEOUT
```
public static final BuiltInConnectionProperty HTTP_RESPONSE_TIMEOUT
```
    HTTP Response Timeout (socket timeout) in milliseconds.
- Field Detail
  - TIMEZONE
```
@Deprecated
public static final BuiltInConnectionProperty TIMEZONE
```
    Deprecated.
    
    Deprecated; use TIME_ZONE.
- Method Detail
  - values
```
public static BuiltInConnectionProperty[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (BuiltInConnectionProperty c : BuiltInConnectionProperty.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BuiltInConnectionProperty valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - camelName
```
public String camelName()
```
    Description copied from interface: ConnectionProperty
    
    The name of this property in camel-case. (E.g. "materializationsEnabled".)
    
    Specified by:
    
    camelName in interface ConnectionProperty
  - defaultValue
```
public Object defaultValue()
```
    Description copied from interface: ConnectionProperty
    
    Returns the default value of this property. The type must match its data type.
    
    Specified by:
    
    defaultValue in interface ConnectionProperty
  - type
```
public ConnectionProperty.Type type()
```
    Description copied from interface: ConnectionProperty
    
    Returns the data type of this property.
    
    Specified by:
    
    type in interface ConnectionProperty
  - required
```
public boolean required()
```
    Description copied from interface: ConnectionProperty
    
    Whether the property is mandatory.
    
    Specified by:
    
    required in interface ConnectionProperty
  - valueClass
```
public Class valueClass()
```
    Description copied from interface: ConnectionProperty
    
    Class of values that this property can take. Most useful for ConnectionProperty.Type.ENUM properties.
    
    Specified by:
    
    valueClass in interface ConnectionProperty
  - wrap
```
public ConnectionConfigImpl.PropEnv wrap(Properties properties)
```
    Description copied from interface: ConnectionProperty
    
    Wraps this property with a properties object from which its value can be obtained when needed.
    
    Specified by:
    
    wrap in interface ConnectionProperty
  - isLocalProperty
```
public static boolean isLocalProperty(Object propertyName)
```
    Checks if the given property only applicable to the remote driver (should not be sent to the Avatica server).
    
    Parameters:
    
    propertyName - Name of the property
    
    Returns:
    
    True if the property denoted by the given name is only relevant locally, otherwise false.

Enum BuiltInConnectionProperty

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.calcite.avatica.ConnectionProperty

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.calcite.avatica.ConnectionProperty

Enum Constant Detail

FACTORY

SCHEMA

TIME_ZONE

URL

SERIALIZATION

AUTHENTICATION

AVATICA_USER

AVATICA_PASSWORD

HTTP_CLIENT_FACTORY

HTTP_CLIENT_IMPL

PRINCIPAL

KEYTAB

TRUSTSTORE

TRUSTSTORE_PASSWORD

KEYSTORE_TYPE

KEYSTORE

KEYSTORE_PASSWORD

KEY_PASSWORD

HOSTNAME_VERIFICATION

TRANSPARENT_RECONNECTION

FETCH_SIZE

USE_CLIENT_SIDE_LB

LB_URLS

LB_STRATEGY

LB_CONNECTION_FAILOVER_RETRIES

LB_CONNECTION_FAILOVER_SLEEP_TIME

HTTP_CONNECTION_TIMEOUT

HTTP_RESPONSE_TIMEOUT

Field Detail

TIMEZONE

Method Detail

values

valueOf

camelName

defaultValue

type

required

valueClass

wrap

isLocalProperty