Package org.ametys.core.datasource.dbtype

Class SQLDatabaseTypeExtensionPoint

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint<SQLDatabaseType>

org.ametys.core.datasource.dbtype.SQLDatabaseTypeExtensionPoint

All Implemented Interfaces:

LogEnabled, ExtensionPoint<SQLDatabaseType>, Disposable, Initializable, Component, Contextualizable, Serviceable, ThreadSafe

public class SQLDatabaseTypeExtensionPoint
extends AbstractThreadSafeComponentExtensionPoint<SQLDatabaseType>

This class is in charge to load and initialize the SQLDatabaseType

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROLE	Avalon Role

Fields inherited from class org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint

_cocoonManager, _context, _manager

Constructor Summary

Constructors

Constructor	Description
SQLDatabaseTypeExtensionPoint()

Method Summary

Modifier and Type	Method	Description
InputStream	getBlob(String dbType, ResultSet resultSet, int pos)	Get the InputStream to read a blob
InputStream	getBlob(String dbType, ResultSet resultSet, String columnName)	Get the InputStream to read a blob
Map<String,I18nizableText>	getSQLDatabaseTypes()	Get the SQL database types with their label
void	initializeExtensions()	Finalize the initialization of the extensions. This method is called after all addExtension() calls. This is the last step before the actual startup of the application.
String	languageEscapeTableName(String dbType, String tableNameToEscape)	Some db systems requires the table names to be escaped
String	languageLimitQuery(String dbType, String queryToLimit, String limit, String offset)	Add a limit/offset element to the given query
void	setBlob(String dbType, 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 setBlob(String, PreparedStatement, int, String)
void	setBlob(String dbType, 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 setBlob(String, PreparedStatement, int, String)
void	setBlob(String dbType, PreparedStatement statement, int pos, String blob)	Set an String into a blob

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

addComponent, addExtension, contextualize, dispose, getExtension, getExtensionsIds, hasExtension, initialize, service

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

ROLE

public static final String ROLE

Avalon Role

Constructor Detail

SQLDatabaseTypeExtensionPoint

public SQLDatabaseTypeExtensionPoint()

Method Detail

initializeExtensions

public void initializeExtensions()
                          throws Exception

Description copied from interface: ExtensionPoint

Finalize the initialization of the extensions.
This method is called after all addExtension() calls.
This is the last step before the actual startup of the application.

Specified by:

initializeExtensions in interface ExtensionPoint<SQLDatabaseType>

Overrides:

initializeExtensions in class AbstractThreadSafeComponentExtensionPoint<SQLDatabaseType>

Throws:

Exception - if something wrong occurs

getSQLDatabaseTypes

public Map<String,I18nizableText> getSQLDatabaseTypes()

Get the SQL database types with their label

Returns:

the SQL database types with their label

languageEscapeTableName

public String languageEscapeTableName(String dbType,
                                      String tableNameToEscape)

Some db systems requires the table names to be escaped

Parameters:

dbType - The identifier of the db type used

tableNameToEscape - The non-null table name

Returns:

The escaped table name or at least the table name if no escape is required. Or null if the dbtype is unknown.

languageLimitQuery

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

Add a limit/offset element to the given query

Parameters:

dbType - The identifier of the db type used

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. Or null if the dbtype is unknown.

getBlob

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

Get the InputStream to read a blob

Parameters:

dbType - The identifier of the db type used

resultSet - the result set containing the blob.

columnName - column

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

getBlob

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

Get the InputStream to read a blob

Parameters:

dbType - The identifier of the db type used

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(String dbType,
                    PreparedStatement statement,
                    int pos,
                    String blob)
             throws SQLException,
                    UnsupportedEncodingException,
                    IllegalArgumentException

Set an String into a blob

Parameters:

dbType - The identifier of the db type used

statement - The satement where the blob will be set

pos - position in the statement

blob - String representing 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

UnsupportedEncodingException - if UTF-8 is not supported

IllegalArgumentException - if the dbType is not found

setBlob

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

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

Parameters:

dbType - The identifier of the db type used

statement - The satement where the blob will be set

pos - position in the statement

bytes - byte[] representing the blob, in UTF-8

Throws:

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

IllegalArgumentException - if the dbType is not found

setBlob

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

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

Parameters:

dbType - The identifier of the db type used

statement - The satement where the blob will be set

pos - position in the statement

is - inputStream to put in the blob

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

IllegalArgumentException - if the dbType is not found