org.waarp.openr66.database.data

Class DbTaskRunner

java.lang.Object

org.waarp.common.database.data.AbstractDbData

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

org.waarp.openr66.database.data.DbTaskRunner

public class DbTaskRunner
extends AbstractDbDataDao<Transfer>

Task Runner from pre operation to transfer to post operation, except in case of error

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DbTaskRunner.Columns
static class	DbTaskRunner.TASKSTEP GlobalStep Bounds

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 String	fieldseq
static DbTaskRunner.Columns[]	indexes
protected static String	insertAllValues
static String	JSON_ORIGINALSIZE
static String	JSON_RESCHEDULE
static String	JSON_THROUGHMODE
static int	NBPRKEY Special For DbTaskRunner
protected static String	selectAllFields
static String	table
protected static String	updateAllFields
static String	XMLEXTENSION
static String	XMLRUNNER
static String	XMLRUNNERS

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

JSON_MODEL, pojo

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

allFields, dbSession, isSaved, otherFields, primaryKey

Constructor Summary

Constructors

Constructor and Description
DbTaskRunner(DbRule rule, boolean isSender, RequestPacket requestPacket, String requested, Timestamp startTime) Constructor for submission (no transfer session), from database.
DbTaskRunner(long id, String requested) Constructor to initiate a request with a valid previous Special Id so loaded from database.
DbTaskRunner(long id, String requester, String requested) Minimal constructor from database
DbTaskRunner(long id, String requester, String requested, String owner) Minimal constructor from database
DbTaskRunner(com.fasterxml.jackson.databind.node.ObjectNode source) To create a new DbTaskRunner (specialId could be invalid) without making any entry in the database
DbTaskRunner(R66Session session, DbRule rule, boolean isSender, RequestPacket requestPacket) Constructor from a request without a valid Special Id to be inserted into databases
DbTaskRunner(R66Session session, DbRule rule, long id, String requester, String requested) Constructor from a request with a valid Special Id so loaded from database
DbTaskRunner(Transfer transfer)

Method Summary

Modifier and Type	Method and Description
void	addToTransferMap(String key, Object value) Helper to set a new (key, value) in the map Transfer
String	asXML()
String	backendXmlFilename()
static void	changeFinishedToDone() Change CompleteOk+ALLDONETASK to Updated = DONE TaskRunner from database.
void	changeUpdatedInfo(AbstractDbData.UpdatedInfo info) Change UpdatedInfo status
boolean	checkFromDbForSubmit() Shall be called to ensure that item is really available in database
void	checkThroughMode()
void	clean()
void	clear() Clear the runner
static int	clearCache() To enable clear of oldest entries in the cache
boolean	continueTransfer()
void	create() As insert but with the ability to change the SpecialId
static void	createLruCache(int limit, long ttl) Create the LRU cache
void	deleteTempFile() Delete the temporary empty file (retrieved file at rank 0)
void	deleteXmlWorkNoDb() Delete the backend XML file for the current TaskRunner for NoDb Client
boolean	exist() Test the existence of the current object
boolean	existXmlWorkNoDb()
void	finalizeTransfer(LocalChannelReference localChannelReference, R66File file, R66Result finalValue, boolean status) Once the transfer is over, finalize the Runner by running the error or post operation according to the status.
static void	finishSelectOrCountPrepareStatement(DbPreparedStatement pstt, long time) Set the current time in the given updatedPreparedStatement
int	finishTransferTask(ErrorCode code) Set the status of the transfer
boolean	forceSaveStatus() This method is to be called each time an operation is happening on Runner and it is forced (for SelfRequest handling)
long	freespace(R66Session session, boolean isWorkingPath)
long	freespaceMB(R66Session session)
static DbTaskRunner	fromStringXml(String xml, boolean reverse) Reload a to submitted runner from a remote partner's log (so reversing isSender should be true)
int	getBlocksize()
static DbPreparedStatement	getCountInfoPrepareStatement(DbSession session)
static DbPreparedStatement	getCountInOutErrorPrepareStatement(DbSession session, boolean in) Running or not transfers are concerned
static DbPreparedStatement	getCountInOutRunningPrepareStatement(DbSession session, boolean in, boolean running) Running or not transfers are concerned
static DbPreparedStatement	getCountStatusPrepareStatement(DbSession session)
static DbPreparedStatement	getCountStatusRunningPrepareStatement(DbSession session, ErrorCode status) Only running transfers
static DbPreparedStatement	getCountStepPrepareStatement(DbSession session, DbTaskRunner.TASKSTEP globalstep)
protected AbstractDAO<Transfer>	getDao()
ErrorCode	getErrorInfo()
String	getFileInformation()
String	getFilename()
static DbPreparedStatement	getFilterPrepareStatement(DbSession session, int limit, boolean orderBySpecialId, String startid, String stopid, Timestamp start, Timestamp stop, String rule, String req, boolean pending, boolean transfer, boolean error, boolean done, boolean all)
static DbPreparedStatement	getFilterPrepareStatement(DbSession session, int limit, boolean orderBySpecialId, String startid, String stopid, Timestamp start, Timestamp stop, String rule, String req, boolean pending, boolean transfer, boolean error, boolean done, boolean all, String owner)
static DbTaskRunner	getFromStatement(DbPreparedStatement preparedStatement) For instance from Commander when getting updated information
static DbTaskRunner	getFromStatementNoDbRule(DbPreparedStatement preparedStatement) For REST interface, to prevent DbRule issue
static DbTaskRunner	getFromStatementNoRule(DbPreparedStatement preparedStatement) For instance from Commander when getting updated information This version tries to load DbRule but will not make any error if not found!
Object	getFromTransferMap(String key)
String	getFullFilePath()
int	getGloballaststep()
DbTaskRunner.TASKSTEP	getGlobalStep()
com.fasterxml.jackson.databind.node.ObjectNode	getJson() Create the equivalent object in Json (no database access)
static String	getJson(DbPreparedStatement preparedStatement, int limit) Write selected TaskRunners to a Json String
String	getJsonAsString()
String	getKey() Used internally
DbTaskRunner.TASKSTEP	getLastGlobalStep()
LocalChannelReference	getLocalChannelReference()
static DbPreparedStatement	getLogPrepareStatement(DbSession session, Timestamp start, Timestamp stop)
int	getMode()
String	getOriginalFilename()
long	getOriginalSize()
protected String	getPrimaryField() UnsupportedOperationException
protected String	getPrimaryKey() UnsupportedOperationException
int	getRank()
RequestPacket	getRequest()
String	getRequested()
static String	getRequested(R66Session session, RequestPacket requestPacket)
String	getRequester()
static String	getRequester(R66Session session, RequestPacket requestPacket)
static long	getResultCountPrepareStatement(DbPreparedStatement pstt)
static long	getResultCountPrepareStatement(DbPreparedStatement pstt, AbstractDbData.UpdatedInfo info, long time)
static long	getResultCountPrepareStatement(DbPreparedStatement pstt, ErrorCode error, long time)
DbRule	getRule()
String	getRuleId()
static DbTaskRunner[]	getSelectFromInfoPrepareStatement(AbstractDbData.UpdatedInfo info, boolean orderByStart, int limit)
static boolean	getSenderByRequestPacket(RequestPacket request) Helper
long	getSpecialId()
Timestamp	getStart()
ErrorCode	getStatus()
int	getStep()
Timestamp	getStop()
protected String	getTable()
AbstractTask	getTask(String[] task, R66Session tempSession)
String	getTransferInfo()
Map<String,Object>	getTransferMap()
AbstractDbData.UpdatedInfo	getUpdatedInfo()
static String	hashStatus()
static String	headerHtml()
void	incrementRank() Increment the rank of the transfer
protected void	initObject() To setup primaryKey, otherFields, allFields.
boolean	isAllDone()
boolean	isFileMoved()
boolean	isFinished()
boolean	isInError()
boolean	isInTransfer()
boolean	isPreTaskStarting() To be called before executing Pre execution
boolean	isRecvThrough()
boolean	isRescheduledTransfer()
boolean	isSelfRequest()
boolean	isSelfRequested()
boolean	isSender()
boolean	isSendThrough()
static void	loadXml(File logsFile) Method to load several DbTaskRunner from File logs.
void	loadXmlWorkNoDb() Method to load a previous existing DbTaskRunner for NoDb client from File instead of from DB.
protected void	optimizedUpdate() Update Runner using special PreparedStatement
static int	purgeLogPrepareStatement(DbSession session, String startid, String stopid, Timestamp start, Timestamp stop, String rule, String req, boolean pending, boolean transfer, boolean error, boolean done, boolean all)
static int	purgeLogPrepareStatement(DbSession session, Timestamp start, Timestamp stop) purge in same interval all runners with globallaststep as ALLDONETASK or UpdatedInfo as Done
boolean	ready()
static void	removeNoDbSpecialId(long specialId) To allow to remove specifically one SpecialId from MemoryHashmap
boolean	reset() Reset the runner (ready to be run again)
static void	resetToSubmit(DbSession session) Change RUNNING, INTERRUPTED to TOSUBMIT TaskRunner from database.
boolean	restart(boolean submit) Make this Runner ready for restart
void	restartRank() Decrease if necessary the rank
void	run() Run all task from current status (globalstep and step)
void	saveStatus() This method is to be called each time an operation is happening on Runner
void	select() Select object from table
void	setAllDone() Set the global step as finished (after post task in success)
void	setBlocksize(int blocksize)
void	setErrorExecutionStatus(ErrorCode code) Set the ErrorCode for the InfoStatus
void	setErrorTask() Set the Error Task step
void	setExecutionStatus(ErrorCode status) Change the status from Task Execution
void	setFileInformation(String newFileInformation) Set a new File information for this transfer
void	setFileMoved(String newFilename, boolean isFileMoved)
void	setFilename(String filename)
void	setFrom(DbTaskRunner runner) Partial set from another runner (infostatus, rank, status, step, stop, filename, globallastep, globalstep, isFileMoved)
void	setFromJson(com.fasterxml.jackson.databind.node.ObjectNode source, 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)
void	setInitialTask() Set the Initial Task step (before Pre task)
void	setLocalChannelReference(LocalChannelReference localChannelReference) Set a localChannelReference
void	setOriginalFilename(String originalFilename)
void	setOriginalSize(long originalSize)
void	setPostTask() Set the Post Task step
void	setPreTask() Set Pre Task step
void	setRankAtStartup(int rank) To set the rank at startup of the request if the request specify a specific rank
void	setRescheduledTransfer() Set this DbTaskRunner as rescheduled (valid only while still in memory)
void	setSender(boolean sender) Utility for "self request" mode only
void	setSenderByRequestToValidate(boolean requestToValidate) Utility for "self request"
void	setStart(Timestamp start)
void	setStop(Timestamp stop)
void	setTransferMap(Map<String,Object> map)
void	setTransferTask(int rank) Set Transfer rank
boolean	shallIgnoreSave()
boolean	specialSubmit() Special method used to force insert in case of SelfSubmit
boolean	stopOrCancelRunner(ErrorCode code) Stop or Cancel a Runner from database point of view
String	toHtml(R66Session session, String running)
String	toLogRunStep()
String	toShortNoHtmlString(String newline)
String	toShortString()
String	toSpecializedHtml(R66Session session, String body, String running)
String	toString()
void	update() Update object to table
static void	updateLruCacheTimeout(long ttl) To update the TTL for the cache (to 10xTIMEOUT)
static void	updateUsed(long specialId) To update the usage TTL of the associated object
static NbAndSpecialId	writeXML(DbPreparedStatement preparedStatement, org.dom4j.io.XMLWriter xmlWriter) Write the selected TaskRunners from PrepareStatement to a XMLWriter
void	writeXmlWorkNoDb() Method to write the current DbTaskRunner for NoDb client instead of updating DB.
static NbAndSpecialId	writeXMLWriter(DbPreparedStatement preparedStatement, String filename) Write selected TaskRunners to an XML file using an XMLWriter
static void	writeXMLWriter(String filename) Write all TaskRunners to an XML file using an XMLWriter

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

asJson, delete, getInsertAllValues, getSelectAllFields, getUpdateAllFields, getValues, getWherePrimaryKey, insert, setFromArray, setPrimaryKey, setToArray, toJson

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

get, getAllFields, getTrueValue, getValue, setTrueValue, setValue, setValues

Methods inherited from class java.lang.Object

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

Field Detail

JSON_ORIGINALSIZE

public static final String JSON_ORIGINALSIZE

See Also:

Constant Field Values

JSON_THROUGHMODE

public static final String JSON_THROUGHMODE

See Also:

Constant Field Values

JSON_RESCHEDULE

public static final String JSON_RESCHEDULE

See Also:

Constant Field Values

dbTypes

public static final int[] dbTypes

table

public static final String table

See Also:

Constant Field Values

fieldseq

public static final String fieldseq

See Also:

Constant Field Values

indexes

public static final DbTaskRunner.Columns[] indexes

XMLRUNNERS

public static final String XMLRUNNERS

See Also:

Constant Field Values

XMLRUNNER

public static final String XMLRUNNER

See Also:

Constant Field Values

XMLEXTENSION

public static final String XMLEXTENSION

See Also:

Constant Field Values

NBPRKEY

public static final int NBPRKEY

Special For DbTaskRunner

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

DbTaskRunner

public DbTaskRunner(Transfer transfer)

DbTaskRunner

public DbTaskRunner(DbRule rule,
                    boolean isSender,
                    RequestPacket requestPacket,
                    String requested,
                    Timestamp startTime)
             throws WaarpDatabaseException

Constructor for submission (no transfer session), from database. It is created, so with a new specialId if necessary

Parameters:

rule -

isSender -

requestPacket -

requested -

startTime -

Throws:

WaarpDatabaseException

DbTaskRunner

public DbTaskRunner(R66Session session,
                    DbRule rule,
                    boolean isSender,
                    RequestPacket requestPacket)
             throws WaarpDatabaseException

Constructor from a request without a valid Special Id to be inserted into databases

Parameters:

session -

rule -

isSender -

requestPacket -

Throws:

WaarpDatabaseException

DbTaskRunner

public DbTaskRunner(R66Session session,
                    DbRule rule,
                    long id,
                    String requester,
                    String requested)
             throws WaarpDatabaseException

Constructor from a request with a valid Special Id so loaded from database

Parameters:

session -

rule -

id -

requester -

requested -

Throws:

WaarpDatabaseException

DbTaskRunner

public DbTaskRunner(long id,
                    String requester,
                    String requested)
             throws WaarpDatabaseException

Minimal constructor from database

Parameters:

id -

requester -

requested -

Throws:

WaarpDatabaseException

DbTaskRunner

public DbTaskRunner(long id,
                    String requester,
                    String requested,
                    String owner)
             throws WaarpDatabaseException

Minimal constructor from database

Parameters:

id -

requester -

requested -

Throws:

WaarpDatabaseException

DbTaskRunner

public DbTaskRunner(com.fasterxml.jackson.databind.node.ObjectNode source)
             throws WaarpDatabaseException

To create a new DbTaskRunner (specialId could be invalid) without making any entry in the database

Parameters:

source -

Throws:

WaarpDatabaseException

DbTaskRunner

public DbTaskRunner(long id,
                    String requested)
             throws WaarpDatabaseException

Constructor to initiate a request with a valid previous Special Id so loaded from database.

This object cannot be used except to retrieve information.

Parameters:

id -

requested -

Throws:

WaarpDatabaseException

Method Detail

createLruCache

public static void createLruCache(int limit,
                                  long ttl)

Create the LRU cache

Parameters:

limit - limit of number of entries in the cache

ttl - time to leave used

hashStatus

public static String hashStatus()

clearCache

public static int clearCache()

To enable clear of oldest entries in the cache

Returns:

the number of elements removed

updateLruCacheTimeout

public static void updateLruCacheTimeout(long ttl)

To update the TTL for the cache (to 10xTIMEOUT)

Parameters:

ttl -

initObject

protected 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<Transfer>

getTable

protected String getTable()

Specified by:

getTable in class AbstractDbDataDao<Transfer>

getDao

protected AbstractDAO<Transfer> getDao()
                                throws DAOConnectionException

Specified by:

getDao in class AbstractDbDataDao<Transfer>

Throws:

DAOConnectionException

getPrimaryKey

protected String getPrimaryKey()

UnsupportedOperationException

Specified by:

getPrimaryKey in class AbstractDbDataDao<Transfer>

Returns:

never

getPrimaryField

protected String getPrimaryField()

UnsupportedOperationException

Specified by:

getPrimaryField in class AbstractDbDataDao<Transfer>

Returns:

never

getRequested

public static String getRequested(R66Session session,
                                  RequestPacket requestPacket)

Parameters:

session -

requestPacket -

Returns:

The associated requested Host Id

getRequester

public static String getRequester(R66Session session,
                                  RequestPacket requestPacket)

Parameters:

session -

requestPacket -

Returns:

The associated requester Host Id

checkThroughMode

public void checkThroughMode()

setFromJson

public void setFromJson(com.fasterxml.jackson.databind.node.ObjectNode source,
                        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<Transfer>

ignorePrimaryKey - True will ignore primaryKey from Json

Throws:

WaarpDatabaseSqlException

removeNoDbSpecialId

public static final void removeNoDbSpecialId(long specialId)

To allow to remove specifically one SpecialId from MemoryHashmap

Parameters:

specialId -

updateUsed

public static final void updateUsed(long specialId)

To update the usage TTL of the associated object

Parameters:

specialId -

create

public void create()
            throws WaarpDatabaseException

As insert but with the ability to change the SpecialId

Throws:

WaarpDatabaseException

exist

public boolean exist()
              throws WaarpDatabaseException

Description copied from class: AbstractDbDataDao

Test the existence of the current object

Overrides:

exist in class AbstractDbDataDao<Transfer>

Returns:

True if the object exists

Throws:

WaarpDatabaseException

checkFromDbForSubmit

public boolean checkFromDbForSubmit()
                             throws WaarpDatabaseException

Shall be called to ensure that item is really available in database

Returns:

True iff the element exists in a database (and reloaded then from Database)

Throws:

WaarpDatabaseException

select

public void select()
            throws WaarpDatabaseException

Description copied from class: AbstractDbDataDao

Select object from table

Overrides:

select in class AbstractDbDataDao<Transfer>

Throws:

WaarpDatabaseException

update

public void update()
            throws WaarpDatabaseException

Description copied from class: AbstractDbDataDao

Update object to table

Overrides:

update in class AbstractDbDataDao<Transfer>

Throws:

WaarpDatabaseException

optimizedUpdate

protected void optimizedUpdate()
                        throws WaarpDatabaseException

Update Runner using special PreparedStatement

Throws:

WaarpDatabaseException

clean

public void clean()

specialSubmit

public boolean specialSubmit()
                      throws WaarpDatabaseException

Special method used to force insert in case of SelfSubmit

Throws:

WaarpDatabaseException

setFrom

public void setFrom(DbTaskRunner runner)

Partial set from another runner (infostatus, rank, status, step, stop, filename, globallastep, globalstep, isFileMoved)

Parameters:

runner -

isRecvThrough

public boolean isRecvThrough()

isSendThrough

public boolean isSendThrough()

setLocalChannelReference

public void setLocalChannelReference(LocalChannelReference localChannelReference)

Set a localChannelReference

Parameters:

localChannelReference -

getLocalChannelReference

public LocalChannelReference getLocalChannelReference()

Returns:

the localChannelReference

getFromStatement

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

For instance from Commander when getting updated information

Parameters:

preparedStatement -

Returns:

the next updated DbTaskRunner

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getFromStatementNoRule

public static DbTaskRunner getFromStatementNoRule(DbPreparedStatement preparedStatement)
                                           throws WaarpDatabaseNoConnectionException,
                                                  WaarpDatabaseSqlException

For instance from Commander when getting updated information

This version tries to load DbRule but will not make any error if not found!

Parameters:

preparedStatement -

Returns:

the next updated DbTaskRunner

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getFromStatementNoDbRule

public static DbTaskRunner getFromStatementNoDbRule(DbPreparedStatement preparedStatement)
                                             throws WaarpDatabaseNoConnectionException,
                                                    WaarpDatabaseSqlException

For REST interface, to prevent DbRule issue

Parameters:

preparedStatement -

Returns:

the next updated DbTaskRunner

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getFilterPrepareStatement

public static DbPreparedStatement getFilterPrepareStatement(DbSession session,
                                                            int limit,
                                                            boolean orderBySpecialId,
                                                            String startid,
                                                            String stopid,
                                                            Timestamp start,
                                                            Timestamp stop,
                                                            String rule,
                                                            String req,
                                                            boolean pending,
                                                            boolean transfer,
                                                            boolean error,
                                                            boolean done,
                                                            boolean all)
                                                     throws WaarpDatabaseNoConnectionException,
                                                            WaarpDatabaseSqlException

Parameters:

session -

limit -

orderBySpecialId -

startid -

stopid -

start -

stop -

rule -

req -

pending -

transfer -

error -

done -

all -

Returns:

the DbPreparedStatement according to the filter

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getFilterPrepareStatement

public static DbPreparedStatement getFilterPrepareStatement(DbSession session,
                                                            int limit,
                                                            boolean orderBySpecialId,
                                                            String startid,
                                                            String stopid,
                                                            Timestamp start,
                                                            Timestamp stop,
                                                            String rule,
                                                            String req,
                                                            boolean pending,
                                                            boolean transfer,
                                                            boolean error,
                                                            boolean done,
                                                            boolean all,
                                                            String owner)
                                                     throws WaarpDatabaseNoConnectionException,
                                                            WaarpDatabaseSqlException

Parameters:

session -

limit -

orderBySpecialId -

startid -

stopid -

start -

stop -

rule -

req -

pending -

transfer -

error -

done -

all -

owner -

Returns:

the DbPreparedStatement according to the filter

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getSelectFromInfoPrepareStatement

public static DbTaskRunner[] getSelectFromInfoPrepareStatement(AbstractDbData.UpdatedInfo info,
                                                               boolean orderByStart,
                                                               int limit)
                                                        throws WaarpDatabaseNoConnectionException,
                                                               WaarpDatabaseSqlException

Parameters:

info -

orderByStart - If true, sort on Start ; If false, does not set the limit on start

limit -

Returns:

the DbPreparedStatement for getting Updated Object

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getCountInfoPrepareStatement

public static DbPreparedStatement getCountInfoPrepareStatement(DbSession session)
                                                        throws WaarpDatabaseNoConnectionException,
                                                               WaarpDatabaseSqlException

Parameters:

session -

Returns:

the DbPreparedStatement for getting Updated Object

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getResultCountPrepareStatement

public static long getResultCountPrepareStatement(DbPreparedStatement pstt,
                                                  AbstractDbData.UpdatedInfo info,
                                                  long time)

Parameters:

pstt -

info -

time -

Returns:

the number of elements (COUNT) from the statement

getCountStepPrepareStatement

public static DbPreparedStatement getCountStepPrepareStatement(DbSession session,
                                                               DbTaskRunner.TASKSTEP globalstep)
                                                        throws WaarpDatabaseNoConnectionException,
                                                               WaarpDatabaseSqlException

Parameters:

session -

globalstep -

Returns:

the DbPreparedStatement for getting Runner according to globalstep ordered by start

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getCountStatusPrepareStatement

public static DbPreparedStatement getCountStatusPrepareStatement(DbSession session)
                                                          throws WaarpDatabaseNoConnectionException,
                                                                 WaarpDatabaseSqlException

Parameters:

session -

Returns:

the DbPreparedStatement for getting Runner according to status ordered by start

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getResultCountPrepareStatement

public static long getResultCountPrepareStatement(DbPreparedStatement pstt,
                                                  ErrorCode error,
                                                  long time)

Parameters:

pstt -

error -

time -

Returns:

the number of elements (COUNT) from the statement

getCountStatusRunningPrepareStatement

public static DbPreparedStatement getCountStatusRunningPrepareStatement(DbSession session,
                                                                        ErrorCode status)
                                                                 throws WaarpDatabaseNoConnectionException,
                                                                        WaarpDatabaseSqlException

Only running transfers

Parameters:

session -

status -

Returns:

the DbPreparedStatement for getting Runner according to status ordered by start

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getCountInOutErrorPrepareStatement

public static DbPreparedStatement getCountInOutErrorPrepareStatement(DbSession session,
                                                                     boolean in)
                                                              throws WaarpDatabaseNoConnectionException,
                                                                     WaarpDatabaseSqlException

Running or not transfers are concerned

Parameters:

session -

in - True for Incoming, False for Outgoing

Returns:

the DbPreparedStatement for getting Runner according to in or out going way and Error

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getCountInOutRunningPrepareStatement

public static DbPreparedStatement getCountInOutRunningPrepareStatement(DbSession session,
                                                                       boolean in,
                                                                       boolean running)
                                                                throws WaarpDatabaseNoConnectionException,
                                                                       WaarpDatabaseSqlException

Running or not transfers are concerned

Parameters:

session -

in - True for Incoming, False for Outgoing

running - True for Running only, False for all

Returns:

the DbPreparedStatement for getting Runner according to in or out going way

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getResultCountPrepareStatement

public static long getResultCountPrepareStatement(DbPreparedStatement pstt)

Parameters:

pstt -

Returns:

the number of elements (COUNT) from the statement

finishSelectOrCountPrepareStatement

public static void finishSelectOrCountPrepareStatement(DbPreparedStatement pstt,
                                                       long time)
                                                throws WaarpDatabaseNoConnectionException,
                                                       WaarpDatabaseSqlException

Set the current time in the given updatedPreparedStatement

Parameters:

pstt -

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getLogPrepareStatement

public static DbPreparedStatement getLogPrepareStatement(DbSession session,
                                                         Timestamp start,
                                                         Timestamp stop)
                                                  throws WaarpDatabaseNoConnectionException,
                                                         WaarpDatabaseSqlException

Parameters:

session -

start -

stop -

Returns:

the DbPreparedStatement for getting Selected Object, whatever their status

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

purgeLogPrepareStatement

public static int purgeLogPrepareStatement(DbSession session,
                                           Timestamp start,
                                           Timestamp stop)
                                    throws WaarpDatabaseNoConnectionException,
                                           WaarpDatabaseSqlException

purge in same interval all runners with globallaststep as ALLDONETASK or UpdatedInfo as Done

Parameters:

session -

start -

stop -

Returns:

the number of log purged

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

purgeLogPrepareStatement

public static int purgeLogPrepareStatement(DbSession session,
                                           String startid,
                                           String stopid,
                                           Timestamp start,
                                           Timestamp stop,
                                           String rule,
                                           String req,
                                           boolean pending,
                                           boolean transfer,
                                           boolean error,
                                           boolean done,
                                           boolean all)
                                    throws WaarpDatabaseNoConnectionException,
                                           WaarpDatabaseSqlException

Parameters:

session -

startid -

stopid -

start -

stop -

rule -

req -

pending -

transfer -

error -

done -

all -

Returns:

the DbPreparedStatement according to the filter and ALLDONE, ERROR globallaststep

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

resetToSubmit

public static void resetToSubmit(DbSession session)
                          throws WaarpDatabaseNoConnectionException

Change RUNNING, INTERRUPTED to TOSUBMIT TaskRunner from database. This method is to be used when the commander is starting the very first time, in order to be ready to rerun tasks that are pending.

Parameters:

session -

Throws:

WaarpDatabaseNoConnectionException

changeFinishedToDone

public static void changeFinishedToDone()
                                 throws WaarpDatabaseNoConnectionException

Change CompleteOk+ALLDONETASK to Updated = DONE TaskRunner from database. This method is a clean function to be used for instance before log export or at the very beginning of the commander.

Throws:

WaarpDatabaseNoConnectionException

reset

public boolean reset()

Reset the runner (ready to be run again)

Returns:

True if OK, False if already finished

restartRank

public void restartRank()

Decrease if necessary the rank

restart

public boolean restart(boolean submit)

Make this Runner ready for restart

Parameters:

submit - True to resubmit this task, else False to keep it as running (only reset)

Returns:

True if OK or False if Already finished or if submitted and the request is a selfRequested and is not ready to restart locally

stopOrCancelRunner

public boolean stopOrCancelRunner(ErrorCode code)

Stop or Cancel a Runner from database point of view

Parameters:

code -

Returns:

True if correctly stopped or canceled

changeUpdatedInfo

public void changeUpdatedInfo(AbstractDbData.UpdatedInfo info)

Description copied from class: AbstractDbDataDao

Change UpdatedInfo status

Specified by:

changeUpdatedInfo in class AbstractDbDataDao<Transfer>

setErrorExecutionStatus

public void setErrorExecutionStatus(ErrorCode code)

Set the ErrorCode for the InfoStatus

Parameters:

code -

getUpdatedInfo

public AbstractDbData.UpdatedInfo getUpdatedInfo()

Returns:

The current UpdatedInfo value

getErrorInfo

public ErrorCode getErrorInfo()

Returns:

the error code associated with the Updated Info

getStep

public int getStep()

Returns:

the step

isRescheduledTransfer

public boolean isRescheduledTransfer()

Returns:

the rescheduledTransfer

setRescheduledTransfer

public void setRescheduledTransfer()

Set this DbTaskRunner as rescheduled (valid only while still in memory)

setRankAtStartup

public void setRankAtStartup(int rank)

To set the rank at startup of the request if the request specify a specific rank

Parameters:

rank - the rank to set

setBlocksize

public void setBlocksize(int blocksize)

Parameters:

blocksize - the block size to set

setFilename

public void setFilename(String filename)

Parameters:

filename - the filename to set

setFileMoved

public void setFileMoved(String newFilename,
                         boolean isFileMoved)

Parameters:

newFilename - the new Filename to set

isFileMoved - the isFileMoved to set

setOriginalFilename

public void setOriginalFilename(String originalFilename)

Parameters:

originalFilename - the originalFilename to set

getRank

public int getRank()

Returns:

the rank

setExecutionStatus

public void setExecutionStatus(ErrorCode status)

Change the status from Task Execution

Parameters:

status -

getStatus

public ErrorCode getStatus()

Returns:

the status

isSender

public boolean isSender()

Returns:

the isSender

isFileMoved

public boolean isFileMoved()

Returns:

the isFileMoved

getBlocksize

public int getBlocksize()

Returns:

the blocksize

getFilename

public String getFilename()

Returns:

the filename

getOriginalFilename

public String getOriginalFilename()

Returns:

the originalFilename

getFileInformation

public String getFileInformation()

Returns:

the fileInformation

getTransferMap

public Map<String,Object> getTransferMap()

Returns:

the Map for the content of the transferInformation

setTransferMap

public void setTransferMap(Map<String,Object> map)

Parameters:

map - the Map to set as XML string to transferInformation

addToTransferMap

public void addToTransferMap(String key,
                             Object value)

Helper to set a new (key, value) in the map Transfer

Parameters:

key -

value -

getFromTransferMap

public Object getFromTransferMap(String key)

Parameters:

key -

Returns:

the associated value or null if it does not exist

setFileInformation

public void setFileInformation(String newFileInformation)

Set a new File information for this transfer

Parameters:

newFileInformation -

getTransferInfo

public String getTransferInfo()

getSpecialId

public long getSpecialId()

Returns:

the specialId

getRule

public DbRule getRule()

Returns:

the rule

getRuleId

public String getRuleId()

Returns:

the ruleId

getMode

public int getMode()

Returns:

the mode

getGlobalStep

public DbTaskRunner.TASKSTEP getGlobalStep()

Returns:

the globalstep

getLastGlobalStep

public DbTaskRunner.TASKSTEP getLastGlobalStep()

Returns:

the globalstep

getGloballaststep

public int getGloballaststep()

Returns:

the globallaststep

ready

public boolean ready()

Returns:

True if this runner is ready for transfer or post operation

isInTransfer

public boolean isInTransfer()

Returns:

True if the runner is currently in transfer

isFinished

public boolean isFinished()

Returns:

True if this runner is finished, either in success or in error

isInError

public boolean isInError()

Returns:

True if this runner is in error and no more running

isAllDone

public boolean isAllDone()

Returns:

True if the runner is finished in success

isPreTaskStarting

public boolean isPreTaskStarting()

To be called before executing Pre execution

Returns:

True if the task is going to run PRE task from the first action

setInitialTask

public void setInitialTask()

Set the Initial Task step (before Pre task)

setPreTask

public void setPreTask()

Set Pre Task step

setTransferTask

public void setTransferTask(int rank)

Set Transfer rank

Parameters:

rank -

setPostTask

public void setPostTask()

Set the Post Task step

setErrorTask

public void setErrorTask()

Set the Error Task step

setAllDone

public void setAllDone()

Set the global step as finished (after post task in success)

finishTransferTask

public int finishTransferTask(ErrorCode code)

Set the status of the transfer

Parameters:

code - TransferOk if success

Returns:

the current rank of transfer

continueTransfer

public boolean continueTransfer()

Returns:

True if the transfer is valid to continue

getTask

public final AbstractTask getTask(String[] task,
                                  R66Session tempSession)
                           throws OpenR66RunnerErrorException

Parameters:

task -

tempSession -

Returns:

the corresponding AbstractTask

Throws:

OpenR66RunnerErrorException

run

public void run()
         throws OpenR66RunnerErrorException

Run all task from current status (globalstep and step)

Throws:

OpenR66RunnerErrorException

finalizeTransfer

public void finalizeTransfer(LocalChannelReference localChannelReference,
                             R66File file,
                             R66Result finalValue,
                             boolean status)
                      throws OpenR66RunnerErrorException,
                             OpenR66ProtocolSystemException

Once the transfer is over, finalize the Runner by running the error or post operation according to the status.

Parameters:

localChannelReference -

file -

finalValue -

status -

Throws:

OpenR66RunnerErrorException

OpenR66ProtocolSystemException

incrementRank

public void incrementRank()

Increment the rank of the transfer

saveStatus

public void saveStatus()
                throws OpenR66RunnerErrorException

This method is to be called each time an operation is happening on Runner

Throws:

OpenR66RunnerErrorException

forceSaveStatus

public boolean forceSaveStatus()

This method is to be called each time an operation is happening on Runner and it is forced (for SelfRequest handling)

Returns:

True if saved

Throws:

OpenR66RunnerErrorException

clear

public void clear()

Clear the runner

deleteTempFile

public void deleteTempFile()

Delete the temporary empty file (retrieved file at rank 0)

toString

public String toString()

Overrides:

toString in class Object

toLogRunStep

public String toLogRunStep()

toShortNoHtmlString

public String toShortNoHtmlString(String newline)

toShortString

public String toShortString()

headerHtml

public static String headerHtml()

Returns:

the header for a table of runners in Html format

freespaceMB

public long freespaceMB(R66Session session)

Parameters:

session -

Returns:

The associated freespace of the current directory (in MB)

freespace

public long freespace(R66Session session,
                      boolean isWorkingPath)

Parameters:

session -

isWorkingPath -

Returns:

The associated freespace of the directory (Working if True, Recv if False) (in B, not MB)

toHtml

public String toHtml(R66Session session,
                     String running)

Parameters:

session -

running - special info

Returns:

the runner in Html format compatible with the header from headerHtml method

toSpecializedHtml

public String toSpecializedHtml(R66Session session,
                                String body,
                                String running)

Parameters:

session -

body -

running - special info

Returns:

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

isSelfRequested

public boolean isSelfRequested()

Returns:

True if the current host is the requested host (to prevent request to itself)

shallIgnoreSave

public boolean shallIgnoreSave()

Returns:

True if this is a self request and current action is on Requested

isSelfRequest

public boolean isSelfRequest()

Returns:

True if the request is a self request (same host on both side)

getRequested

public String getRequested()

Returns:

the requested HostId

getRequester

public String getRequester()

Returns:

the requester HostId

getStart

public Timestamp getStart()

Returns:

the start

setStart

public void setStart(Timestamp start)

Parameters:

start - new Start time to apply when reschedule

getStop

public Timestamp getStop()

Returns:

the stop

setStop

public void setStop(Timestamp stop)

getRequest

public RequestPacket getRequest()

Returns:

the associated request

getKey

public String getKey()

Used internally

Returns:

a Key representing the primary key as a unique string

writeXML

public static NbAndSpecialId writeXML(DbPreparedStatement preparedStatement,
                                      org.dom4j.io.XMLWriter xmlWriter)
                               throws WaarpDatabaseNoConnectionException,
                                      WaarpDatabaseSqlException,
                                      OpenR66ProtocolBusinessException

Write the selected TaskRunners from PrepareStatement to a XMLWriter

Parameters:

preparedStatement - ready to be executed

xmlWriter -

Returns:

the NbAndSpecialId for the number of transfer and higher rank found

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

OpenR66ProtocolBusinessException

getJson

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

Write selected TaskRunners to a Json String

Parameters:

preparedStatement -

Returns:

the associated Json String

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

OpenR66ProtocolBusinessException

writeXMLWriter

public static NbAndSpecialId writeXMLWriter(DbPreparedStatement preparedStatement,
                                            String filename)
                                     throws WaarpDatabaseNoConnectionException,
                                            WaarpDatabaseSqlException,
                                            OpenR66ProtocolBusinessException

Write selected TaskRunners to an XML file using an XMLWriter

Parameters:

preparedStatement -

filename -

Returns:

the NbAndSpecialId for the number of transfer and higher rank found

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

OpenR66ProtocolBusinessException

writeXMLWriter

public static void writeXMLWriter(String filename)
                           throws WaarpDatabaseNoConnectionException,
                                  WaarpDatabaseSqlException,
                                  OpenR66ProtocolBusinessException

Write all TaskRunners to an XML file using an XMLWriter

Parameters:

filename -

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

OpenR66ProtocolBusinessException

backendXmlFilename

public String backendXmlFilename()

Returns:

the backend XML filename for the current TaskRunner in NoDb Client mode

asXML

public String asXML()
             throws OpenR66ProtocolBusinessException

Returns:

the runner as XML

Throws:

OpenR66ProtocolBusinessException

getJson

public com.fasterxml.jackson.databind.node.ObjectNode getJson()

Description copied from class: AbstractDbDataDao

Create the equivalent object in Json (no database access)

Overrides:

getJson in class AbstractDbDataDao<Transfer>

Returns:

The ObjectNode Json equivalent

setFromJson

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

Specified by:

setFromJson in class AbstractDbDataDao<Transfer>

getJsonAsString

public String getJsonAsString()

Returns:

the Json string for this

fromStringXml

public static DbTaskRunner fromStringXml(String xml,
                                         boolean reverse)
                                  throws OpenR66ProtocolBusinessException

Reload a to submitted runner from a remote partner's log (so reversing isSender should be true)

Parameters:

xml -

reverse -

Returns:

the TaskRunner from the XML source element

Throws:

OpenR66ProtocolBusinessException

writeXmlWorkNoDb

public void writeXmlWorkNoDb()
                      throws OpenR66ProtocolBusinessException

Method to write the current DbTaskRunner for NoDb client instead of updating DB. 'setToArray' must be called priorly to be able to store the values.

Throws:

OpenR66ProtocolBusinessException

loadXmlWorkNoDb

public void loadXmlWorkNoDb()
                     throws OpenR66ProtocolBusinessException

Method to load a previous existing DbTaskRunner for NoDb client from File instead of from DB. 'setFromArray' must be called after.

Throws:

OpenR66ProtocolBusinessException

loadXml

public static void loadXml(File logsFile)
                    throws OpenR66ProtocolBusinessException

Method to load several DbTaskRunner from File logs.

Parameters:

logsFile - File containing logs from export function

Throws:

OpenR66ProtocolBusinessException

existXmlWorkNoDb

public boolean existXmlWorkNoDb()

Returns:

True if the backend XML for NoDb client is available for this TaskRunner

deleteXmlWorkNoDb

public void deleteXmlWorkNoDb()

Delete the backend XML file for the current TaskRunner for NoDb Client

setSender

public void setSender(boolean sender)

Utility for "self request" mode only

Parameters:

sender -

getSenderByRequestPacket

public static boolean getSenderByRequestPacket(RequestPacket request)

Helper

Parameters:

request -

Returns:

isSender according to request

setSenderByRequestToValidate

public void setSenderByRequestToValidate(boolean requestToValidate)

Utility for "self request"

Parameters:

requestToValidate -

getOriginalSize

public long getOriginalSize()

Returns:

the originalSize

setOriginalSize

public void setOriginalSize(long originalSize)

Parameters:

originalSize - the originalSize to set

getFullFilePath

public String getFullFilePath()
                       throws CommandAbstractException

Returns:

the full path for the current file

Throws:

CommandAbstractException