PdbProperties (pdb 1.0.1 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
```
Properties object to use.

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`	`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`	`ISOLATION_LEVEL` The default isolation level.
`static String`	`JDBC` The JDBC property name.
`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`	`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`	`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(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

Methods
Modifier and Type	Method and Description
`boolean`	`allowColumnDrop()`
`void`	`checkMandatoryProperties()` Method to check the mandatory fields.
`PdbProperties`	`clone()`
`boolean`	`existsSchema()`
`int`	`getBlobBufferSize()`
`String`	`getEngine()`
`int`	`getIsolationLevel()`
`String`	`getJdbc()`
`int`	`getMaxBlobSize()`
`int`	`getMaxIdentifierSize()`
`int`	`getMaxRetries()`
`String`	`getPassword()`
`long`	`getRetryInterval()`
`String`	`getSchema()`
`String`	`getUsername()`
`boolean`	`isEncryptedPassword()`
`boolean`	`isEncryptedUsername()`
`boolean`	`isMaxBlobSizeSet()`
`boolean`	`isReconnectOnLost()`
`boolean`	`isSchemaCreate()`
`boolean`	`isSchemaCreateDrop()`
`boolean`	`isSchemaDropCreate()`
`boolean`	`isSchemaNone()`
`void`	`merge(Properties properties)` Merge properties with the existing.

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, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, 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
  - 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
- Constructor Detail
  - 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.
  - 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.
- Method Detail
  - merge
```
public final void merge(Properties properties)
```
    Merge properties with the existing.
    
    Parameters:
    properties - The properties to merge.
  - isEncryptedUsername
```
public boolean isEncryptedUsername()
```
  - isEncryptedPassword
```
public boolean isEncryptedPassword()
```
  - isSchemaCreateDrop
```
public boolean isSchemaCreateDrop()
```
    Returns:
    True if the schema is create-drop.
  - isSchemaDropCreate
```
public boolean isSchemaDropCreate()
```
    Returns:
    True if the schema is drop-create.
  - isSchemaCreate
```
public boolean isSchemaCreate()
```
    Returns:
    True if the schema is create.
  - isSchemaNone
```
public boolean isSchemaNone()
```
    Returns:
    True if the schema is none.
  - getMaxIdentifierSize
```
public int getMaxIdentifierSize()
```
    Returns:
    Gets the maximum identifier size.
  - getMaxBlobSize
```
public int getMaxBlobSize()
```
    Returns:
    Gets the maximum blob size.
  - isMaxBlobSizeSet
```
public boolean isMaxBlobSizeSet()
```
    Returns:
    True if the maximum blob size is set, false otherwise.
  - getBlobBufferSize
```
public int getBlobBufferSize()
```
    Returns:
    The blob buffer size for Object -> ByteArray conversions.
  - getMaxRetries
```
public int getMaxRetries()
```
    Returns:
    Maximum number of retries.
  - getRetryInterval
```
public long getRetryInterval()
```
    Returns:
    The retry interval.
  - isReconnectOnLost
```
public boolean isReconnectOnLost()
```
    Returns:
    True if the connection is uses reconnect on lost, false otherwise.
  - getIsolationLevel
```
public int getIsolationLevel()
```
    Returns:
    The isolation level.
  - getJdbc
```
public String getJdbc()
```
    Returns:
    The JDBC URL.
  - getUsername
```
public String getUsername()
```
    Returns:
    The username.
  - getPassword
```
public String getPassword()
```
    Returns:
    The password.
  - getEngine
```
public String getEngine()
```
    Returns:
    The engine.
  - getSchema
```
public String getSchema()
```
    Returns:
    The database schema.
  - existsSchema
```
public boolean existsSchema()
```
    Returns:
    Whether or not a database schema is defined.
  - allowColumnDrop
```
public boolean allowColumnDrop()
```
    Returns:
    If the connection has permissions to drop columns on entity updates.
  - checkMandatoryProperties
```
public void checkMandatoryProperties()
                              throws PdbConfigurationException
```
    Method to check the mandatory fields.
    
    Throws:
    
    PdbConfigurationException - If mandatory fields are not set.
  - clone
```
public PdbProperties clone()
```
    Overrides:
    
    clone in class Hashtable<Object,Object>

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

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

Constructor Detail

PdbProperties

PdbProperties

Method Detail

merge

isEncryptedUsername

isEncryptedPassword

isSchemaCreateDrop

isSchemaDropCreate

isSchemaCreate

isSchemaNone

getMaxIdentifierSize

getMaxBlobSize

isMaxBlobSizeSet

getBlobBufferSize

getMaxRetries

getRetryInterval

isReconnectOnLost

getIsolationLevel

getJdbc

getUsername

getPassword

getEngine

getSchema

existsSchema

allowColumnDrop

checkMandatoryProperties

clone