com.exalead.papi.connectors.jdbc

Class DatabaseConnector

java.lang.Object

com.exalead.papi.framework.connectors.Connector

com.exalead.papi.connectors.jdbc.DatabaseConnector

All Implemented Interfaces:

CVComponent, ConnectorStatusExceptionInterface, ConnectorInterface

public class DatabaseConnector
extends Connector

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.papi.framework.connectors.Connector

Connector.ConnectorNameThreadFactory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADD_MODIFED_ONLY_SCAN
static java.lang.String	CHECK_FOR_MISSING
DatabaseConnectorConfig	config
static java.lang.String	CURRENT_SQL_TYPE_CHECKPOINT
static java.lang.String	CURRENT_TIME_CHECKPOINT
DatabaseFetcher	fetcher
static java.lang.String	FULL_RESCAN_FROM_CHECKPOINT
CheckpointValue	lastUpdateStamp
protected com.exalead.connector.InterConnectorServiceImpl	service
static java.lang.String	SYNCHRONISATION_OCCURED

Fields inherited from class com.exalead.papi.framework.connectors.Connector

DEFAULT_SCAN_MODE, papi

Constructor Summary

Constructors

Constructor and Description
DatabaseConnector(DatabaseConnectorConfig config)

Method Summary

Modifier and Type	Method and Description
void	callBeforeDestruction() Override this method to do some task before the destruction of the connector
void	compareAgainstDatabaseConnected(PushAPI papi, java.lang.String mode, java.sql.Connection connection, CheckpointValue startTimeStamp)
java.sql.Connection	connect() connects to a database with the configured credentials (if supplied).
java.lang.String[]	contextualizeIncrementalQueries(java.lang.String[] queries, PushAPI papi, CheckpointValue startTimeStamp, VariableReplacementMode substitutionMode)
ContextualizedQuery	contextualizeIncrementalQuery(java.lang.String query, PushAPI papi, CheckpointValue checkpointValue, VariableReplacementMode substitutionMode)
java.sql.PreparedStatement	createDeleteStatement(java.sql.Connection connection, java.lang.String query) creates the statement used for delete.
java.sql.PreparedStatement	createFetchStatement(java.sql.Connection connection, java.lang.String query) creates the statement used for fetch.
java.sql.PreparedStatement	createStatement(java.sql.Connection connection, java.lang.String query) creates a statement from a connection
java.sql.PreparedStatement	createTimeStampStatement(java.sql.Connection connection, java.lang.String query) creates the statement used for timestamp retrieval.
void	deleteOnceConnected(PushAPI papi, java.lang.String mode, java.sql.Connection connection, CheckpointValue startTimeStamp, CheckpointValue forceFullRescanCheckPointValue) remove deleted documents from index if allUrisQuery is supplied in configuration.
void	disconnect(java.sql.Connection connection) disconnects from a database.
void	executeQueries(java.sql.Connection cnx, java.lang.String[] queries, java.lang.String verboseMessage)
Document	fetch(java.lang.String uri) This method is used to retrieve document from the source when CloudView product needs it.
Document	fetchOnceConnected(java.sql.Connection connection, java.lang.String uri) builds an html document describing extracted metas
CheckpointValue	fetchUpdateCheckpoint(PushAPI papi) retrieve the date of the last synchronization (if CurrentTimeQuery is supplied)
static java.lang.String	formatSqlError(java.sql.SQLException sqle) Format an SQL error message
CheckpointValue	getCurrentTimeStamp(java.sql.Connection connection) fetches the current date and time from the database.
MetaContainer	getDocumentSecurityTokens(java.lang.String s) This method is used to retrieve security tokens of a document.
java.sql.ResultSet	getResultSet(java.sql.Statement statement)
boolean	hasAlreadySynchronized(PushAPI papi) checks whether a synchronization has been performed.
void	scan(PushAPI papi, java.lang.String mode, java.lang.Object modeConfig) This method is used to push (or synchronize) all documents from the source to CloudView product.
void	scratch(PushAPI papi) Clear connector state, default implementation: removes documents previously sent by the connector from CloudView index. clears checkpoints of the connector. Unless the connector is persisting additional data, there is not point to override this method.
boolean	sendDateCheckpoint(PushAPI papi, boolean incrementalMode) saves the given timestamp as a checkpoint.
void	sendSynchronizationCheckpoint(PushAPI papi, boolean incremental) saves that a synchronization has been performed.
void	setUpdateCheckpoint(CheckpointValue checkpointValue) override the value of the update checkpoint (used by the incremental synchronization)
int	synchronizeOnceConnected(PushAPI papi, java.lang.String mode, java.sql.Connection connection, CheckpointValue startTimeStamp, CheckpointValue forceFullRescanCheckPointValue) pushes document from a database.
void	verbose(java.lang.String msg)

Methods inherited from class com.exalead.papi.framework.connectors.Connector

checkAbortingOperation, checkAbortingOperation, checkDataSourceAvailability, checkSecurityTokens, fetch, getConnectorConfig, getConnectorName, getEndpointBuilder, getLogger, getLogger, getScanModes, getState, getState, getStatus, getStatus, getStatusException, init, init, onScanAborted, onScanAborted, onScanResumed, onScanResumed, onScanSuspended, onScanSuspended, selfAbortScan, selfAbortScan, synchronizeDocuments

Methods inherited from class java.lang.Object

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

Field Detail

FULL_RESCAN_FROM_CHECKPOINT

public static final java.lang.String FULL_RESCAN_FROM_CHECKPOINT

See Also:

Constant Field Values

CHECK_FOR_MISSING

public static final java.lang.String CHECK_FOR_MISSING

See Also:

Constant Field Values

ADD_MODIFED_ONLY_SCAN

public static final java.lang.String ADD_MODIFED_ONLY_SCAN

See Also:

Constant Field Values

CURRENT_TIME_CHECKPOINT

public static final java.lang.String CURRENT_TIME_CHECKPOINT

See Also:

Constant Field Values

CURRENT_SQL_TYPE_CHECKPOINT

public static final java.lang.String CURRENT_SQL_TYPE_CHECKPOINT

See Also:

Constant Field Values

SYNCHRONISATION_OCCURED

public static final java.lang.String SYNCHRONISATION_OCCURED

See Also:

Constant Field Values

config

public DatabaseConnectorConfig config

lastUpdateStamp

public CheckpointValue lastUpdateStamp

fetcher

public DatabaseFetcher fetcher

service

protected com.exalead.connector.InterConnectorServiceImpl service

Constructor Detail

DatabaseConnector

public DatabaseConnector(DatabaseConnectorConfig config)
                  throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

verbose

public void verbose(java.lang.String msg)

getDocumentSecurityTokens

public MetaContainer getDocumentSecurityTokens(java.lang.String s)

Description copied from class: Connector

This method is used to retrieve security tokens of a document. This method is only used for fetch, in the default implementation of "checkSecurityTokens".

Overrides:

getDocumentSecurityTokens in class Connector

Parameters:

s - Uri of document

Returns:

Security tokens of this document. The default implementation returns a "Everybody" grant ACL, allowing to access all documents.

fetch

public Document fetch(java.lang.String uri)
               throws java.lang.Exception

Description copied from class: Connector

This method is used to retrieve document from the source when CloudView product needs it.

Overrides:

fetch in class Connector

Parameters:

uri - document identifier to retrieve

Returns:

requested document

Throws:

java.lang.Exception

formatSqlError

public static java.lang.String formatSqlError(java.sql.SQLException sqle)

Format an SQL error message

Parameters:

sqle - The error/warning to format

Returns:

A formatted error/warning message

scan

public void scan(PushAPI papi,
                 java.lang.String mode,
                 java.lang.Object modeConfig)
          throws java.lang.Exception

Description copied from class: Connector

This method is used to push (or synchronize) all documents from the source to CloudView product.

Overrides:

scan in class Connector

Parameters:

papi - PushAPI used to dialog with CloudView

mode - Type of scan to perform. Is always Connector.DEFAULT_SCAN_MODE unless the connector declares additional scan modes with ConnectorCapabilities annotation.

modeConfig - Optional configuration given to the scanMode, according to ScanModeDefinition annotation.

Throws:

java.lang.Exception - Upon error

scratch

public void scratch(PushAPI papi)
             throws java.lang.Exception

Description copied from class: Connector

Clear connector state, default implementation:

• removes documents previously sent by the connector from CloudView index.
• clears checkpoints of the connector.

Unless the connector is persisting additional data, there is not point to override this method. This member method is called when you click on the "Clear documents" button from Administration Console or while executing the MAMI connect#clearConnector operation.

Overrides:

scratch in class Connector

Parameters:

papi - The PushAPI to dialog with CloudView

Throws:

java.lang.Exception

callBeforeDestruction

public void callBeforeDestruction()
                           throws java.lang.Exception

Description copied from class: Connector

Override this method to do some task before the destruction of the connector

Overrides:

callBeforeDestruction in class Connector

Throws:

java.lang.Exception

connect

public java.sql.Connection connect()
                            throws java.sql.SQLException

connects to a database with the configured credentials (if supplied).

Returns:

Throws:

java.sql.SQLException

disconnect

public void disconnect(java.sql.Connection connection)
                throws java.sql.SQLException

disconnects from a database.

Parameters:

connection -

Throws:

java.sql.SQLException

createStatement

public java.sql.PreparedStatement createStatement(java.sql.Connection connection,
                                                  java.lang.String query)
                                           throws java.sql.SQLException

creates a statement from a connection

Parameters:

connection - the connection to build the statement from

the - SQL query to be executed

Returns:

a statement

Throws:

java.sql.SQLException

getResultSet

public java.sql.ResultSet getResultSet(java.sql.Statement statement)
                                throws java.sql.SQLException

Throws:

java.sql.SQLException

createFetchStatement

public java.sql.PreparedStatement createFetchStatement(java.sql.Connection connection,
                                                       java.lang.String query)
                                                throws java.sql.SQLException

creates the statement used for fetch. default implementation calls createStatement()

Parameters:

connection -

Returns:

Throws:

java.sql.SQLException

fetchOnceConnected

public Document fetchOnceConnected(java.sql.Connection connection,
                                   java.lang.String uri)
                            throws java.lang.Exception

builds an html document describing extracted metas

Parameters:

connection -

uri -

Returns:

an html representation of the document

Throws:

PushAPIException

java.sql.SQLException

java.lang.Exception

createDeleteStatement

public java.sql.PreparedStatement createDeleteStatement(java.sql.Connection connection,
                                                        java.lang.String query)
                                                 throws java.sql.SQLException

creates the statement used for delete. default implementation calls createStatement()

Parameters:

connection -

query - The SQL query yo execute

Returns:

Throws:

java.sql.SQLException

deleteOnceConnected

public void deleteOnceConnected(PushAPI papi,
                                java.lang.String mode,
                                java.sql.Connection connection,
                                CheckpointValue startTimeStamp,
                                CheckpointValue forceFullRescanCheckPointValue)
                         throws java.lang.Exception

remove deleted documents from index if allUrisQuery is supplied in configuration.

Parameters:

connection -

Throws:

java.sql.SQLException

PushAPIException

java.lang.Exception

compareAgainstDatabaseConnected

public void compareAgainstDatabaseConnected(PushAPI papi,
                                            java.lang.String mode,
                                            java.sql.Connection connection,
                                            CheckpointValue startTimeStamp)
                                     throws java.lang.Exception

Parameters:

papi -

mode -

connection -

startTimeStamp -

forceFullRescan -

forceFullRescanCheckPointValue -

Throws:

java.lang.Exception

executeQueries

public void executeQueries(java.sql.Connection cnx,
                           java.lang.String[] queries,
                           java.lang.String verboseMessage)
                    throws java.sql.SQLException

Throws:

java.sql.SQLException

synchronizeOnceConnected

public int synchronizeOnceConnected(PushAPI papi,
                                    java.lang.String mode,
                                    java.sql.Connection connection,
                                    CheckpointValue startTimeStamp,
                                    CheckpointValue forceFullRescanCheckPointValue)
                             throws java.lang.Exception

pushes document from a database. If UpdateStampVariable and UpdateQuery are supplied in configuration, an incremental update is performed.

Parameters:

papi -

mode -

connection -

startTimeStamp -

forceFullRescan -

forceFullRescanCheckPointValue -

Returns:

The number of pushed documents

Throws:

java.lang.Exception

contextualizeIncrementalQueries

public java.lang.String[] contextualizeIncrementalQueries(java.lang.String[] queries,
                                                          PushAPI papi,
                                                          CheckpointValue startTimeStamp,
                                                          VariableReplacementMode substitutionMode)
                                                   throws PushAPIException

Throws:

PushAPIException

contextualizeIncrementalQuery

public ContextualizedQuery contextualizeIncrementalQuery(java.lang.String query,
                                                         PushAPI papi,
                                                         CheckpointValue checkpointValue,
                                                         VariableReplacementMode substitutionMode)
                                                  throws PushAPIException

Throws:

PushAPIException

fetchUpdateCheckpoint

public CheckpointValue fetchUpdateCheckpoint(PushAPI papi)
                                      throws PushAPIException

retrieve the date of the last synchronization (if CurrentTimeQuery is supplied)

Parameters:

papi - The PushAPi to query for the checkpoint

Returns:

either

• The value of the incremental checkpoint

or
• null if no such checkpoint exists

Throws:

PushAPIException

See Also:

#sendDateCheckpoint(PushAPI, boolean)}

createTimeStampStatement

public java.sql.PreparedStatement createTimeStampStatement(java.sql.Connection connection,
                                                           java.lang.String query)
                                                    throws java.sql.SQLException

creates the statement used for timestamp retrieval. default implementation calls createStatement()

Parameters:

connection -

Returns:

Throws:

java.sql.SQLException

getCurrentTimeStamp

public CheckpointValue getCurrentTimeStamp(java.sql.Connection connection)
                                    throws java.sql.SQLException

fetches the current date and time from the database.

Parameters:

connection -

Returns:

Throws:

java.sql.SQLException

sendDateCheckpoint

public boolean sendDateCheckpoint(PushAPI papi,
                                  boolean incrementalMode)
                           throws PushAPIException

saves the given timestamp as a checkpoint.

Parameters:

connection -

timestamp -

Returns:

true if there was a incremental checkpoint to set

Throws:

PushAPIException

See Also:

#fetchUpdateCheckpoint(PushAPI)}

hasAlreadySynchronized

public boolean hasAlreadySynchronized(PushAPI papi)
                               throws PushAPIException

checks whether a synchronization has been performed.

Returns:

true if a synchronization was explicitly said to have previously occurred.

Throws:

PushAPIException

See Also:

sendSynchronizationCheckpoint(PushAPI, boolean)

sendSynchronizationCheckpoint

public void sendSynchronizationCheckpoint(PushAPI papi,
                                          boolean incremental)
                                   throws PushAPIException

saves that a synchronization has been performed.

Parameters:

connection -

Throws:

PushAPIException

See Also:

hasAlreadySynchronized(PushAPI)

setUpdateCheckpoint

public void setUpdateCheckpoint(CheckpointValue checkpointValue)

override the value of the update checkpoint (used by the incremental synchronization)

Parameters:

checkpointValue -