PdbProperties (pdb 2.8.18 API)

java.lang.Object
- java.util.Dictionary<K,V>
- - java.util.Hashtable<Object,Object>
  - - java.util.Properties
    - - com.feedzai.commons.sql.abstraction.engine.configuration.PdbProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>
```
public class PdbProperties
extends Properties
implements Cloneable<PdbProperties>
```
Represents the possible properties to include when configuring the engine.

Since:

2.0.0

Author:

Rui Vilao (rui.vilao@feedzai.com)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALLOW_COLUMN_DROP` Property to allow column drops on entity updates.
`static String`	`BLOB_BUFFER_SIZE` The blob buffer size property
`static String`	`CHECK_CONNECTION_TIMEOUT` Property that indicates the maximum time taken when checking if a connection is available.
`static String`	`COMPRESS_LOBS` Property that indicates the lobs should be compressed.
`static String`	`DISABLE_LOB_CACHING` Property that indicates if LOB data caching should be disabled, to avoid consuming too much memory and/or disk space in the DB server.
`static String`	`DRIVER` The database driver.
`static String`	`ENCRYPTED_PASSWORD` The property for using encrypted passwords.
`static String`	`ENCRYPTED_USERNAME` The property for using encrypted usernames.
`static String`	`ENGINE` The engine property.
`static String`	`FETCH_SIZE` Property that indicates the fetch size for queries.
`static String`	`ISOLATION_LEVEL` The default isolation level.
`static String`	`JDBC` The JDBC property name.
`static String`	`LOGIN_TIMEOUT` Property that indicates the waiting time for the database connection to be established (in seconds).
`static String`	`MAX_BLOB_SIZE` The maximum blob size property
`static String`	`MAX_IDENTIFIER_SIZE` The maximum identifier size property
`static String`	`MAX_NUMBER_OF_RETRIES` The maximum number of retries.
`static String`	`MAXIMUM_TIME_BATCH_SHUTDOWN` Property that indicates how much time to wait for a batch to shutdown.
`static String`	`PASSWORD` The PASSWORD property name.
`static String`	`RECONNECT_ON_LOST` The property of reconnection.
`static String`	`RETRY_INTERVAL` The retry interval.
`static String`	`SCHEMA` Database schema property name.
`static String`	`SCHEMA_POLICY` Schema policy property name.
`static String`	`SECRET_LOCATION` The location of the private key for passwords.
`static String`	`SELECT_QUERY_TIMEOUT` Property that indicates the maximum time a select query is allowed to run, in seconds.
`static String`	`SOCKET_TIMEOUT` Property that indicates the time, in seconds, of socket timeout.
`static String`	`TRANSLATOR` The translator.
`static String`	`USERNAME` The USERNAME property name.
`static String`	`VARCHAR_SIZE` VARCHAR size property name.

Fields inherited from class java.util.Properties
defaults

Constructor Summary

Constructors
Constructor and Description
`PdbProperties()` Creates a new instance of an empty `PdbProperties`.
`PdbProperties(boolean useDefaults)` Creates a new instance of `PdbProperties` with the default configuration.
`PdbProperties(Properties properties, boolean useDefaults)` Merges the given properties with the default configuration.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allowColumnDrop()` Checks if column drop is allowed when the schema changes.
`void`	`checkMandatoryProperties()` Checks if the configuration validates for mandatory properties.
`PdbProperties`	`clone()` Clones an object.
`int`	`getBlobBufferSize()` Gets the blob buffer size.
`int`	`getCheckConnectionTimeout()` Gets the check connection timeout (in seconds).
`String`	`getDriver()` Gets the driver property.
`String`	`getEngine()` Gets the engine.
`int`	`getFetchSize()` Gets the fetch size.
`int`	`getIsolationLevel()` Gets the isolation level.
`String`	`getJdbc()` Gets the JDBC URL.
`int`	`getLoginTimeout()` Gets the socket login timeout (in seconds).
`int`	`getMaxBlobSize()` Gets the maximum blob size.
`int`	`getMaxIdentifierSize()` Gets the maximum identifier size.
`long`	`getMaximumAwaitTimeBatchShutdown()` Gets the maximum await time for batches to shutdown.
`int`	`getMaxRetries()` Gets the maximum number of retries.
`String`	`getPassword()` Gets the password.
`long`	`getRetryInterval()` Gets the retry interval.
`String`	`getSchema()` Gets the database schema.
`int`	`getSelectQueryTimeout()` Gets the query select timeout (in seconds).
`int`	`getSocketTimeout()` Gets the socket connection timeout (in seconds).
`String`	`getTranslator()` Gets the translator class.
`String`	`getUsername()` Gets the username.
`boolean`	`isDriverSet()` Checks if the driver property is set.
`boolean`	`isEncryptedPassword()` Checks if password encryption is set.
`boolean`	`isEncryptedUsername()` Checks if username encryption is set.
`boolean`	`isLobCachingDisabled()` Checks if LOB data caching should be disabled.
`boolean`	`isMaxBlobSizeSet()` Checks if the `getMaxBlobSize()` is set.
`boolean`	`isReconnectOnLost()` Checks if reconnect on connection lost is set.
`boolean`	`isSchemaPolicyCreate()` Checks if the schema policy is CREATE.
`boolean`	`isSchemaPolicyCreateDrop()` Checks if schema policy is CREATE DROP.
`boolean`	`isSchemaPolicyDropCreate()` Checks if schema policy is DROP CREATE.
`boolean`	`isSchemaPolicyNone()` Checks if schema policy is NONE.
`boolean`	`isSchemaSet()` Checks if the the schema is set.
`boolean`	`isTranslatorSet()` Checks if a provided translator class is set.
`void`	`merge(Properties properties)` Merges properties with the existing ones.
`void`	`setProperty(String key, Object o)` Adds a property object by converting it to string.
`boolean`	`shouldCompressLobs()` Checks if LOBS columns should be compressed.

Methods inherited from class java.util.Properties
getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable
clear, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

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

- Field Detail
  - JDBC
```
public static final String JDBC
```
    The JDBC property name.
    
    See Also:
    
    Constant Field Values
  - USERNAME
```
public static final String USERNAME
```
    The USERNAME property name.
    
    See Also:
    
    Constant Field Values
  - PASSWORD
```
public static final String PASSWORD
```
    The PASSWORD property name.
    
    See Also:
    
    Constant Field Values
  - VARCHAR_SIZE
```
public static final String VARCHAR_SIZE
```
    VARCHAR size property name.
    
    See Also:
    
    Constant Field Values
  - SCHEMA_POLICY
```
public static final String SCHEMA_POLICY
```
    Schema policy property name.
    
    See Also:
    
    Constant Field Values
  - ENGINE
```
public static final String ENGINE
```
    The engine property.
    
    See Also:
    
    Constant Field Values
  - TRANSLATOR
```
public static final String TRANSLATOR
```
    The translator.
    
    See Also:
    
    Constant Field Values
  - SCHEMA
```
public static final String SCHEMA
```
    Database schema property name.
    
    See Also:
    
    Constant Field Values
  - MAX_IDENTIFIER_SIZE
```
public static final String MAX_IDENTIFIER_SIZE
```
    The maximum identifier size property
    
    See Also:
    
    Constant Field Values
  - MAX_BLOB_SIZE
```
public static final String MAX_BLOB_SIZE
```
    The maximum blob size property
    
    See Also:
    
    Constant Field Values
  - BLOB_BUFFER_SIZE
```
public static final String BLOB_BUFFER_SIZE
```
    The blob buffer size property
    
    See Also:
    
    Constant Field Values
  - MAX_NUMBER_OF_RETRIES
```
public static final String MAX_NUMBER_OF_RETRIES
```
    The maximum number of retries.
    
    See Also:
    
    Constant Field Values
  - RETRY_INTERVAL
```
public static final String RETRY_INTERVAL
```
    The retry interval.
    
    See Also:
    
    Constant Field Values
  - ISOLATION_LEVEL
```
public static final String ISOLATION_LEVEL
```
    The default isolation level.
    
    See Also:
    
    Constant Field Values
  - DRIVER
```
public static final String DRIVER
```
    The database driver.
    
    See Also:
    
    Constant Field Values
  - RECONNECT_ON_LOST
```
public static final String RECONNECT_ON_LOST
```
    The property of reconnection.
    
    See Also:
    
    Constant Field Values
  - ENCRYPTED_PASSWORD
```
public static final String ENCRYPTED_PASSWORD
```
    The property for using encrypted passwords.
    
    See Also:
    
    Constant Field Values
  - SECRET_LOCATION
```
public static final String SECRET_LOCATION
```
    The location of the private key for passwords.
    
    See Also:
    
    Constant Field Values
  - ENCRYPTED_USERNAME
```
public static final String ENCRYPTED_USERNAME
```
    The property for using encrypted usernames.
    
    See Also:
    
    Constant Field Values
  - ALLOW_COLUMN_DROP
```
public static final String ALLOW_COLUMN_DROP
```
    Property to allow column drops on entity updates.
    
    See Also:
    
    Constant Field Values
  - FETCH_SIZE
```
public static final String FETCH_SIZE
```
    Property that indicates the fetch size for queries.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_TIME_BATCH_SHUTDOWN
```
public static final String MAXIMUM_TIME_BATCH_SHUTDOWN
```
    Property that indicates how much time to wait for a batch to shutdown.
    
    See Also:
    
    Constant Field Values
  - COMPRESS_LOBS
```
public static final String COMPRESS_LOBS
```
    Property that indicates the lobs should be compressed. This depends on the database implementation.
    
    See Also:
    
    Constant Field Values
  - DISABLE_LOB_CACHING
```
public static final String DISABLE_LOB_CACHING
```
    Property that indicates if LOB data caching should be disabled, to avoid consuming too much memory and/or disk space in the DB server. This depends on the database implementation.
    
    See Also:
    
    Constant Field Values
  - LOGIN_TIMEOUT
```
public static final String LOGIN_TIMEOUT
```
    Property that indicates the waiting time for the database connection to be established (in seconds). In some drivers this may refer only to the login timeout, in others it may refer to the total time to wait for getting a connection in addition to logging in.
    
    See Also:
    
    Constant Field Values
  - SOCKET_TIMEOUT
```
public static final String SOCKET_TIMEOUT
```
    Property that indicates the time, in seconds, of socket timeout.
    
    See Also:
    
    Constant Field Values
  - SELECT_QUERY_TIMEOUT
```
public static final String SELECT_QUERY_TIMEOUT
```
    Property that indicates the maximum time a select query is allowed to run, in seconds. No limit if zero. See Statement.setQueryTimeout(int).
    
    See Also:
    
    Constant Field Values
  - CHECK_CONNECTION_TIMEOUT
```
public static final String CHECK_CONNECTION_TIMEOUT
```
    Property that indicates the maximum time taken when checking if a connection is available.
    
    Since:
    
    2.7.2
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PdbProperties
```
public PdbProperties()
```
    Creates a new instance of an empty PdbProperties.
  - PdbProperties
```
public PdbProperties(boolean useDefaults)
```
    Creates a new instance of PdbProperties with the default configuration.
    
    Parameters:
    
    useDefaults - true if default properties are to be set, false otherwise.
  - PdbProperties
```
public PdbProperties(Properties properties,
                     boolean useDefaults)
```
    Merges the given properties with the default configuration.
    
    Parameters:
    
    properties - The properties to merge.
    
    useDefaults - true if default properties are to be set, false otherwise.
- Method Detail
  - setProperty
```
public void setProperty(String key,
                        Object o)
```
    Adds a property object by converting it to string.
    
    Parameters:
    
    key - The key.
    
    o - The object to add.
  - merge
```
public final void merge(Properties properties)
```
    Merges properties with the existing ones.
    
    Parameters:
    
    properties - The properties to merge.
  - isTranslatorSet
```
public boolean isTranslatorSet()
```
    Checks if a provided translator class is set.
    
    Returns:
    
    true if a provided translator class is set, false otherwise.
  - isEncryptedUsername
```
public boolean isEncryptedUsername()
```
    Checks if username encryption is set.
    
    Returns:
    
    true if username encryption is set, false otherwise.
  - isEncryptedPassword
```
public boolean isEncryptedPassword()
```
    Checks if password encryption is set.
    
    Returns:
    
    true if password encryption is set, false otherwise.
  - getFetchSize
```
public int getFetchSize()
```
    Gets the fetch size.
    
    Returns:
    
    the fetch size.
  - getMaximumAwaitTimeBatchShutdown
```
public long getMaximumAwaitTimeBatchShutdown()
```
    Gets the maximum await time for batches to shutdown.
    
    Returns:
    
    The maximum await time for batches to shutdown.
  - isSchemaPolicyCreateDrop
```
public boolean isSchemaPolicyCreateDrop()
```
    Checks if schema policy is CREATE DROP.
    
    Returns:
    
    true if the schema is create-drop, false otherwise.
  - isSchemaPolicyDropCreate
```
public boolean isSchemaPolicyDropCreate()
```
    Checks if schema policy is DROP CREATE.
    
    Returns:
    
    true if the schema is drop-create, false otherwise.
  - isSchemaPolicyCreate
```
public boolean isSchemaPolicyCreate()
```
    Checks if the schema policy is CREATE.
    
    Returns:
    
    true if the schema is create, false otherwise.
  - isSchemaPolicyNone
```
public boolean isSchemaPolicyNone()
```
    Checks if schema policy is NONE.
    
    Returns:
    
    true if the schema is none, false otherwise.
  - getMaxIdentifierSize
```
public int getMaxIdentifierSize()
```
    Gets the maximum identifier size.
    
    Returns:
    
    Gets the maximum identifier size.
  - getMaxBlobSize
```
public int getMaxBlobSize()
```
    Gets the maximum blob size.
    
    Returns:
    
    Gets the maximum blob size.
  - isMaxBlobSizeSet
```
public boolean isMaxBlobSizeSet()
```
    Checks if the getMaxBlobSize() is set.
    
    Returns:
    
    true if the maximum blob size is set, false otherwise.
  - getBlobBufferSize
```
public int getBlobBufferSize()
```
    Gets the blob buffer size.
    
    Returns:
    
    The blob buffer size for Object -> ByteArray conversions.
  - getMaxRetries
```
public int getMaxRetries()
```
    Gets the maximum number of retries.
    
    Returns:
    
    Maximum number of retries.
  - getRetryInterval
```
public long getRetryInterval()
```
    Gets the retry interval.
    
    Returns:
    
    The retry interval.
  - isReconnectOnLost
```
public boolean isReconnectOnLost()
```
    Checks if reconnect on connection lost is set.
    
    Returns:
    
    true if the connection is uses reconnect on lost, false otherwise.
  - shouldCompressLobs
```
public boolean shouldCompressLobs()
```
    Checks if LOBS columns should be compressed.
    
    Returns:
    
    true if LOBS should be compressed, false otherwise.
  - isLobCachingDisabled
```
public boolean isLobCachingDisabled()
```
    Checks if LOB data caching should be disabled.
    
    Returns:
    
    true if LOB caching should be disabled, false otherwise.
  - getIsolationLevel
```
public int getIsolationLevel()
```
    Gets the isolation level.
    
    Returns:
    
    The isolation level.
  - getJdbc
```
public String getJdbc()
```
    Gets the JDBC URL.
    
    Returns:
    
    The JDBC URL.
  - getUsername
```
public String getUsername()
```
    Gets the username.
    
    Returns:
    
    The username.
  - getPassword
```
public String getPassword()
```
    Gets the password.
    
    Returns:
    
    The password.
  - getEngine
```
public String getEngine()
```
    Gets the engine.
    
    Returns:
    
    The engine.
  - getTranslator
```
public String getTranslator()
```
    Gets the translator class.
    
    Returns:
    
    The translator class.
  - getSchema
```
public String getSchema()
```
    Gets the database schema.
    
    Returns:
    
    The database schema.
  - getLoginTimeout
```
public int getLoginTimeout()
```
    Gets the socket login timeout (in seconds).
    
    Returns:
    
    The socket login timeout.
  - getSocketTimeout
```
public int getSocketTimeout()
```
    Gets the socket connection timeout (in seconds).
    
    Returns:
    
    The socket connection timeout.
  - getSelectQueryTimeout
```
public int getSelectQueryTimeout()
```
    Gets the query select timeout (in seconds).
    
    Returns:
    
    The query select timeout.
  - getCheckConnectionTimeout
```
public int getCheckConnectionTimeout()
```
    Gets the check connection timeout (in seconds).
    
    Returns:
    
    The check connection timeout.
    
    Since:
    
    2.7.2
  - isDriverSet
```
public boolean isDriverSet()
```
    Checks if the driver property is set.
    
    Returns:
    
    true if the driver property is set, false otherwise.
  - isSchemaSet
```
public boolean isSchemaSet()
```
    Checks if the the schema is set.
    
    Returns:
    
    true if the schema is set, false otherwise.
  - allowColumnDrop
```
public boolean allowColumnDrop()
```
    Checks if column drop is allowed when the schema changes.
    
    Returns:
    
    true if the column drop is allowed, false otherwise.
  - checkMandatoryProperties
```
public void checkMandatoryProperties()
                              throws PdbConfigurationException
```
    Checks if the configuration validates for mandatory properties.
    
    Throws:
    
    PdbConfigurationException - If mandatory fields are not set.
  - clone
```
public PdbProperties clone()
```
    Description copied from interface: Cloneable
    
    Clones an object.
    
    Overrides:
    
    clone in class Hashtable<Object,Object>
    
    Returns:
    
    The new instance of the object to be cloned.
  - getDriver
```
public String getDriver()
```
    Gets the driver property.
    
    Returns:
    
    The driver property.

Class PdbProperties

Field Summary

Fields inherited from class java.util.Properties

Constructor Summary

Method Summary

Methods inherited from class java.util.Properties

Methods inherited from class java.util.Hashtable

Methods inherited from class java.lang.Object

Field Detail

JDBC

USERNAME

PASSWORD

VARCHAR_SIZE

SCHEMA_POLICY

ENGINE

TRANSLATOR

SCHEMA

MAX_IDENTIFIER_SIZE

MAX_BLOB_SIZE

BLOB_BUFFER_SIZE

MAX_NUMBER_OF_RETRIES

RETRY_INTERVAL

ISOLATION_LEVEL

DRIVER

RECONNECT_ON_LOST

ENCRYPTED_PASSWORD

SECRET_LOCATION

ENCRYPTED_USERNAME

ALLOW_COLUMN_DROP

FETCH_SIZE

MAXIMUM_TIME_BATCH_SHUTDOWN

COMPRESS_LOBS

DISABLE_LOB_CACHING

LOGIN_TIMEOUT

SOCKET_TIMEOUT

SELECT_QUERY_TIMEOUT

CHECK_CONNECTION_TIMEOUT

Constructor Detail

PdbProperties

PdbProperties

PdbProperties

Method Detail

setProperty

merge

isTranslatorSet

isEncryptedUsername

isEncryptedPassword

getFetchSize

getMaximumAwaitTimeBatchShutdown

isSchemaPolicyCreateDrop

isSchemaPolicyDropCreate

isSchemaPolicyCreate

isSchemaPolicyNone

getMaxIdentifierSize

getMaxBlobSize

isMaxBlobSizeSet

getBlobBufferSize

getMaxRetries

getRetryInterval

isReconnectOnLost

shouldCompressLobs

isLobCachingDisabled

getIsolationLevel

getJdbc

getUsername

getPassword

getEngine

getTranslator

getSchema

getLoginTimeout

getSocketTimeout

getSelectQueryTimeout

getCheckConnectionTimeout

isDriverSet

isSchemaSet

allowColumnDrop

checkMandatoryProperties

clone

getDriver