org.waarp.openr66.database.data

Class DbRule

java.lang.Object

org.waarp.common.database.data.AbstractDbData

org.waarp.openr66.database.data.AbstractDbDataDao<Rule>

org.waarp.openr66.database.data.DbRule

public class DbRule
extends AbstractDbDataDao<Rule>

Rule Table object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DbRule.Columns

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

AbstractDbData.UpdatedInfo

Field Summary

Fields

Modifier and Type	Field and Description
static int[]	dbTypes
static DbRule.Columns[]	indexes
protected static String	selectAllFields
static String	table
static String	TASK_COMMENT Internal context XML fields
static String	TASK_DELAY Internal context XML fields
static String	TASK_PATH Internal context XML fields
static String	TASK_RANK Internal context XML fields
static String	TASK_TYPE Internal context XML fields

Fields inherited from class org.waarp.openr66.database.data.AbstractDbDataDao

JSON_MODEL, pojo, SHOULD_NOT_BE_CALLED

Fields inherited from class org.waarp.common.database.data.AbstractDbData

allFields, dbSession, isSaved, otherFields, primaryKey

Constructor Summary

Constructors

Constructor and Description
DbRule(com.fasterxml.jackson.databind.node.ObjectNode source) Constructor from Json
DbRule(Rule rule)
DbRule(String idRule)
DbRule(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(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

Modifier and Type	Method and Description
void	changeUpdatedInfo(AbstractDbData.UpdatedInfo info) Change UpdatedInfo status
boolean	checkHostAllow(String hostId) Check if the given hostTo is in the allowed list
protected void	checkPathes()
protected void	checkValues()
void	delete() Delete object from table DbRule only if no DbTaskRunner is using it.
static DbRule[]	deleteAll() Delete all Rules but returns original one, therefore not checking if any TaskRunner are using it (used by reloading rules)
static DbRule[]	getAllRules() Get All DbRule from database or from internal hashMap in case of no database support
String	getArchivePath()
protected AbstractDAO<Rule>	getDao(boolean isCacheable)
static DbPreparedStatement	getFilterPrepareStament(DbSession session, String rule, int mode)
static DbRule	getFromStatement(DbPreparedStatement preparedStatement) For instance from Commander when getting updated information
String	getIdRule()
String[]	getIdsArray()
static String	getJson(DbPreparedStatement preparedStatement, int limit) Write selected DbRule to a Json String
String	getJsonAsString()
int	getMode()
protected String	getPrimaryField()
protected String	getPrimaryKey()
String	getRecvPath()
String[][]	getRerrorTasksArray()
String[][]	getRpostTasksArray()
String[][]	getRpreTasksArray()
String	getRuleArchivePath()
String	getRuleRecvPath()
String	getRuleSendPath()
String	getRuleWorkPath()
String	getSendPath()
String[][]	getSerrorTasksArray()
String[][]	getSpostTasksArray()
String[][]	getSpreTasksArray()
protected String	getTable()
static DbRule[]	getUpdatedPrepareStament()
String	getWorkPath()
protected void	initObject() To setup primaryKey, otherFields, allFields.
boolean	isRecvMode()
boolean	isSendMode()
String	printTasks(boolean isSender, DbTaskRunner.TASKSTEP step)
String	setArchivePath(String filename) Get the full path from archivePath
void	setFromJson(com.fasterxml.jackson.databind.node.ObjectNode node, boolean ignorePrimaryKey) Set the values from the Json node to the current object (no database access)
protected void	setFromJson(String field, com.fasterxml.jackson.databind.JsonNode value)
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
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

Methods inherited from class org.waarp.openr66.database.data.AbstractDbDataDao

asJson, exist, getInsertAllValues, getJson, getSelectAllFields, getUpdateAllFields, getValues, getWherePrimaryKey, insert, select, setFromArray, setPrimaryKey, setToArray, toJson, update, validateLength, validateLength

Methods inherited from class org.waarp.common.database.data.AbstractDbData

getAllFields, getTrueValue, setTrueValue, 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

indexes

public static final DbRule.Columns[] indexes

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

TASK_RANK

public static final String TASK_RANK

Internal context XML fields

See Also:

Constant Field Values

TASK_COMMENT

public static final String TASK_COMMENT

Internal context XML fields

See Also:

Constant Field Values

selectAllFields

protected static final String selectAllFields

Constructor Detail

DbRule

public DbRule(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)
       throws WaarpDatabaseSqlException

Parameters:

idRule -

ids -

mode -

recvPath -

sendPath -

archivePath -

workPath -

rpreTasks -

rpostTasks -

rerrorTasks -

spreTasks -

spostTasks -

serrorTasks -

Throws:

WaarpDatabaseSqlException

DbRule

public DbRule(String idRule)
       throws WaarpDatabaseException

Parameters:

idRule -

Throws:

WaarpDatabaseException

DbRule

public DbRule(Rule rule)

DbRule

public DbRule(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)
       throws WaarpDatabaseSqlException

Constructor used from XML file

Parameters:

idrule -

idsArrayRef -

recvpath -

sendpath -

archivepath -

workpath -

rpretasksArray -

rposttasksArray -

rerrortasksArray -

spretasksArray -

sposttasksArray -

serrortasksArray -

Throws:

WaarpDatabaseSqlException

DbRule

public DbRule(com.fasterxml.jackson.databind.node.ObjectNode source)
       throws WaarpDatabaseSqlException

Constructor from Json

Parameters:

source -

Throws:

WaarpDatabaseSqlException

Method Detail

initObject

protected final void initObject()

Description copied from class: AbstractDbData

To setup primaryKey, otherFields, allFields. Note this initObject is called within constructor of AbstractDbData. Be careful that no data is actually initialized at this stage.

Overrides:

initObject in class AbstractDbDataDao<Rule>

getTable

protected final String getTable()

Specified by:

getTable in class AbstractDbDataDao<Rule>

getDao

protected final AbstractDAO<Rule> getDao(boolean isCacheable)
                                  throws DAOConnectionException

Specified by:

getDao in class AbstractDbDataDao<Rule>

Throws:

DAOConnectionException

getPrimaryKey

protected final String getPrimaryKey()

Specified by:

getPrimaryKey in class AbstractDbDataDao<Rule>

getPrimaryField

protected final String getPrimaryField()

Specified by:

getPrimaryField in class AbstractDbDataDao<Rule>

checkPathes

protected final void checkPathes()
                          throws WaarpDatabaseSqlException

Throws:

WaarpDatabaseSqlException

checkValues

protected final void checkValues()
                          throws WaarpDatabaseSqlException

Specified by:

checkValues in class AbstractDbDataDao<Rule>

Throws:

WaarpDatabaseSqlException

setFromJson

public final void setFromJson(com.fasterxml.jackson.databind.node.ObjectNode node,
                              boolean ignorePrimaryKey)
                       throws WaarpDatabaseSqlException

Description copied from class: AbstractDbDataDao

Set the values from the Json node to the current object (no database access)

Overrides:

setFromJson in class AbstractDbDataDao<Rule>

ignorePrimaryKey - True will ignore primaryKey from Json

Throws:

WaarpDatabaseSqlException

setFromJson

protected final void setFromJson(String field,
                                 com.fasterxml.jackson.databind.JsonNode value)
                          throws WaarpDatabaseSqlException

Specified by:

setFromJson in class AbstractDbDataDao<Rule>

Throws:

WaarpDatabaseSqlException

delete

public final void delete()
                  throws WaarpDatabaseException

Delete object from table DbRule only if no DbTaskRunner is using it.

Overrides:

delete in class AbstractDbDataDao<Rule>

Throws:

WaarpDatabaseException

deleteAll

public static DbRule[] deleteAll()
                          throws WaarpDatabaseException

Delete all Rules but returns original one, therefore not checking if any TaskRunner are using it (used by reloading rules)

Returns:

the previously existing DbRule

Throws:

WaarpDatabaseException

getAllRules

public static DbRule[] getAllRules()
                            throws WaarpDatabaseNoConnectionException

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

Returns:

the array of DbRule

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getFromStatement

public static DbRule getFromStatement(DbPreparedStatement preparedStatement)
                               throws WaarpDatabaseNoConnectionException,
                                      WaarpDatabaseSqlException

For instance from Commander when getting updated information

Parameters:

preparedStatement -

Returns:

the next updated DbRule

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getUpdatedPrepareStament

public static DbRule[] getUpdatedPrepareStament()
                                         throws WaarpDatabaseNoConnectionException

Returns:

the DbPreparedStatement for getting Updated Object

Throws:

WaarpDatabaseNoConnectionException

changeUpdatedInfo

public final void changeUpdatedInfo(AbstractDbData.UpdatedInfo info)

Description copied from class: AbstractDbDataDao

Change UpdatedInfo status

Specified by:

changeUpdatedInfo in class AbstractDbDataDao<Rule>

setRecvPath

public final String setRecvPath(String filename)

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

Parameters:

filename -

Returns:

the full String path

setSendPath

public final String setSendPath(String filename)

Get the full path from sendPath

Parameters:

filename -

Returns:

the full String path

setArchivePath

public final String setArchivePath(String filename)

Get the full path from archivePath

Parameters:

filename -

Returns:

the full String path

setWorkingPath

public final String setWorkingPath(String filename)

Get the full path from workPath

Parameters:

filename -

Returns:

the full String path

checkHostAllow

public final boolean checkHostAllow(String hostId)

Check if the given hostTo is in the allowed list

Parameters:

hostId -

Returns:

True if allow, else False

isSendMode

public final boolean isSendMode()

Returns:

True if this rule is adapted for SENDMODE

isRecvMode

public final boolean isRecvMode()

Returns:

True if this rule is adapted for RECVMODE

toString

public final String toString()

Object to String

Overrides:

toString in class Object

Returns:

the string that displays this object

See Also:

Object.toString()

printTasks

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

Parameters:

isSender -

step -

Returns:

a string that prints (debug) the tasks to execute

toShortString

public final String toShortString()

Object to String

Returns:

the string that displays this object

See Also:

Object.toString()

getFilterPrepareStament

public static DbPreparedStatement getFilterPrepareStament(DbSession session,
                                                          String rule,
                                                          int mode)
                                                   throws WaarpDatabaseNoConnectionException,
                                                          WaarpDatabaseSqlException

Parameters:

session -

rule -

mode -

Returns:

the DbPreparedStatement according to the filter

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getJson

public static String getJson(DbPreparedStatement preparedStatement,
                             int limit)
                      throws WaarpDatabaseNoConnectionException,
                             WaarpDatabaseSqlException

Write selected DbRule to a Json String

Parameters:

preparedStatement -

Returns:

the associated Json String

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getJsonAsString

public final String getJsonAsString()

Returns:

the Json string for this

toSpecializedHtml

public final String toSpecializedHtml(R66Session session,
                                      String body)

Parameters:

session -

body -

Returns:

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

getRecvPath

public final String getRecvPath()

Returns:

the recvPath

getSendPath

public final String getSendPath()

Returns:

the sendPath

getArchivePath

public final String getArchivePath()

Returns:

the archivePath

getWorkPath

public final String getWorkPath()

Returns:

the workPath

getRuleRecvPath

public final String getRuleRecvPath()

Returns:

the Rule recvPath

getRuleSendPath

public final String getRuleSendPath()

Returns:

the Rule sendPath

getRuleArchivePath

public final String getRuleArchivePath()

Returns:

the Rule archivePath

getRuleWorkPath

public final String getRuleWorkPath()

Returns:

the Rule workPath

getIdRule

public final String getIdRule()

Returns:

the idRule

getMode

public final int getMode()

Returns:

the mode

getIdsArray

public final String[] getIdsArray()

Returns:

the idsArray

getRpreTasksArray

public final String[][] getRpreTasksArray()

Returns:

the rpreTasksArray

getRpostTasksArray

public final String[][] getRpostTasksArray()

Returns:

the rpostTasksArray

getRerrorTasksArray

public final String[][] getRerrorTasksArray()

Returns:

the rerrorTasksArray

getSpreTasksArray

public final String[][] getSpreTasksArray()

Returns:

the spreTasksArray

getSpostTasksArray

public final String[][] getSpostTasksArray()

Returns:

the spostTasksArray

getSerrorTasksArray

public final String[][] getSerrorTasksArray()

Returns:

the serrorTasksArray