Package org.ametys.plugins.core.impl.datasource

Class StaticSQLDatabaseType

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.impl.datasource.StaticSQLDatabaseType

All Implemented Interfaces:

SQLDatabaseType, LogEnabled, PluginAware, Configurable

Direct Known Subclasses:

DerbySQLDatabaseType, PostgreSQLDatabaseType

public class StaticSQLDatabaseType
extends AbstractLogEnabled
implements Configurable, SQLDatabaseType, PluginAware

Default implementation for a SQLDatabaseType.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_driver	The driver of the database type
protected I18nizableText	_driverNotFoundMessage	The driver not found message
protected String	_id	The id of the database type
protected I18nizableText	_label	The label of the database type
protected String	_languageEscapeTableNameTemplate	The template to escape the table name.
protected String	_languageLimitQueryTemplate	The template to limit the query to a limit/offset.
protected String	_pluginName	The plugin's name
protected String	_template	The url template for this database type
protected String	_validationQuery	The SQL query to validate the connection is still alive

Constructor Summary

Constructors

Constructor	Description
StaticSQLDatabaseType()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
InputStream	getBlob(ResultSet resultSet, int pos)	Get the InputStream to read a blob
InputStream	getBlob(ResultSet resultSet, String columnName)	Get the InputStream to read a blob
String	getDriver()	Get the driver of the database type.
I18nizableText	getDriverNotFoundMessage()	Get the error message key when the specified driver was not found
String	getId()	Get the id of the database type.
I18nizableText	getLabel()	Get the label of the database type.
String	getTemplate()	Get the url template to use for this database type
String	getValidationQuery()	Get the query to validate a connection
String	languageEscapeTableName(String tableNameToEscape)	Some db systems requires the table names to be escaped
String	languageLimitQuery(String queryToLimit, String limit, String offset)	Add a limit/offset element to the given query
void	setBlob(PreparedStatement statement, int pos, byte[] bytes)	Set an array of bytes (UTF-8 encoded) into a blob, if you want to pass a String, you can use SQLDatabaseType.setBlob(PreparedStatement, int, String)
void	setBlob(PreparedStatement statement, int pos, InputStream is, long length)	Set an array of bytes (UTF-8 encoded) into a blob, if you want to pass a String, you can use SQLDatabaseType.setBlob(PreparedStatement, int, String)
void	setBlob(PreparedStatement statement, int pos, String blob)	Set an String into a blob
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

_id

protected String _id

The id of the database type

_label

protected I18nizableText _label

The label of the database type

_driver

protected String _driver

The driver of the database type

_template

protected String _template

The url template for this database type

_pluginName

protected String _pluginName

The plugin's name

_validationQuery

protected String _validationQuery

The SQL query to validate the connection is still alive

_driverNotFoundMessage

protected I18nizableText _driverNotFoundMessage

The driver not found message

_languageEscapeTableNameTemplate

protected String _languageEscapeTableNameTemplate

The template to escape the table name. Must contain {tableName}

_languageLimitQueryTemplate

protected String _languageLimitQueryTemplate

The template to limit the query to a limit/offset. Must contain {query} {limit} and {offset}

Constructor Detail

StaticSQLDatabaseType

public StaticSQLDatabaseType()

Method Detail

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getId

public String getId()

Description copied from interface: SQLDatabaseType

Get the id of the database type.

Specified by:

getId in interface SQLDatabaseType

Returns:

the id. Can not be null.

getLabel

public I18nizableText getLabel()

Description copied from interface: SQLDatabaseType

Get the label of the database type.

Specified by:

getLabel in interface SQLDatabaseType

Returns:

the label

getDriver

public String getDriver()

Description copied from interface: SQLDatabaseType

Get the driver of the database type.

Specified by:

getDriver in interface SQLDatabaseType

Returns:

the driver. Can not be null.

getTemplate

public String getTemplate()

Description copied from interface: SQLDatabaseType

Get the url template to use for this database type

Specified by:

getTemplate in interface SQLDatabaseType

Returns:

the url template

getValidationQuery

public String getValidationQuery()

Description copied from interface: SQLDatabaseType

Get the query to validate a connection

Specified by:

getValidationQuery in interface SQLDatabaseType

Returns:

A SQL query to ensure that a connection is still alive

getDriverNotFoundMessage

public I18nizableText getDriverNotFoundMessage()

Description copied from interface: SQLDatabaseType

Get the error message key when the specified driver was not found

Specified by:

getDriverNotFoundMessage in interface SQLDatabaseType

Returns:

the error message

languageEscapeTableName

public String languageEscapeTableName(String tableNameToEscape)

Description copied from interface: SQLDatabaseType

Some db systems requires the table names to be escaped

Specified by:

languageEscapeTableName in interface SQLDatabaseType

Parameters:

tableNameToEscape - The non-null table name

Returns:

The escaped table name or at least the table name if no escape is required

languageLimitQuery

public String languageLimitQuery(String queryToLimit,
                                 String limit,
                                 String offset)

Description copied from interface: SQLDatabaseType

Add a limit/offset element to the given query

Specified by:

languageLimitQuery in interface SQLDatabaseType

Parameters:

queryToLimit - The sql query that will be amended

limit - The max number of the results to return

offset - The initial offset of the results to return

Returns:

The initial query amended to handle the limit and offset.

getBlob

public InputStream getBlob(ResultSet resultSet,
                           String columnName)
                    throws SQLException

Description copied from interface: SQLDatabaseType

Get the InputStream to read a blob

Specified by:

getBlob in interface SQLDatabaseType

Parameters:

resultSet - the result set containing the blob.

columnName - column

Returns:

an InputStream to read the blob or null if the column is null

Throws:

SQLException - if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set

getBlob

public InputStream getBlob(ResultSet resultSet,
                           int pos)
                    throws SQLException

Description copied from interface: SQLDatabaseType

Get the InputStream to read a blob

Specified by:

getBlob in interface SQLDatabaseType

Parameters:

resultSet - the result set containing the blob.

pos - column position

Returns:

an InputStream to read the blob

Throws:

SQLException - if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set

setBlob

public void setBlob(PreparedStatement statement,
                    int pos,
                    String blob)
             throws SQLException,
                    UnsupportedEncodingException

Description copied from interface: SQLDatabaseType

Set an String into a blob

Specified by:

setBlob in interface SQLDatabaseType

Parameters:

statement - The satement where the blob will be set

pos - position in the statement

blob - String representing the blob. Can be null

Throws:

SQLException - if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set

UnsupportedEncodingException - if UTF-8 is not supported

setBlob

public void setBlob(PreparedStatement statement,
                    int pos,
                    byte[] bytes)
             throws SQLException

Description copied from interface: SQLDatabaseType

Set an array of bytes (UTF-8 encoded) into a blob, if you want to pass a String, you can use SQLDatabaseType.setBlob(PreparedStatement, int, String)

Specified by:

setBlob in interface SQLDatabaseType

Parameters:

statement - The satement where the blob will be set

pos - position in the statement

bytes - byte[] representing the blob, in UTF-8. Can be null

Throws:

SQLException - if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set

setBlob

public void setBlob(PreparedStatement statement,
                    int pos,
                    InputStream is,
                    long length)
             throws SQLException

Description copied from interface: SQLDatabaseType

Set an array of bytes (UTF-8 encoded) into a blob, if you want to pass a String, you can use SQLDatabaseType.setBlob(PreparedStatement, int, String)

Specified by:

setBlob in interface SQLDatabaseType

Parameters:

statement - The satement where the blob will be set

pos - position in the statement

is - inputStream to put in the blob. Can be null

length - length of the stream

Throws:

SQLException - if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set