com.aspc.remote.task.extdbsync

Class ExtDBSyncHandler

java.lang.Object

com.aspc.remote.task.extdbsync.ExtDBSyncHandler

All Implemented Interfaces:

TaskHandler

Direct Known Subclasses:

SyncNonSTHdlr

public class ExtDBSyncHandler
extends java.lang.Object
implements TaskHandler

Updates an external database with changes made to stSoftware data in real time. The handler implements the handleTask method which will be called by the TaskManager whenever a transaction is processed containing changes to classes that we are interested in
THREAD MODE: NON-MUTABLE

Since:

23 September 2005

Author:

Jason McGrath

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATT_VALIDATE_ACTION
static java.lang.String	ATT_VALIDATE_CODE
static java.lang.String	ATT_VALIDATE_CONDITIONS
static java.lang.String	ATT_VALIDATE_FILTER_FIELD
static java.lang.String	ATT_VALIDATE_FILTER_PATTERN
static java.lang.String	ATT_VALIDATE_MESSAGE
static java.lang.String	ATT_VALIDATE_PATTERN
static java.lang.String	MODE_ACID ACID mode
static java.lang.String	MODE_AUTO AUTO mode
static java.lang.String	TAG_VALIDATE

Constructor Summary

Constructors

Constructor and Description
ExtDBSyncHandler()

Method Summary

Modifier and Type	Method and Description
void	addDataBase(java.lang.String name, DataBase db, java.lang.String mode) Adds a new Database to the list of databases
void	addDataBase(java.lang.String name, java.lang.String type, java.lang.String url, java.lang.String user, java.lang.String pass, java.lang.String mode) Adds a new Database to the list of databases
ExtDBSyncTableDef	addTable(java.lang.String srcName, java.lang.String destName, java.lang.String databaseName) Adds a new table definition to the definition list
ExtDBSyncTableDef	addTable(java.lang.String srcClassName, java.lang.String destName, java.lang.String databaseName, java.lang.String updateHandler, java.lang.String filter) Adds a new table definition to the definition list
protected TransactionAnalysis	analyseTransactions(Executor executor, long transID, SoapResultSet transRecord) analyze all the transactions.
void	beginTask(TaskManager manager, Executor executor, java.lang.String xml) begin the task and process any parameters
void	configure(java.lang.String fileName) Loads the table/field mappings from the supplied file
void	doSort(ExtDBSyncUpdate[] sortedList) Sort the list of updates so that the updates are done in the correct order based on dependencies, i.e If an Invoice is linked to a Person then the Person must be created first in the target database before the Invoice is.
java.lang.String	encodeValue(DataBase db, ExtDBSyncFieldDef fieldDef, java.lang.String inValue) Formats the supplied value so that it is compatible with the type of field being updated
protected DataBase	getDataBase(java.lang.String name) Retrieves the database for the supplied database name
protected java.util.HashMap	getFldValueMap(Executor executor, DataBase db, java.lang.String transid, long rowid, ExtDBSyncTableDef tableDef, java.lang.String action, TransactionAnalysis ta) Get value map.
protected java.lang.String	getMode(java.lang.String name)
java.lang.String[]	getSrcClasses() Returns a list of classes from the source database based on the mapping definitions
ExtDBSyncTableDef[]	getTableDefinitions(java.lang.String srcClassName) Returns a list of table definitions that have the supplied source class name
protected ExtDBSyncUpdate	getUpdateHandler(ExtDBSyncTableDef tableDef, java.lang.String transId, java.lang.String action, java.util.HashMap valMap, Executor executor) Get value map.
void	handleTask(Executor executor, java.lang.String transid, SoapResultSet transRecord) Processes the next supplied transaction by identifying the classes changed and updating the external database based on the field mappings.
protected void	initParentClasses(Executor executor)
protected boolean	isInteresting(Executor executor, long transID, ExtDBSyncTableDef td, long rowID) Is this transaction interesting ?
void	loadDoc(java.io.File file) Loads the table/field mappings from the supplied file

Methods inherited from class java.lang.Object

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

Field Detail

MODE_ACID

public static final java.lang.String MODE_ACID

ACID mode

See Also:

Constant Field Values

MODE_AUTO

public static final java.lang.String MODE_AUTO

AUTO mode

See Also:

Constant Field Values

TAG_VALIDATE

public static final java.lang.String TAG_VALIDATE

See Also:

Constant Field Values

ATT_VALIDATE_CODE

public static final java.lang.String ATT_VALIDATE_CODE

See Also:

Constant Field Values

ATT_VALIDATE_CONDITIONS

public static final java.lang.String ATT_VALIDATE_CONDITIONS

See Also:

Constant Field Values

ATT_VALIDATE_MESSAGE

public static final java.lang.String ATT_VALIDATE_MESSAGE

See Also:

Constant Field Values

ATT_VALIDATE_PATTERN

public static final java.lang.String ATT_VALIDATE_PATTERN

See Also:

Constant Field Values

ATT_VALIDATE_ACTION

public static final java.lang.String ATT_VALIDATE_ACTION

See Also:

Constant Field Values

ATT_VALIDATE_FILTER_FIELD

public static final java.lang.String ATT_VALIDATE_FILTER_FIELD

See Also:

Constant Field Values

ATT_VALIDATE_FILTER_PATTERN

public static final java.lang.String ATT_VALIDATE_FILTER_PATTERN

See Also:

Constant Field Values

Constructor Detail

ExtDBSyncHandler

public ExtDBSyncHandler()

Method Detail

beginTask

public void beginTask(@Nonnull
                      TaskManager manager,
                      @Nonnull
                      Executor executor,
                      @Nonnull
                      java.lang.String xml)
               throws java.lang.Exception

begin the task and process any parameters

Specified by:

beginTask in interface TaskHandler

Parameters:

xml - the parameters

manager - the task manager

executor - the server connection

Throws:

java.lang.Exception - a serious problem

initParentClasses

protected void initParentClasses(@Nonnull
                                 Executor executor)
                          throws java.lang.Exception

Parameters:

executor -

Throws:

java.lang.Exception - a serious problem.

isInteresting

@CheckReturnValue
protected boolean isInteresting(Executor executor,
                                                  long transID,
                                                  ExtDBSyncTableDef td,
                                                  long rowID)

Is this transaction interesting ?

Parameters:

executor -

transID -

td -

rowID -

Returns:

the value

analyseTransactions

protected TransactionAnalysis analyseTransactions(Executor executor,
                                                  long transID,
                                                  SoapResultSet transRecord)
                                           throws java.lang.Exception

analyze all the transactions.

Parameters:

executor -

transID -

transRecord -

Returns:

the value

Throws:

java.lang.Exception - a serious problem.

handleTask

public void handleTask(@Nonnull
                       Executor executor,
                       @Nonnull
                       java.lang.String transid,
                       @Nonnull
                       SoapResultSet transRecord)
                throws java.lang.Exception

Processes the next supplied transaction by identifying the classes changed and updating the external database based on the field mappings. see TaskHandler.handleTask for more information

Specified by:

handleTask in interface TaskHandler

Parameters:

executor - an Executor object for running SQL

transid - the transaction id for this notification

transRecord - the transaction record for this transaction id

Throws:

java.lang.Exception - A serious error

doSort

public void doSort(ExtDBSyncUpdate[] sortedList)

Sort the list of updates so that the updates are done in the correct order based on dependencies, i.e If an Invoice is linked to a Person then the Person must be created first in the target database before the Invoice is. However if both objects are being deleted then the Invoice must be deleted first. We can't use the standard java sort as we need to ensure that every object is compared to the each other.

Parameters:

sortedList - List of update objects that need to be sorted

encodeValue

public java.lang.String encodeValue(DataBase db,
                                    ExtDBSyncFieldDef fieldDef,
                                    java.lang.String inValue)
                             throws java.lang.Exception

Formats the supplied value so that it is compatible with the type of field being updated

Parameters:

db - - database to be updated

fieldDef - - field definition for external database

inValue - - Value to be converted

Returns:

Formatted string

Throws:

java.lang.Exception - A serious error

configure

public void configure(java.lang.String fileName)
               throws java.lang.Exception

Loads the table/field mappings from the supplied file

Parameters:

fileName - - name of file to be loaded

Throws:

java.lang.Exception - A serious error

loadDoc

public void loadDoc(@Nonnull
                    java.io.File file)
             throws java.lang.Exception

Loads the table/field mappings from the supplied file

Parameters:

file - - file to be loaded

Throws:

java.lang.Exception - A serious error

getDataBase

@CheckReturnValue
 @Nonnull
protected DataBase getDataBase(@Nonnull
                                                           java.lang.String name)

Retrieves the database for the supplied database name

Parameters:

name - - name of database to be retrieved

Returns:

- Database if one is found otherwise null

getMode

@CheckReturnValue
 @Nullable
protected java.lang.String getMode(@Nonnull
                                                                java.lang.String name)

Parameters:

name - the database

Returns:

the mode

addDataBase

public void addDataBase(java.lang.String name,
                        java.lang.String type,
                        java.lang.String url,
                        java.lang.String user,
                        java.lang.String pass,
                        java.lang.String mode)
                 throws java.lang.Exception

Adds a new Database to the list of databases

Parameters:

name - - Name used to retrieve the database

type - - type of database, i.e. POSTGRESQL

url - - server/database URL

user - - user name

pass - - password of user

mode - the mode ACID

Throws:

java.lang.Exception - A serious error

addDataBase

public void addDataBase(java.lang.String name,
                        DataBase db,
                        java.lang.String mode)
                 throws java.lang.Exception

Adds a new Database to the list of databases

Parameters:

name - - Name used to retrieve the database

db - - database to be added

mode - the mode ACID

Throws:

java.lang.Exception - A serious error

addTable

public ExtDBSyncTableDef addTable(java.lang.String srcName,
                                  java.lang.String destName,
                                  java.lang.String databaseName)

Adds a new table definition to the definition list

Parameters:

srcName - - name of class in source database

destName - - name of table in destination database

databaseName - - name of destination database that this table is found in

Returns:

- new table definition object

addTable

public ExtDBSyncTableDef addTable(java.lang.String srcClassName,
                                  java.lang.String destName,
                                  java.lang.String databaseName,
                                  java.lang.String updateHandler,
                                  java.lang.String filter)

Adds a new table definition to the definition list

Parameters:

filter - - filter for the class

srcClassName - - name of class in source database

destName - - name of table in destination database

databaseName - - name of destination database that this table is found in

updateHandler - - name of handler class that updates will be performed through

Returns:

- new table definition object

getSrcClasses

public java.lang.String[] getSrcClasses()

Returns a list of classes from the source database based on the mapping definitions

Returns:

- list of classes

getTableDefinitions

public ExtDBSyncTableDef[] getTableDefinitions(java.lang.String srcClassName)

Returns a list of table definitions that have the supplied source class name

Parameters:

srcClassName - - name of class in source database

Returns:

- array of table definitions

getFldValueMap

@CheckReturnValue
 @Nonnull
protected java.util.HashMap getFldValueMap(Executor executor,
                                                                       DataBase db,
                                                                       java.lang.String transid,
                                                                       long rowid,
                                                                       ExtDBSyncTableDef tableDef,
                                                                       java.lang.String action,
                                                                       TransactionAnalysis ta)
                                                                throws java.lang.Exception

Get value map.

Parameters:

executor - executor

db - the database

transid - transaction id

rowid - RowId for object

tableDef - tableDef

action - action performed on the object

ta - the analysis

Returns:

map

Throws:

java.lang.Exception - A serious error

getUpdateHandler

protected ExtDBSyncUpdate getUpdateHandler(ExtDBSyncTableDef tableDef,
                                           java.lang.String transId,
                                           java.lang.String action,
                                           java.util.HashMap valMap,
                                           Executor executor)
                                    throws java.lang.Exception

Get value map.

Parameters:

tableDef - the table definition details

transId - the transaction id

action - action that was performed on object

valMap - list of fieldname/val pairs

executor - who should run it.

Returns:

update handler for this table

Throws:

java.lang.Exception - in case of error