org.waarp.gateway.ftp.database.data

Class DbTransferLog

java.lang.Object

org.waarp.common.database.data.AbstractDbData

org.waarp.gateway.ftp.database.data.DbTransferLog

public class DbTransferLog
extends AbstractDbData

Transfer Log for FtpExec

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DbTransferLog.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 String	fieldseq
static DbTransferLog.Columns[]	indexes
protected static String	insertAllValues
static int	NBPRKEY Special For DbTransferLog
protected static String	selectAllFields
static String	table
protected static String	updateAllFields
static String	XMLRUNNER
static String	XMLRUNNERS

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

allFields, dbSession, isSaved, JSON_MODEL, otherFields, primaryKey

Constructor Summary

Constructors

Constructor and Description
DbTransferLog(DbSession dbSession, String user, String account, long specialId) Load from database
DbTransferLog(DbSession dbSession, String user, String account, long specialId, boolean isSender, String filename, String mode, ReplyCode infostatus, String info, AbstractDbData.UpdatedInfo updatedInfo) Insert into database

Method Summary

Modifier and Type	Method and Description
void	changeUpdatedInfo(AbstractDbData.UpdatedInfo info) Change UpdatedInfo status
void	clear() Clear the runner
void	create() As insert but with the ability to change the SpecialId
void	delete() Delete object from table
static void	finishSelectOrCountPrepareStatement(DbPreparedStatement pstt) Set the current time in the given updatedPreparedStatement
static void	finishSelectOrCountPrepareStatement(DbPreparedStatement pstt, long time) Set the current time in the given updatedPreparedStatement
String	getAccount()
static DbPreparedStatement	getCountAllPrepareStatement(DbSession session)
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)
ReplyCode	getErrorInfo()
String	getFilename()
static DbTransferLog	getFromStatement(DbPreparedStatement preparedStatement) For instance when getting updated information
String	getInfotransf()
protected String	getInsertAllValues()
static DbPreparedStatement	getLogPrepareStament(DbSession session, Timestamp start, Timestamp stop)
static DbPreparedStatement	getLogPrepareStament(DbSession session, Timestamp start, Timestamp stop, ReplyCode status)
String	getMode()
static long	getResultCountPrepareStatement(DbPreparedStatement pstt)
static long	getResultCountPrepareStatement(DbPreparedStatement pstt, AbstractDbData.UpdatedInfo info, long time)
static long	getResultCountPrepareStatement(DbPreparedStatement pstt, ReplyCode error, long time)
protected String	getSelectAllFields()
long	getSpecialId()
Timestamp	getStart()
static DbPreparedStatement	getStatusPrepareStament(DbSession session, ReplyCode status, int limit)
Timestamp	getStop()
protected String	getTable()
protected String	getUpdateAllFields()
AbstractDbData.UpdatedInfo	getUpdatedInfo()
String	getUser()
protected String	getWherePrimaryKey()
protected void	initObject() To setup primaryKey, otherFields, allFields.
void	insert() Insert object into table
boolean	isSender()
String	saveDbTransferLog(String filename) Save the current DbTransferLog to a file
static String	saveDbTransferLogFile(DbPreparedStatement preparedStatement, String filename) Exports DbTransferLogs to a file and purges the corresponding DbTransferLogs
static String	saveDbTransferLogFile(DbPreparedStatement preparedStatement, Writer outWriter, boolean purge) Exports DbTransferLogs to a Writer object and optionally purges the corresponding DbTransferLogs
void	saveStatus() This method is to be called each time an operation is happening on Runner
void	setFilename(String filename)
protected void	setFromArray() Internal function to retrieve data from Array to pull data from database
void	setInfotransf(String infotransf)
protected void	setPrimaryKey() Set the primary Key as current value
void	setReplyCodeExecutionStatus(ReplyCode code) Set the ReplyCode for the UpdatedInfo
void	setStop(Timestamp stop)
protected void	setToArray() Internal function to set to Array used to push data to database
String	toString()

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

asJson, exist, getAllFields, getJson, getTrueValue, getValues, select, setFromJson, setTrueValue, setValues, update, validateLength, validateLength

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

fieldseq

public static final String fieldseq

See Also:

Constant Field Values

indexes

public static final DbTransferLog.Columns[] indexes

XMLRUNNERS

public static final String XMLRUNNERS

See Also:

Constant Field Values

XMLRUNNER

public static final String XMLRUNNER

See Also:

Constant Field Values

NBPRKEY

public static final int NBPRKEY

Special For DbTransferLog

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

DbTransferLog

public DbTransferLog(DbSession dbSession,
                     String user,
                     String account,
                     long specialId,
                     boolean isSender,
                     String filename,
                     String mode,
                     ReplyCode infostatus,
                     String info,
                     AbstractDbData.UpdatedInfo updatedInfo)
              throws WaarpDatabaseException

Insert into database

Parameters:

dbSession -

user -

account -

specialId -

isSender -

filename -

mode -

infostatus -

info -

updatedInfo -

Throws:

WaarpDatabaseException

DbTransferLog

public DbTransferLog(DbSession dbSession,
                     String user,
                     String account,
                     long specialId)
              throws WaarpDatabaseException

Load from database

Parameters:

dbSession -

user -

account -

specialId -

Throws:

WaarpDatabaseException

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.

Specified by:

initObject in class AbstractDbData

getSelectAllFields

protected final String getSelectAllFields()

Specified by:

getSelectAllFields in class AbstractDbData

getTable

protected final String getTable()

Specified by:

getTable in class AbstractDbData

getInsertAllValues

protected final String getInsertAllValues()

Specified by:

getInsertAllValues in class AbstractDbData

getUpdateAllFields

protected final String getUpdateAllFields()

Specified by:

getUpdateAllFields in class AbstractDbData

setToArray

protected final void setToArray()
                         throws WaarpDatabaseSqlException

Description copied from class: AbstractDbData

Internal function to set to Array used to push data to database

Specified by:

setToArray in class AbstractDbData

Throws:

WaarpDatabaseSqlException

setFromArray

protected final void setFromArray()
                           throws WaarpDatabaseSqlException

Description copied from class: AbstractDbData

Internal function to retrieve data from Array to pull data from database

Specified by:

setFromArray in class AbstractDbData

Throws:

WaarpDatabaseSqlException

getWherePrimaryKey

protected final String getWherePrimaryKey()

Specified by:

getWherePrimaryKey in class AbstractDbData

Returns:

The Where condition on Primary Key

setPrimaryKey

protected final void setPrimaryKey()

Set the primary Key as current value

Specified by:

setPrimaryKey in class AbstractDbData

delete

public final void delete()
                  throws WaarpDatabaseException

Description copied from class: AbstractDbData

Delete object from table

Overrides:

delete in class AbstractDbData

Throws:

WaarpDatabaseException

insert

public final void insert()
                  throws WaarpDatabaseException

Description copied from class: AbstractDbData

Insert object into table

Overrides:

insert in class AbstractDbData

Throws:

WaarpDatabaseException

create

public final void create()
                  throws WaarpDatabaseException

As insert but with the ability to change the SpecialId

Throws:

WaarpDatabaseException

getFromStatement

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

For instance when getting updated information

Parameters:

preparedStatement -

Returns:

the next updated DbTaskRunner

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getStatusPrepareStament

public static DbPreparedStatement getStatusPrepareStament(DbSession session,
                                                          ReplyCode status,
                                                          int limit)
                                                   throws WaarpDatabaseNoConnectionException,
                                                          WaarpDatabaseSqlException

Parameters:

session -

status -

limit - limit the number of rows

Returns:

the DbPreparedStatement for getting TransferLog according to status ordered by start

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getLogPrepareStament

public static DbPreparedStatement getLogPrepareStament(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

getLogPrepareStament

public static DbPreparedStatement getLogPrepareStament(DbSession session,
                                                       Timestamp start,
                                                       Timestamp stop,
                                                       ReplyCode status)
                                                throws WaarpDatabaseNoConnectionException,
                                                       WaarpDatabaseSqlException

Parameters:

session -

start -

stop -

Returns:

the DbPreparedStatement for getting Selected Object, whatever their status

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

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

getCountAllPrepareStatement

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

Parameters:

session -

Returns:

the DbPreparedStatement for getting All according to status ordered by start

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getResultCountPrepareStatement

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

Parameters:

pstt -

error -

time -

Returns:

the number of elements (COUNT) from the statement

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)
                                                throws WaarpDatabaseNoConnectionException,
                                                       WaarpDatabaseSqlException

Set the current time in the given updatedPreparedStatement

Parameters:

pstt -

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

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

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

changeUpdatedInfo

public final void changeUpdatedInfo(AbstractDbData.UpdatedInfo info)

Description copied from class: AbstractDbData

Change UpdatedInfo status

Specified by:

changeUpdatedInfo in class AbstractDbData

setReplyCodeExecutionStatus

public final void setReplyCodeExecutionStatus(ReplyCode code)

Set the ReplyCode for the UpdatedInfo

Parameters:

code -

getUpdatedInfo

public final AbstractDbData.UpdatedInfo getUpdatedInfo()

Returns:

The current UpdatedInfo value

getErrorInfo

public final ReplyCode getErrorInfo()

Returns:

the ReplyCode code associated with the Updated Info

setFilename

public final void setFilename(String filename)

Parameters:

filename - the filename to set

isSender

public final boolean isSender()

Returns:

the isSender

getFilename

public final String getFilename()

Returns:

the filename

getSpecialId

public final long getSpecialId()

Returns:

the specialId

getInfotransf

public final String getInfotransf()

Returns:

the infotransf

setInfotransf

public final void setInfotransf(String infotransf)

Parameters:

infotransf - the infotransf to set

getUser

public final String getUser()

Returns:

the user

getAccount

public final String getAccount()

Returns:

the account

setStop

public final void setStop(Timestamp stop)

Parameters:

stop - the stop to set

getMode

public final String getMode()

Returns:

the mode

saveStatus

public final void saveStatus()
                      throws WaarpDatabaseException

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

Throws:

WaarpDatabaseException

clear

public final void clear()

Clear the runner

toString

public final String toString()

Overrides:

toString in class Object

getStart

public final Timestamp getStart()

Returns:

the start

getStop

public final Timestamp getStop()

Returns:

the stop

saveDbTransferLog

public final String saveDbTransferLog(String filename)

Save the current DbTransferLog to a file

Parameters:

filename -

Returns:

The message for the HTTPS interface

saveDbTransferLogFile

public static String saveDbTransferLogFile(DbPreparedStatement preparedStatement,
                                           String filename)

Exports DbTransferLogs to a file and purges the corresponding DbTransferLogs

Parameters:

preparedStatement - the DbTransferLog as SELECT command to export (and purge)

filename - the filename where the DbLogs will be exported

Returns:

The message for the HTTPS interface

saveDbTransferLogFile

public static String saveDbTransferLogFile(DbPreparedStatement preparedStatement,
                                           Writer outWriter,
                                           boolean purge)

Exports DbTransferLogs to a Writer object and optionally purges the corresponding DbTransferLogs

Parameters:

preparedStatement - the DbTransferLog as SELECT command to export (and purge)

outWriter - a Writer object where the DbLogs will be written

purge - sets whether or not the selected results must be purged

Returns:

The message for the HTTPS interface