AdapterProperties (Common module of Exasol Virtual Schemas Adapters 5.0.0 API)

java.lang.Object
- com.exasol.adapter.AbstractAdapterProperties
- - com.exasol.adapter.AdapterProperties

```
public class AdapterProperties
extends AbstractAdapterProperties
```
The main job of this class is to turn user-defined key-value-pairs into concrete properties that the adapter knows. This improves the code readability and robustness.
It is still possible to access the raw keys and values in order to support properties that are specific to an adapter type an can therefore not be covered in the common module.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CATALOG_NAME_PROPERTY`
`static String`	`CONNECTION_NAME_PROPERTY`
`static String`	`CONNECTION_STRING_PROPERTY`
`static String`	`DEBUG_ADDRESS_PROPERTY`
`static String`	`EXCEPTION_HANDLING_PROPERTY`
`static String`	`EXCLUDED_CAPABILITIES_PROPERTY`
`static String`	`IGNORE_ERRORS_PROPERTY`
`static String`	`IS_LOCAL_PROPERTY`
`static String`	`LOG_LEVEL_PROPERTY`
`static String`	`PASSWORD_PROPERTY`
`static String`	`SCHEMA_NAME_PROPERTY`
`static String`	`SQL_DIALECT_PROPERTY`
`static String`	`TABLE_FILTER_PROPERTY`
`static String`	`USERNAME_PROPERTY`

Constructor Summary

Constructors
Constructor and Description

AdapterProperties(Map<String,String> properties)
Create a new instance of AdapterProperties

Constructors
Constructor and Description
`AdapterProperties(Map<String,String> properties)` Create a new instance of `AdapterProperties`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AdapterProperties`	`emptyProperties()` Get empty map
`String`	`getCatalogName()` Get the catalog name
`String`	`getConnectionName()` Get the connection name
`String`	`getConnectionString()` Get the connection string
`String`	`getDebugAddress()` Get the debug address
`String`	`getExceptionHandling()` Get the exception handling
`String`	`getExcludedCapabilities()` Get the excluded capabilities
`List<String>`	`getFilteredTables()` Get the list of tables for which the metadata will be read from the remote source
`List<String>`	`getIgnoredErrors()` Get the list of ignored errors
`String`	`getLogLevel()` Get the log level
`String`	`getPassword()` Get the password
`String`	`getSchemaName()` Get the schema name
`String`	`getSqlDialect()` Get the sql dialect
`String`	`getUsername()` Get the user name
`boolean`	`isLocalSource()` Check if the data source is the local Exasol instance
`static boolean`	`isRefreshingVirtualSchemaRequired(Map<String,String> changedProperties)` Check whether any of the given properties causes a refresh of the virtual schema

Methods inherited from class com.exasol.adapter.AbstractAdapterProperties
containsKey, entrySet, equals, get, hashCode, isEmpty, isEnabled, keySet, values

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

- Field Detail
  - TABLE_FILTER_PROPERTY
```
public static final String TABLE_FILTER_PROPERTY
```
    See Also:
    
    Constant Field Values
  - CATALOG_NAME_PROPERTY
```
public static final String CATALOG_NAME_PROPERTY
```
    See Also:
    
    Constant Field Values
  - SCHEMA_NAME_PROPERTY
```
public static final String SCHEMA_NAME_PROPERTY
```
    See Also:
    
    Constant Field Values
  - CONNECTION_NAME_PROPERTY
```
public static final String CONNECTION_NAME_PROPERTY
```
    See Also:
    
    Constant Field Values
  - CONNECTION_STRING_PROPERTY
```
public static final String CONNECTION_STRING_PROPERTY
```
    See Also:
    
    Constant Field Values
  - DEBUG_ADDRESS_PROPERTY
```
public static final String DEBUG_ADDRESS_PROPERTY
```
    See Also:
    
    Constant Field Values
  - LOG_LEVEL_PROPERTY
```
public static final String LOG_LEVEL_PROPERTY
```
    See Also:
    
    Constant Field Values
  - SQL_DIALECT_PROPERTY
```
public static final String SQL_DIALECT_PROPERTY
```
    See Also:
    
    Constant Field Values
  - EXCLUDED_CAPABILITIES_PROPERTY
```
public static final String EXCLUDED_CAPABILITIES_PROPERTY
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_HANDLING_PROPERTY
```
public static final String EXCEPTION_HANDLING_PROPERTY
```
    See Also:
    
    Constant Field Values
  - IGNORE_ERRORS_PROPERTY
```
public static final String IGNORE_ERRORS_PROPERTY
```
    See Also:
    
    Constant Field Values
  - IS_LOCAL_PROPERTY
```
public static final String IS_LOCAL_PROPERTY
```
    See Also:
    
    Constant Field Values
  - USERNAME_PROPERTY
```
public static final String USERNAME_PROPERTY
```
    See Also:
    
    Constant Field Values
  - PASSWORD_PROPERTY
```
public static final String PASSWORD_PROPERTY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AdapterProperties
```
public AdapterProperties(Map<String,String> properties)
```
    Create a new instance of AdapterProperties
    
    Parameters:
    
    properties - adapter properties
- Method Detail
  - getCatalogName
```
public String getCatalogName()
```
    Get the catalog name
    
    Returns:
    
    catalog name
  - getSchemaName
```
public String getSchemaName()
```
    Get the schema name
    
    Returns:
    
    schema name
  - getConnectionName
```
public String getConnectionName()
```
    Get the connection name
    
    Returns:
    
    connection name
  - getConnectionString
```
public String getConnectionString()
```
    Get the connection string
    
    Returns:
    
    connection string
  - getUsername
```
public String getUsername()
```
    Get the user name
    
    Returns:
    
    user name
  - getPassword
```
public String getPassword()
```
    Get the password
    
    Returns:
    
    password
  - getDebugAddress
```
public String getDebugAddress()
```
    Get the debug address
    
    Returns:
    
    debug address
  - getLogLevel
```
public String getLogLevel()
```
    Get the log level
    
    Returns:
    
    log level
  - getSqlDialect
```
public String getSqlDialect()
```
    Get the sql dialect
    
    Returns:
    
    sql dialect
  - getExcludedCapabilities
```
public String getExcludedCapabilities()
```
    Get the excluded capabilities
    
    Returns:
    
    excluded capabilities
  - getExceptionHandling
```
public String getExceptionHandling()
```
    Get the exception handling
    
    Returns:
    
    exception handling
  - getIgnoredErrors
```
public List<String> getIgnoredErrors()
```
    Get the list of ignored errors
    
    Returns:
    
    list of ignored errors
  - getFilteredTables
```
public List<String> getFilteredTables()
```
    Get the list of tables for which the metadata will be read from the remote source
    
    Returns:
    
    list of tables serving as positive filter criteria
  - isRefreshingVirtualSchemaRequired
```
public static boolean isRefreshingVirtualSchemaRequired(Map<String,String> changedProperties)
```
    Check whether any of the given properties causes a refresh of the virtual schema
    
    Parameters:
    
    changedProperties - map of properties that were changed
    
    Returns:
    
    true if any of the changes makes refreshing the virtual schema necessary
  - emptyProperties
```
public static AdapterProperties emptyProperties()
```
    Get empty map
    
    Returns:
    
    empty map
  - isLocalSource
```
public boolean isLocalSource()
```
    Check if the data source is the local Exasol instance
    
    Returns:
    
    true if the data source and the database containing the Virtual Schema are hosted on the same Exasol cluster

Class AdapterProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.exasol.adapter.AbstractAdapterProperties

Methods inherited from class java.lang.Object

Field Detail

TABLE_FILTER_PROPERTY

CATALOG_NAME_PROPERTY

SCHEMA_NAME_PROPERTY

CONNECTION_NAME_PROPERTY

CONNECTION_STRING_PROPERTY

DEBUG_ADDRESS_PROPERTY

LOG_LEVEL_PROPERTY

SQL_DIALECT_PROPERTY

EXCLUDED_CAPABILITIES_PROPERTY

EXCEPTION_HANDLING_PROPERTY

IGNORE_ERRORS_PROPERTY

IS_LOCAL_PROPERTY

USERNAME_PROPERTY

PASSWORD_PROPERTY

Constructor Detail

AdapterProperties

Method Detail

getCatalogName

getSchemaName

getConnectionName

getConnectionString

getUsername

getPassword

getDebugAddress

getLogLevel

getSqlDialect

getExcludedCapabilities

getExceptionHandling

getIgnoredErrors

getFilteredTables

isRefreshingVirtualSchemaRequired

emptyProperties

isLocalSource