DatabaseTableConfiguration (OpenICF 1.7.1 API)

java.lang.Object
- org.identityconnectors.framework.spi.AbstractConfiguration
- - org.identityconnectors.databasetable.DatabaseTableConfiguration

All Implemented Interfaces:

Configuration
```
public class DatabaseTableConfiguration
extends AbstractConfiguration
```
Implements the Configuration interface to provide all the necessary parameters to initialize the JDBC Connector.

Nested Class Summary
- Nested classes/interfaces inherited from class org.identityconnectors.framework.spi.AbstractConfiguration
  AbstractConfiguration.ConfigurationChangeCallback

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`allNative` Some JDBC drivers (ex: DerbyDB) may need to access all the datatypes with native types to get correct value.
`boolean`	`enableEmptyString` The empty string setting allow conversion of a null into an empty string for not-null char columns
`boolean`	`nativeTimestamps` Some JDBC drivers (ex: Oracle) may not be able to get correct string representation of TIMESTAMP data type of the column from the database table.
`boolean`	`rethrowAllSQLExceptions` Some database drivers will throw the SQLError when setting the parameters to the statement with zero ErrorCode.

Constructor Summary

Constructors
Constructor and Description

DatabaseTableConfiguration()

Constructors
Constructor and Description
`DatabaseTableConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`formatUrlTemplate()` Format a URL given a template.
`String`	`getChangeLogColumn()` Log Column is required be SyncOp
`String`	`getDatabase()`
`String`	`getDatasource()` Return the datasource
`String`	`getHost()` NameQoute getter
`String`	`getJdbcDriver()`
`String`	`getJdbcUrlTemplate()` Return the jdbcUrlTemplate
`String[]`	`getJndiProperties()` Return the jndiFactory
`String`	`getKeyColumn()` Key Column getter
`String`	`getMessage(String key)` Format the connector message
`String`	`getMessage(String key, Object... objects)` Format message with arguments
`GuardedString`	`getPassword()`
`String`	`getPasswordColumn()` Password Column getter
`String`	`getPort()` NameQoute getter
`String`	`getQuoting()` NameQoute getter
`boolean`	`getSuppressPassword()` If set to true then the password will not be returned.
`String`	`getTable()` The table name
`String`	`getUser()`
`String`	`getValidConnectionQuery()` connection validation query getter
`boolean`	`isAllNative()` Accessor for the allNativeproperty
`boolean`	`isEnableEmptyString()` Accessor for the enableEmptyString property
`boolean`	`isNativeTimestamps()` Accessor for the nativeTimestamps property
`boolean`	`isRethrowAllSQLExceptions()` Accessor for the rethrowAllSQLExceptions property
`void`	`setAllNative(boolean allNative)` Setter for the allNative property.
`void`	`setChangeLogColumn(String value)`
`void`	`setDatabase(String value)`
`void`	`setDatasource(String value)`
`void`	`setEnableEmptyString(boolean enableEmptyString)` Setter for the enableEmptyString property.
`void`	`setHost(String value)` NameQuote Setter
`void`	`setJdbcDriver(String value)`
`void`	`setJdbcUrlTemplate(String value)`
`void`	`setJndiProperties(String[] value)`
`void`	`setKeyColumn(String keyColumn)` Key Column setter
`void`	`setNativeTimestamps(boolean nativeTimestamps)` Setter for the nativeTimestamps property.
`void`	`setPassword(GuardedString value)`
`void`	`setPasswordColumn(String value)` Password Column setter
`void`	`setPort(String value)` NameQuote Setter
`void`	`setQuoting(String value)` NameQuote Setter
`void`	`setRethrowAllSQLExceptions(boolean rethrowAllSQLExceptions)` Setter for the rethrowAllSQLExceptions property.
`void`	`setSuppressPassword(boolean suppressPassword)`
`void`	`setTable(String table)` Table setter
`void`	`setUser(String value)`
`void`	`setValidConnectionQuery(String value)` Connection validation query setter
`void`	`validate()` Attempt to validate the arguments added to the Configuration.

Methods inherited from class org.identityconnectors.framework.spi.AbstractConfiguration
addChangeCallback, getConnectorMessages, notifyConfigurationUpdate, setConnectorMessages

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

- Field Detail
  - enableEmptyString
```
public boolean enableEmptyString
```
    The empty string setting allow conversion of a null into an empty string for not-null char columns
  - rethrowAllSQLExceptions
```
public boolean rethrowAllSQLExceptions
```
    Some database drivers will throw the SQLError when setting the parameters to the statement with zero ErrorCode. This mean no error. This switch allow to switch off ignoring this SQLError
  - nativeTimestamps
```
public boolean nativeTimestamps
```
    Some JDBC drivers (ex: Oracle) may not be able to get correct string representation of TIMESTAMP data type of the column from the database table. To get correct value , one needs to use rs.getTimestamp() rather rs.getString().
  - allNative
```
public boolean allNative
```
    Some JDBC drivers (ex: DerbyDB) may need to access all the datatypes with native types to get correct value.
- Constructor Detail
  - DatabaseTableConfiguration
```
public DatabaseTableConfiguration()
```
- Method Detail
  - getQuoting
```
public String getQuoting()
```
    NameQoute getter
    
    Returns:
    
    quoting value
  - setQuoting
```
public void setQuoting(String value)
```
    NameQuote Setter
    
    Parameters:
    
    value -
  - getHost
```
public String getHost()
```
    NameQoute getter
    
    Returns:
    
    quoting value
  - setHost
```
public void setHost(String value)
```
    NameQuote Setter
    
    Parameters:
    
    value -
  - getPort
```
public String getPort()
```
    NameQoute getter
    
    Returns:
    
    quoting value
  - setPort
```
public void setPort(String value)
```
    NameQuote Setter
    
    Parameters:
    
    value -
  - getUser
```
public String getUser()
```
    Returns:
    
    user value
  - setUser
```
public void setUser(String value)
```
    Parameters:
    
    value -
  - getPassword
```
public GuardedString getPassword()
```
    Returns:
    
    password value
  - setPassword
```
public void setPassword(GuardedString value)
```
    Parameters:
    
    value -
  - getDatabase
```
public String getDatabase()
```
    Returns:
    
    user value
  - setDatabase
```
public void setDatabase(String value)
```
    Parameters:
    
    value -
  - getTable
```
public String getTable()
```
    The table name
    
    Returns:
    
    the user account table name Please notice, there are used non default message keys
  - setTable
```
public void setTable(String table)
```
    Table setter
    
    Parameters:
    
    table - name value
  - getKeyColumn
```
public String getKeyColumn()
```
    Key Column getter
    
    Returns:
    
    keyColumn value
  - setKeyColumn
```
public void setKeyColumn(String keyColumn)
```
    Key Column setter
    
    Parameters:
    
    keyColumn - value
  - getPasswordColumn
```
public String getPasswordColumn()
```
    Password Column getter
    
    Returns:
    
    passwordColumn value
  - setPasswordColumn
```
public void setPasswordColumn(String value)
```
    Password Column setter
    
    Parameters:
    
    value -
  - getJdbcDriver
```
public String getJdbcDriver()
```
    Returns:
    
    jdbcDriver value
  - setJdbcDriver
```
public void setJdbcDriver(String value)
```
    Parameters:
    
    value -
  - getJdbcUrlTemplate
```
public String getJdbcUrlTemplate()
```
    Return the jdbcUrlTemplate
    
    Returns:
    
    url value
  - setJdbcUrlTemplate
```
public void setJdbcUrlTemplate(String value)
```
    Parameters:
    
    value -
  - isEnableEmptyString
```
public boolean isEnableEmptyString()
```
    Accessor for the enableEmptyString property
    
    Returns:
    
    the enableEmptyString
  - setEnableEmptyString
```
public void setEnableEmptyString(boolean enableEmptyString)
```
    Setter for the enableEmptyString property.
    
    Parameters:
    
    enableEmptyString - the enableEmptyString to set
  - isRethrowAllSQLExceptions
```
public boolean isRethrowAllSQLExceptions()
```
    Accessor for the rethrowAllSQLExceptions property
    
    Returns:
    
    the rethrowAllSQLExceptions
  - setRethrowAllSQLExceptions
```
public void setRethrowAllSQLExceptions(boolean rethrowAllSQLExceptions)
```
    Setter for the rethrowAllSQLExceptions property.
    
    Parameters:
    
    rethrowAllSQLExceptions - the rethrowAllSQLExceptions to set
  - isNativeTimestamps
```
public boolean isNativeTimestamps()
```
    Accessor for the nativeTimestamps property
    
    Returns:
    
    the nativeTimestamps
  - setNativeTimestamps
```
public void setNativeTimestamps(boolean nativeTimestamps)
```
    Setter for the nativeTimestamps property.
    
    Parameters:
    
    nativeTimestamps - the nativeTimestamps to set
  - isAllNative
```
public boolean isAllNative()
```
    Accessor for the allNativeproperty
    
    Returns:
    
    the allNative
  - setAllNative
```
public void setAllNative(boolean allNative)
```
    Setter for the allNative property.
    
    Parameters:
    
    allNative - the allNative to set
  - getValidConnectionQuery
```
public String getValidConnectionQuery()
```
    connection validation query getter
    
    Returns:
    
    validConnectionQuery value
  - setValidConnectionQuery
```
public void setValidConnectionQuery(String value)
```
    Connection validation query setter
    
    Parameters:
    
    value -
  - getChangeLogColumn
```
public String getChangeLogColumn()
```
    Log Column is required be SyncOp
    
    Returns:
    
    Log Column
  - setChangeLogColumn
```
public void setChangeLogColumn(String value)
```
    Parameters:
    
    value -
  - getDatasource
```
public String getDatasource()
```
    Return the datasource
    
    Returns:
    
    datasource value
  - setDatasource
```
public void setDatasource(String value)
```
    Parameters:
    
    value -
  - getJndiProperties
```
public String[] getJndiProperties()
```
    Return the jndiFactory
    
    Returns:
    
    jndiFactory value
  - setJndiProperties
```
public void setJndiProperties(String[] value)
```
    Parameters:
    
    value -
  - getSuppressPassword
```
public boolean getSuppressPassword()
```
    If set to true then the password will not be returned. Never. Even though it is explicitly requested. If set to false then the password will be returned if it is explicitly requested.
  - setSuppressPassword
```
public void setSuppressPassword(boolean suppressPassword)
```
  - validate
```
public void validate()
```
    Attempt to validate the arguments added to the Configuration.
  - formatUrlTemplate
```
public String formatUrlTemplate()
```
    Format a URL given a template. Recognized template characters are: % literal % h host p port d database
    
    Returns:
    
    the database url
  - getMessage
```
public String getMessage(String key)
```
    Format the connector message
    
    Parameters:
    
    key - key of the message
    
    Returns:
    
    return the formated message
  - getMessage
```
public String getMessage(String key,
                         Object... objects)
```
    Format message with arguments
    
    Parameters:
    
    key - key of the message
    
    objects - arguments
    
    Returns:
    
    the localized message string

Class DatabaseTableConfiguration

Nested Class Summary

Nested classes/interfaces inherited from class org.identityconnectors.framework.spi.AbstractConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.identityconnectors.framework.spi.AbstractConfiguration

Methods inherited from class java.lang.Object

Field Detail

enableEmptyString

rethrowAllSQLExceptions

nativeTimestamps

allNative

Constructor Detail

DatabaseTableConfiguration

Method Detail

getQuoting

setQuoting

getHost

setHost

getPort

setPort

getUser

setUser

getPassword

setPassword

getDatabase

setDatabase

getTable

setTable

getKeyColumn

setKeyColumn

getPasswordColumn

setPasswordColumn

getJdbcDriver

setJdbcDriver

getJdbcUrlTemplate

setJdbcUrlTemplate

isEnableEmptyString

setEnableEmptyString

isRethrowAllSQLExceptions

setRethrowAllSQLExceptions

isNativeTimestamps

setNativeTimestamps

isAllNative

setAllNative

getValidConnectionQuery

setValidConnectionQuery

getChangeLogColumn

setChangeLogColumn

getDatasource

setDatasource

getJndiProperties

setJndiProperties

getSuppressPassword

setSuppressPassword

validate

formatUrlTemplate

getMessage

getMessage