PdbProperties (pdb 2.2.2 API)

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>
```
public class PdbProperties
extends java.util.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 java.lang.String`	`ALLOW_COLUMN_DROP` Property to allow column drops on entity updates.
`static java.lang.String`	`BLOB_BUFFER_SIZE` The blob buffer size property
`static java.lang.String`	`COMPRESS_LOBS` Property that indicates the lobs should be compressed.
`static java.lang.String`	`DRIVER` The database driver.
`static java.lang.String`	`ENCRYPTED_PASSWORD` The property for using encrypted passwords.
`static java.lang.String`	`ENCRYPTED_USERNAME` The property for using encrypted usernames.
`static java.lang.String`	`ENGINE` The engine property.
`static java.lang.String`	`FETCH_SIZE` Property that indicates the fetch size for queries.
`static java.lang.String`	`ISOLATION_LEVEL` The default isolation level.
`static java.lang.String`	`JDBC` The JDBC property name.
`static java.lang.String`	`MAX_BLOB_SIZE` The maximum blob size property
`static java.lang.String`	`MAX_IDENTIFIER_SIZE` The maximum identifier size property
`static java.lang.String`	`MAX_NUMBER_OF_RETRIES` The maximum number of retries.
`static java.lang.String`	`MAXIMUM_TIME_BATCH_SHUTDOWN` Property that indicates how much time to wait for a batch to shutdown.
`static java.lang.String`	`PASSWORD` The PASSWORD property name.
`static java.lang.String`	`RECONNECT_ON_LOST` The property of reconnection.
`static java.lang.String`	`RETRY_INTERVAL` The retry interval.
`static java.lang.String`	`SCHEMA` Database schema property name.
`static java.lang.String`	`SCHEMA_POLICY` Schema policy property name.
`static java.lang.String`	`SECRET_LOCATION` The location of the private key for passwords.
`static java.lang.String`	`TRANSLATOR` The translator.
`static java.lang.String`	`USERNAME` The USERNAME property name.
`static java.lang.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(java.util.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.
`java.lang.String`	`getDriver()` Gets the driver property.
`java.lang.String`	`getEngine()` Gets the engine.
`int`	`getFetchSize()` Gets the fetch size.
`int`	`getIsolationLevel()` Gets the isolation level.
`java.lang.String`	`getJdbc()` Gets the JDBC URL.
`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.
`java.lang.String`	`getPassword()` Gets the password.
`long`	`getRetryInterval()` Gets the retry interval.
`java.lang.String`	`getSchema()` Gets the database schema.
`java.lang.String`	`getTranslator()` Gets the translator class.
`java.lang.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`	`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(java.util.Properties properties)` Merges properties with the existing ones.
`void`	`setProperty(java.lang.String key, java.lang.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 java.lang.String JDBC
```
    The JDBC property name.
    
    See Also:
    
    Constant Field Values
  - USERNAME
```
public static final java.lang.String USERNAME
```
    The USERNAME property name.
    
    See Also:
    
    Constant Field Values
  - PASSWORD
```
public static final java.lang.String PASSWORD
```
    The PASSWORD property name.
    
    See Also:
    
    Constant Field Values
  - VARCHAR_SIZE
```
public static final java.lang.String VARCHAR_SIZE
```
    VARCHAR size property name.
    
    See Also:
    
    Constant Field Values
  - SCHEMA_POLICY
```
public static final java.lang.String SCHEMA_POLICY
```
    Schema policy property name.
    
    See Also:
    
    Constant Field Values
  - ENGINE
```
public static final java.lang.String ENGINE
```
    The engine property.
    
    See Also:
    
    Constant Field Values
  - TRANSLATOR
```
public static final java.lang.String TRANSLATOR
```
    The translator.
    
    See Also:
    
    Constant Field Values
  - SCHEMA
```
public static final java.lang.String SCHEMA
```
    Database schema property name.
    
    See Also:
    
    Constant Field Values
  - MAX_IDENTIFIER_SIZE
```
public static final java.lang.String MAX_IDENTIFIER_SIZE
```
    The maximum identifier size property
    
    See Also:
    
    Constant Field Values
  - MAX_BLOB_SIZE
```
public static final java.lang.String MAX_BLOB_SIZE
```
    The maximum blob size property
    
    See Also:
    
    Constant Field Values
  - BLOB_BUFFER_SIZE
```
public static final java.lang.String BLOB_BUFFER_SIZE
```
    The blob buffer size property
    
    See Also:
    
    Constant Field Values
  - MAX_NUMBER_OF_RETRIES
```
public static final java.lang.String MAX_NUMBER_OF_RETRIES
```
    The maximum number of retries.
    
    See Also:
    
    Constant Field Values
  - RETRY_INTERVAL
```
public static final java.lang.String RETRY_INTERVAL
```
    The retry interval.
    
    See Also:
    
    Constant Field Values
  - ISOLATION_LEVEL
```
public static final java.lang.String ISOLATION_LEVEL
```
    The default isolation level.
    
    See Also:
    
    Constant Field Values
  - DRIVER
```
public static final java.lang.String DRIVER
```
    The database driver.
    
    See Also:
    
    Constant Field Values
  - RECONNECT_ON_LOST
```
public static final java.lang.String RECONNECT_ON_LOST
```
    The property of reconnection.
    
    See Also:
    
    Constant Field Values
  - ENCRYPTED_PASSWORD
```
public static final java.lang.String ENCRYPTED_PASSWORD
```
    The property for using encrypted passwords.
    
    See Also:
    
    Constant Field Values
  - SECRET_LOCATION
```
public static final java.lang.String SECRET_LOCATION
```
    The location of the private key for passwords.
    
    See Also:
    
    Constant Field Values
  - ENCRYPTED_USERNAME
```
public static final java.lang.String ENCRYPTED_USERNAME
```
    The property for using encrypted usernames.
    
    See Also:
    
    Constant Field Values
  - ALLOW_COLUMN_DROP
```
public static final java.lang.String ALLOW_COLUMN_DROP
```
    Property to allow column drops on entity updates.
    
    See Also:
    
    Constant Field Values
  - FETCH_SIZE
```
public static final java.lang.String FETCH_SIZE
```
    Property that indicates the fetch size for queries.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_TIME_BATCH_SHUTDOWN
```
public static final java.lang.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 java.lang.String COMPRESS_LOBS
```
    Property that indicates the lobs should be compressed. This depends on the database implementation.
    
    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(java.util.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(java.lang.String key,
                        java.lang.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(java.util.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.
  - getIsolationLevel
```
public int getIsolationLevel()
```
    Gets the isolation level.
    
    Returns:
    
    The isolation level.
  - getJdbc
```
public java.lang.String getJdbc()
```
    Gets the JDBC URL.
    
    Returns:
    
    The JDBC URL.
  - getUsername
```
public java.lang.String getUsername()
```
    Gets the username.
    
    Returns:
    
    The username.
  - getPassword
```
public java.lang.String getPassword()
```
    Gets the password.
    
    Returns:
    
    The password.
  - getEngine
```
public java.lang.String getEngine()
```
    Gets the engine.
    
    Returns:
    
    The engine.
  - getTranslator
```
public java.lang.String getTranslator()
```
    Gets the translator class.
    
    Returns:
    
    The translator class.
  - getSchema
```
public java.lang.String getSchema()
```
    Gets the database schema.
    
    Returns:
    
    The database schema.
  - 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 java.util.Hashtable<java.lang.Object,java.lang.Object>
    
    Returns:
    
    The new instance of the object to be cloned.
  - getDriver
```
public java.lang.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

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

getIsolationLevel

getJdbc

getUsername

getPassword

getEngine

getTranslator

getSchema

isDriverSet

isSchemaSet

allowColumnDrop

checkMandatoryProperties

clone

getDriver