openr66.database.data
Class DbRule

java.lang.Object
  goldengate.common.database.data.AbstractDbData
      openr66.database.data.DbRule

public class DbRule
extends goldengate.common.database.data.AbstractDbData

Rule Table object

Author:

Frederic Bregier

Nested Class Summary

static class

DbRule.Columns

Nested classes/interfaces inherited from class goldengate.common.database.data.AbstractDbData

goldengate.common.database.data.AbstractDbData.UpdatedInfo

Field Summary

String	archivePath The associated Archive Path
static int[]	dbTypes
String	idRule Global Id
String	ids The Name addresses (serverIds)
String[]	idsArray The Ids as an array
protected static String	insertAllValues
int	mode Supported Mode for this rule (SENDMODE => SENDMD5MODE, RECVMODE => RECVMD5MODE)
static int	NBPRKEY
String	recvPath The associated Recv Path
String	rerrorTasks The associated Error Tasks for Receiver
String[][]	rerrorTasksArray The associated Error Tasks as an array for Receiver
String	rpostTasks The associated Post Tasks for Receiver
String[][]	rpostTasksArray The associated Post Tasks as an array for Receiver
String	rpreTasks The associated Pre Tasks for Receiver
String[][]	rpreTasksArray The associated Pre Tasks as an array for Receiver
protected static String	selectAllFields
String	sendPath The associated Send Path
String	serrorTasks The associated Error Tasks for Sender
String[][]	serrorTasksArray The associated Error Tasks as an array for Sender
String	spostTasks The associated Post Tasks for Sender
String[][]	spostTasksArray The associated Post Tasks as an array for Sender
String	spreTasks The associated Pre Tasks for Sender
String[][]	spreTasksArray The associated Pre Tasks as an array for Sender
static String	table
static String	TASK_DELAY Internal context XML fields
static String	TASK_PATH Internal context XML fields
static String	TASK_TYPE Internal context XML fields
protected static String	updateAllFields
String	workPath The associated Work Path

Fields inherited from class goldengate.common.database.data.AbstractDbData

allFields, dbSession, isSaved, otherFields, primaryKey

Constructor Summary

DbRule(goldengate.common.database.DbSession dbSession, String idRule)

DbRule(goldengate.common.database.DbSession dbSession, String idrule, String[] idsArrayRef, int mode, String recvpath, String sendpath, String archivepath, String workpath, String[][] rpretasksArray, String[][] rposttasksArray, String[][] rerrortasksArray, String[][] spretasksArray, String[][] sposttasksArray, String[][] serrortasksArray)
Constructor used from XML file

DbRule(goldengate.common.database.DbSession dbSession, String idRule, String ids, int mode, String recvPath, String sendPath, String archivePath, String workPath, String rpreTasks, String rpostTasks, String rerrorTasks, String spreTasks, String spostTasks, String serrorTasks)

Method Summary

void	changeUpdatedInfo(goldengate.common.database.data.AbstractDbData.UpdatedInfo info)
boolean	checkHostAllow(String hostId) Check if the given hostTo is in the allowed list
void	delete()
static DbRule[]	deleteAll(goldengate.common.database.DbSession dbSession) Delete all entries (used when purge and reload)
boolean	exist()
static DbRule[]	getAllRules(goldengate.common.database.DbSession dbSession) Get All DbRule from database or from internal hashMap in case of no database support
static goldengate.common.database.DbPreparedStatement	getFilterPrepareStament(goldengate.common.database.DbSession session, String rule, int mode)
static DbRule	getFromStatement(goldengate.common.database.DbPreparedStatement preparedStatement) For instance from Commander when getting updated information
protected String	getInsertAllValues()
protected String	getSelectAllFields()
protected String	getTable()
protected String	getUpdateAllFields()
static goldengate.common.database.DbPreparedStatement	getUpdatedPrepareStament(goldengate.common.database.DbSession session)
protected String	getWherePrimaryKey()
protected void	initObject()
void	insert()
boolean	isRecvMode()
boolean	isSendMode()
String	printTasks(boolean isSender, DbTaskRunner.TASKSTEP step)
void	select()
String	setArchivePath(String filename) Get the full path from archivePath
protected void	setFromArray()
protected void	setFromArrayClone(DbRule source)
protected void	setPrimaryKey()
String	setRecvPath(String filename) Get the full path from RecvPath (used only in copy MODETRANS)
String	setSendPath(String filename) Get the full path from sendPath
protected void	setToArray()
String	setWorkingPath(String filename) Get the full path from workPath
String	toShortString() Object to String
String	toSpecializedHtml(R66Session session, String body)
String	toString() Object to String
void	update()

Methods inherited from class goldengate.common.database.data.AbstractDbData

get, getTrueValue, getValue, getValues, setTrueValue, setValue, setValues

Methods inherited from class java.lang.Object

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

Field Detail

dbTypes

public static final int[] dbTypes

table

public static final String table

See Also:

Constant Field Values

TASK_TYPE

public static final String TASK_TYPE

Internal context XML fields

See Also:

Constant Field Values

TASK_PATH

public static final String TASK_PATH

Internal context XML fields

See Also:

Constant Field Values

TASK_DELAY

public static final String TASK_DELAY

Internal context XML fields

See Also:

Constant Field Values

idRule

public String idRule

Global Id

ids

public String ids

The Name addresses (serverIds)

mode

public int mode

Supported Mode for this rule (SENDMODE => SENDMD5MODE, RECVMODE => RECVMD5MODE)

recvPath

public String recvPath

The associated Recv Path

sendPath

public String sendPath

The associated Send Path

archivePath

public String archivePath

The associated Archive Path

workPath

public String workPath

The associated Work Path

rpreTasks

public String rpreTasks

The associated Pre Tasks for Receiver

rpostTasks

public String rpostTasks

The associated Post Tasks for Receiver

rerrorTasks

public String rerrorTasks

The associated Error Tasks for Receiver

spreTasks

public String spreTasks

The associated Pre Tasks for Sender

spostTasks

public String spostTasks

The associated Post Tasks for Sender

serrorTasks

public String serrorTasks

The associated Error Tasks for Sender

idsArray

public String[] idsArray

The Ids as an array

rpreTasksArray

public String[][] rpreTasksArray

The associated Pre Tasks as an array for Receiver

rpostTasksArray

public String[][] rpostTasksArray

The associated Post Tasks as an array for Receiver

rerrorTasksArray

public String[][] rerrorTasksArray

The associated Error Tasks as an array for Receiver

spreTasksArray

public String[][] spreTasksArray

The associated Pre Tasks as an array for Sender

spostTasksArray

public String[][] spostTasksArray

The associated Post Tasks as an array for Sender

serrorTasksArray

public String[][] serrorTasksArray

The associated Error Tasks as an array for Sender

NBPRKEY

public static final int NBPRKEY

See Also:

Constant Field Values

selectAllFields

protected static final String selectAllFields

updateAllFields

protected static final String updateAllFields

insertAllValues

protected static final String insertAllValues

See Also:

Constant Field Values

Constructor Detail

DbRule

public DbRule(goldengate.common.database.DbSession dbSession,
              String idRule,
              String ids,
              int mode,
              String recvPath,
              String sendPath,
              String archivePath,
              String workPath,
              String rpreTasks,
              String rpostTasks,
              String rerrorTasks,
              String spreTasks,
              String spostTasks,
              String serrorTasks)

Parameters:

dbSession -

idRule -

ids -

mode -

recvPath -

sendPath -

archivePath -

workPath -

rpreTasks -

rpostTasks -

rerrorTasks -

spreTasks -

spostTasks -

serrorTasks -

DbRule

public DbRule(goldengate.common.database.DbSession dbSession,
              String idRule)
       throws goldengate.common.database.exception.GoldenGateDatabaseException

Parameters:

dbSession -

idRule -

Throws:

goldengate.common.database.exception.GoldenGateDatabaseException

DbRule

public DbRule(goldengate.common.database.DbSession dbSession,
              String idrule,
              String[] idsArrayRef,
              int mode,
              String recvpath,
              String sendpath,
              String archivepath,
              String workpath,
              String[][] rpretasksArray,
              String[][] rposttasksArray,
              String[][] rerrortasksArray,
              String[][] spretasksArray,
              String[][] sposttasksArray,
              String[][] serrortasksArray)

Constructor used from XML file

Parameters:

dbSession -

idrule -

idsArrayRef -

recvpath -

sendpath -

archivepath -

workpath -

rpretasksArray -

rposttasksArray -

rerrortasksArray -

spretasksArray -

sposttasksArray -

serrortasksArray -

Method Detail

initObject

protected void initObject()

Specified by:

initObject in class goldengate.common.database.data.AbstractDbData

getSelectAllFields

protected String getSelectAllFields()

Specified by:

getSelectAllFields in class goldengate.common.database.data.AbstractDbData

getTable

protected String getTable()

Specified by:

getTable in class goldengate.common.database.data.AbstractDbData

getInsertAllValues

protected String getInsertAllValues()

Specified by:

getInsertAllValues in class goldengate.common.database.data.AbstractDbData

getUpdateAllFields

protected String getUpdateAllFields()

Specified by:

getUpdateAllFields in class goldengate.common.database.data.AbstractDbData

setToArray

protected void setToArray()

Specified by:

setToArray in class goldengate.common.database.data.AbstractDbData

setFromArray

protected void setFromArray()
                     throws goldengate.common.database.exception.GoldenGateDatabaseSqlException

Specified by:

setFromArray in class goldengate.common.database.data.AbstractDbData

Throws:

goldengate.common.database.exception.GoldenGateDatabaseSqlException

setFromArrayClone

protected void setFromArrayClone(DbRule source)
                          throws goldengate.common.database.exception.GoldenGateDatabaseSqlException

Throws:

goldengate.common.database.exception.GoldenGateDatabaseSqlException

getWherePrimaryKey

protected String getWherePrimaryKey()

Specified by:

getWherePrimaryKey in class goldengate.common.database.data.AbstractDbData

setPrimaryKey

protected void setPrimaryKey()

Specified by:

setPrimaryKey in class goldengate.common.database.data.AbstractDbData

deleteAll

public static DbRule[] deleteAll(goldengate.common.database.DbSession dbSession)
                          throws goldengate.common.database.exception.GoldenGateDatabaseException

Delete all entries (used when purge and reload)

Parameters:

dbSession -

Returns:

the previous existing array of DbRule

Throws:

goldengate.common.database.exception.GoldenGateDatabaseException

delete

public void delete()
            throws goldengate.common.database.exception.GoldenGateDatabaseException

Overrides:

delete in class goldengate.common.database.data.AbstractDbData

Throws:

goldengate.common.database.exception.GoldenGateDatabaseException

insert

public void insert()
            throws goldengate.common.database.exception.GoldenGateDatabaseException

Overrides:

insert in class goldengate.common.database.data.AbstractDbData

Throws:

goldengate.common.database.exception.GoldenGateDatabaseException

exist

public boolean exist()
              throws goldengate.common.database.exception.GoldenGateDatabaseException

Overrides:

exist in class goldengate.common.database.data.AbstractDbData

Throws:

goldengate.common.database.exception.GoldenGateDatabaseException

select

public void select()
            throws goldengate.common.database.exception.GoldenGateDatabaseException

Overrides:

select in class goldengate.common.database.data.AbstractDbData

Throws:

goldengate.common.database.exception.GoldenGateDatabaseException

update

public void update()
            throws goldengate.common.database.exception.GoldenGateDatabaseException

Overrides:

update in class goldengate.common.database.data.AbstractDbData

Throws:

goldengate.common.database.exception.GoldenGateDatabaseException

getAllRules

public static DbRule[] getAllRules(goldengate.common.database.DbSession dbSession)
                            throws goldengate.common.database.exception.GoldenGateDatabaseNoConnectionException,
                                   goldengate.common.database.exception.GoldenGateDatabaseSqlException

Get All DbRule from database or from internal hashMap in case of no database support

Parameters:

dbSession - may be null

Returns:

the array of DbRule

Throws:

goldengate.common.database.exception.GoldenGateDatabaseNoConnectionException

goldengate.common.database.exception.GoldenGateDatabaseSqlException

getFromStatement

public static DbRule getFromStatement(goldengate.common.database.DbPreparedStatement preparedStatement)
                               throws goldengate.common.database.exception.GoldenGateDatabaseNoConnectionException,
                                      goldengate.common.database.exception.GoldenGateDatabaseSqlException

For instance from Commander when getting updated information

Parameters:

preparedStatement -

Returns:

the next updated DbRule

Throws:

goldengate.common.database.exception.GoldenGateDatabaseNoConnectionException

goldengate.common.database.exception.GoldenGateDatabaseSqlException

getUpdatedPrepareStament

public static goldengate.common.database.DbPreparedStatement getUpdatedPrepareStament(goldengate.common.database.DbSession session)
                                                                               throws goldengate.common.database.exception.GoldenGateDatabaseNoConnectionException,
                                                                                      goldengate.common.database.exception.GoldenGateDatabaseSqlException

Returns:

the DbPreparedStatement for getting Updated Object

Throws:

goldengate.common.database.exception.GoldenGateDatabaseNoConnectionException

goldengate.common.database.exception.GoldenGateDatabaseSqlException

changeUpdatedInfo

public void changeUpdatedInfo(goldengate.common.database.data.AbstractDbData.UpdatedInfo info)

Specified by:

changeUpdatedInfo in class goldengate.common.database.data.AbstractDbData

setRecvPath

public String setRecvPath(String filename)
                   throws OpenR66ProtocolSystemException

Get the full path from RecvPath (used only in copy MODETRANS)

Parameters:

filename -

Returns:

the full String path

Throws:

OpenR66ProtocolSystemException

setSendPath

public String setSendPath(String filename)
                   throws OpenR66ProtocolSystemException

Get the full path from sendPath

Parameters:

filename -

Returns:

the full String path

Throws:

OpenR66ProtocolSystemException

setArchivePath

public String setArchivePath(String filename)
                      throws OpenR66ProtocolSystemException

Get the full path from archivePath

Parameters:

filename -

Returns:

the full String path

Throws:

OpenR66ProtocolSystemException

setWorkingPath

public String setWorkingPath(String filename)
                      throws OpenR66ProtocolSystemException

Get the full path from workPath

Parameters:

filename -

Returns:

the full String path

Throws:

OpenR66ProtocolSystemException

checkHostAllow

public boolean checkHostAllow(String hostId)

Check if the given hostTo is in the allowed list

Parameters:

hostId -

Returns:

True if allow, else False

isSendMode

public boolean isSendMode()

Returns:

True if this rule is adapted for SENDMODE

isRecvMode

public boolean isRecvMode()

Returns:

True if this rule is adapted for RECVMODE

toString

public String toString()

Object to String

Overrides:

toString in class Object

Returns:

the string that displays this object

See Also:

Object.toString()

printTasks

public String printTasks(boolean isSender,
                         DbTaskRunner.TASKSTEP step)

Parameters:

isSender -

step -

Returns:

a string that prints (debug) the tasks to execute

toShortString

public String toShortString()

Object to String

Returns:

the string that displays this object

See Also:

Object.toString()

getFilterPrepareStament

public static goldengate.common.database.DbPreparedStatement getFilterPrepareStament(goldengate.common.database.DbSession session,
                                                                                     String rule,
                                                                                     int mode)
                                                                              throws goldengate.common.database.exception.GoldenGateDatabaseNoConnectionException,
                                                                                     goldengate.common.database.exception.GoldenGateDatabaseSqlException

Parameters:

session -

rule -

mode -

Returns:

the DbPreparedStatement according to the filter

Throws:

goldengate.common.database.exception.GoldenGateDatabaseNoConnectionException

goldengate.common.database.exception.GoldenGateDatabaseSqlException

toSpecializedHtml

public String toSpecializedHtml(R66Session session,
                                String body)

Parameters:

session -

body -

Returns:

the runner in Html format specified by body by replacing all instance of fields