net.tirasa.connid.bundles.db.scriptedsql

Class ScriptedSQLConfiguration

java.lang.Object

org.identityconnectors.framework.spi.AbstractConfiguration

net.tirasa.connid.commons.scripted.AbstractScriptedConfiguration

net.tirasa.connid.bundles.db.scriptedsql.ScriptedSQLConfiguration

All Implemented Interfaces:

org.identityconnectors.framework.spi.Configuration

public class ScriptedSQLConfiguration
extends net.tirasa.connid.commons.scripted.AbstractScriptedConfiguration

Extends the AbstractConfiguration class to provide all the necessary parameters to initialize the ScriptedJDBC Connector.

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.
static String	EMPTY_STR
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.

Fields inherited from class net.tirasa.connid.commons.scripted.AbstractScriptedConfiguration

LOG

Constructor Summary

Constructors

Constructor and Description
ScriptedSQLConfiguration()

Method Summary

Modifier and Type	Method and Description
String	formatUrlTemplate() Format a URL given a template.
String	getDatabase()
String	getDatasource() Return the datasource
String	getHost() host getter
String	getJdbcDriver()
String	getJdbcUrlTemplate() Return the jdbcUrlTemplate
String[]	getJndiProperties() Return the jndiFactory
String	getMessage(String key) Format the connector message
org.identityconnectors.common.security.GuardedString	getPassword()
String	getPort() port getter
String	getQuoting() NameQuote getter
String	getUser()
String	getValidConnectionQuery() connection validation query getter
boolean	isAllNative() Accessor for the allNativeproperty
boolean	isAutoCommit() Accessor for the autoCommit property
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	setAutoCommit(boolean autoCommit) Setter for the autoCommit property.
void	setDatabase(String value)
void	setDatasource(String value)
void	setEnableEmptyString(boolean enableEmptyString) Setter for the enableEmptyString property.
void	setHost(String value) host Setter
void	setJdbcDriver(String value)
void	setJdbcUrlTemplate(String value)
void	setJndiProperties(String[] value)
void	setNativeTimestamps(boolean nativeTimestamps) Setter for the nativeTimestamps property.
void	setPassword(org.identityconnectors.common.security.GuardedString value)
void	setPort(String value) port Setter
void	setQuoting(String value) NameQuote Setter
void	setRethrowAllSQLExceptions(boolean rethrowAllSQLExceptions) Setter for the rethrowAllSQLExceptions property.
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 net.tirasa.connid.commons.scripted.AbstractScriptedConfiguration

getAuthenticateScript, getAuthenticateScriptFileName, getClearTextPasswordToScript, getCreateScript, getCreateScriptFileName, getDeleteScript, getDeleteScriptFileName, getMessage, getResolveUsernameScript, getResolveUsernameScriptFileName, getSchemaScript, getSchemaScriptFileName, getScriptingLanguage, getSearchScript, getSearchScriptFileName, getSyncScript, getSyncScriptFileName, getTestScript, getTestScriptFileName, getUpdateScript, getUpdateScriptFileName, isReloadScriptOnExecution, setAuthenticateScript, setAuthenticateScriptFileName, setClearTextPasswordToScript, setCreateScript, setCreateScriptFileName, setDeleteScript, setDeleteScriptFileName, setReloadScriptOnExecution, setResolveUsernameScript, setResolveUsernameScriptFileName, setSchemaScript, setSchemaScriptFileName, setScriptingLanguage, setSearchScript, setSearchScriptFileName, setSyncScript, setSyncScriptFileName, setTestScript, setTestScriptFileName, setUpdateScript, setUpdateScriptFileName

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

getConnectorMessages, setConnectorMessages

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_STR

public static final String EMPTY_STR

See Also:

Constant Field Values

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

ScriptedSQLConfiguration

public ScriptedSQLConfiguration()

Method Detail

getQuoting

public String getQuoting()

NameQuote getter

Returns:

quoting value

setQuoting

public void setQuoting(String value)

NameQuote Setter

Parameters:

value - value

getHost

public String getHost()

host getter

Returns:

host value

setHost

public void setHost(String value)

host Setter

Parameters:

value - value

getPort

public String getPort()

port getter

Returns:

port value

setPort

public void setPort(String value)

port Setter

Parameters:

value - value

getUser

public String getUser()

Returns:

user value

setUser

public void setUser(String value)

getPassword

public org.identityconnectors.common.security.GuardedString getPassword()

Returns:

password value

setPassword

public void setPassword(org.identityconnectors.common.security.GuardedString value)

getDatabase

public String getDatabase()

Returns:

user value

setDatabase

public void setDatabase(String value)

getJdbcDriver

public String getJdbcDriver()

Returns:

jdbcDriver value

setJdbcDriver

public void setJdbcDriver(String value)

getJdbcUrlTemplate

public String getJdbcUrlTemplate()

Return the jdbcUrlTemplate

Returns:

url value

setJdbcUrlTemplate

public void setJdbcUrlTemplate(String value)

isAutoCommit

public boolean isAutoCommit()

Accessor for the autoCommit property

Returns:

the autoCommit

setAutoCommit

public void setAutoCommit(boolean autoCommit)

Setter for the autoCommit property.

Parameters:

autoCommit - auto commit

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 - value

getDatasource

public String getDatasource()

Return the datasource

Returns:

datasource value

setDatasource

public void setDatasource(String value)

getJndiProperties

public String[] getJndiProperties()

Return the jndiFactory

Returns:

jndiFactory value

setJndiProperties

public void setJndiProperties(String[] value)

validate

public void validate()

Attempt to validate the arguments added to the Configuration.

Specified by:

validate in interface org.identityconnectors.framework.spi.Configuration

Overrides:

validate in class net.tirasa.connid.commons.scripted.AbstractScriptedConfiguration

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