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 org.waarp.common.database.data.AbstractDbData

Transfer Log for FtpExec

Author:

Frederic Bregier, Bruno Carlin

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

org.waarp.common.database.data.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(org.waarp.common.database.DbSession dbSession, String user, String account, long specialId) Load from database
DbTransferLog(org.waarp.common.database.DbSession dbSession, String user, String account, long specialId, boolean isSender, String filename, String mode, org.waarp.common.command.ReplyCode infostatus, String info, org.waarp.common.database.data.AbstractDbData.UpdatedInfo updatedInfo) Insert into database

Method Summary

Methods

Modifier and Type	Method and Description
void	changeUpdatedInfo(org.waarp.common.database.data.AbstractDbData.UpdatedInfo info)
void	clear() Clear the runner
void	create() As insert but with the ability to change the SpecialId
void	delete()
static void	finishSelectOrCountPrepareStatement(org.waarp.common.database.DbPreparedStatement pstt) Set the current time in the given updatedPreparedStatement
static void	finishSelectOrCountPrepareStatement(org.waarp.common.database.DbPreparedStatement pstt, long time) Set the current time in the given updatedPreparedStatement
String	getAccount()
static org.waarp.common.database.DbPreparedStatement	getCountAllPrepareStatement(org.waarp.common.database.DbSession session)
static org.waarp.common.database.DbPreparedStatement	getCountInfoPrepareStatement(org.waarp.common.database.DbSession session)
static org.waarp.common.database.DbPreparedStatement	getCountInOutErrorPrepareStatement(org.waarp.common.database.DbSession session, boolean in) Running or not transfers are concerned
static org.waarp.common.database.DbPreparedStatement	getCountInOutRunningPrepareStatement(org.waarp.common.database.DbSession session, boolean in, boolean running) Running or not transfers are concerned
static org.waarp.common.database.DbPreparedStatement	getCountStatusPrepareStatement(org.waarp.common.database.DbSession session)
org.waarp.common.command.ReplyCode	getErrorInfo()
String	getFilename()
static DbTransferLog	getFromStatement(org.waarp.common.database.DbPreparedStatement preparedStatement) For instance when getting updated information
String	getInfotransf()
protected String	getInsertAllValues()
static org.waarp.common.database.DbPreparedStatement	getLogPrepareStament(org.waarp.common.database.DbSession session, Timestamp start, Timestamp stop)
static org.waarp.common.database.DbPreparedStatement	getLogPrepareStament(org.waarp.common.database.DbSession session, Timestamp start, Timestamp stop, org.waarp.common.command.ReplyCode status)
String	getMode()
static long	getResultCountPrepareStatement(org.waarp.common.database.DbPreparedStatement pstt)
static long	getResultCountPrepareStatement(org.waarp.common.database.DbPreparedStatement pstt, org.waarp.common.database.data.AbstractDbData.UpdatedInfo info, long time)
static long	getResultCountPrepareStatement(org.waarp.common.database.DbPreparedStatement pstt, org.waarp.common.command.ReplyCode error, long time)
protected String	getSelectAllFields()
long	getSpecialId()
Timestamp	getStart()
static org.waarp.common.database.DbPreparedStatement	getStatusPrepareStament(org.waarp.common.database.DbSession session, org.waarp.common.command.ReplyCode status, int limit)
Timestamp	getStop()
protected String	getTable()
protected String	getUpdateAllFields()
org.waarp.common.database.data.AbstractDbData.UpdatedInfo	getUpdatedInfo()
String	getUser()
protected String	getWherePrimaryKey()
protected void	initObject()
void	insert()
boolean	isSender()
String	saveDbTransferLog(String filename) Save the current DbTransferLog to a file
static String	saveDbTransferLogFile(org.waarp.common.database.DbPreparedStatement preparedStatement, String filename) Exports DbTransferLogs to a file and purges the corresponding DbTransferLogs
static String	saveDbTransferLogFile(org.waarp.common.database.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()
void	setInfotransf(String infotransf)
protected void	setPrimaryKey() Set the primary Key as current value
void	setReplyCodeExecutionStatus(org.waarp.common.command.ReplyCode code) Set the ReplyCode for the UpdatedInfo
void	setStop(Timestamp stop)
protected void	setToArray()
String	toString()

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

asJson, exist, get, getAllFields, getJson, getTrueValue, getValue, getValues, select, setFromJson, setTrueValue, setValue, setValues, update

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(org.waarp.common.database.DbSession dbSession,
             String user,
             String account,
             long specialId,
             boolean isSender,
             String filename,
             String mode,
             org.waarp.common.command.ReplyCode infostatus,
             String info,
             org.waarp.common.database.data.AbstractDbData.UpdatedInfo updatedInfo)
              throws org.waarp.common.database.exception.WaarpDatabaseException

Insert into database

Parameters:

dbSession -

user -

account -

specialId -

isSender -

filename -

mode -

infostatus -

info -

updatedInfo -

Throws:

org.waarp.common.database.exception.WaarpDatabaseException

DbTransferLog

public DbTransferLog(org.waarp.common.database.DbSession dbSession,
             String user,
             String account,
             long specialId)
              throws org.waarp.common.database.exception.WaarpDatabaseException

Load from database

Parameters:

dbSession -

user -

account -

specialId -

Throws:

org.waarp.common.database.exception.WaarpDatabaseException

Method Detail

initObject

protected void initObject()

Specified by:

initObject in class org.waarp.common.database.data.AbstractDbData

getSelectAllFields

protected String getSelectAllFields()

Specified by:

getSelectAllFields in class org.waarp.common.database.data.AbstractDbData

getTable

protected String getTable()

Specified by:

getTable in class org.waarp.common.database.data.AbstractDbData

getInsertAllValues

protected String getInsertAllValues()

Specified by:

getInsertAllValues in class org.waarp.common.database.data.AbstractDbData

getUpdateAllFields

protected String getUpdateAllFields()

Specified by:

getUpdateAllFields in class org.waarp.common.database.data.AbstractDbData

setToArray

protected void setToArray()

Specified by:

setToArray in class org.waarp.common.database.data.AbstractDbData

setFromArray

protected void setFromArray()
                     throws org.waarp.common.database.exception.WaarpDatabaseSqlException

Specified by:

setFromArray in class org.waarp.common.database.data.AbstractDbData

Throws:

org.waarp.common.database.exception.WaarpDatabaseSqlException

getWherePrimaryKey

protected String getWherePrimaryKey()

Specified by:

getWherePrimaryKey in class org.waarp.common.database.data.AbstractDbData

Returns:

The Where condition on Primary Key

setPrimaryKey

protected void setPrimaryKey()

Set the primary Key as current value

Specified by:

setPrimaryKey in class org.waarp.common.database.data.AbstractDbData

delete

public void delete()
            throws org.waarp.common.database.exception.WaarpDatabaseException

Overrides:

delete in class org.waarp.common.database.data.AbstractDbData

Throws:

org.waarp.common.database.exception.WaarpDatabaseException

insert

public void insert()
            throws org.waarp.common.database.exception.WaarpDatabaseException

Overrides:

insert in class org.waarp.common.database.data.AbstractDbData

Throws:

org.waarp.common.database.exception.WaarpDatabaseException

create

public void create()
            throws org.waarp.common.database.exception.WaarpDatabaseException

As insert but with the ability to change the SpecialId

Throws:

org.waarp.common.database.exception.WaarpDatabaseException

getFromStatement

public static DbTransferLog getFromStatement(org.waarp.common.database.DbPreparedStatement preparedStatement)
                                      throws org.waarp.common.database.exception.WaarpDatabaseNoConnectionException,
                                             org.waarp.common.database.exception.WaarpDatabaseSqlException

For instance when getting updated information

Parameters:

preparedStatement -

Returns:

the next updated DbTaskRunner

Throws:

org.waarp.common.database.exception.WaarpDatabaseNoConnectionException

org.waarp.common.database.exception.WaarpDatabaseSqlException

getStatusPrepareStament

public static org.waarp.common.database.DbPreparedStatement getStatusPrepareStament(org.waarp.common.database.DbSession session,
                                                                    org.waarp.common.command.ReplyCode status,
                                                                    int limit)
                                                                             throws org.waarp.common.database.exception.WaarpDatabaseNoConnectionException,
                                                                                    org.waarp.common.database.exception.WaarpDatabaseSqlException

Parameters:

session -

status -

limit - limit the number of rows

Returns:

the DbPreparedStatement for getting TransferLog according to status ordered by start

Throws:

org.waarp.common.database.exception.WaarpDatabaseNoConnectionException

org.waarp.common.database.exception.WaarpDatabaseSqlException

getLogPrepareStament

public static org.waarp.common.database.DbPreparedStatement getLogPrepareStament(org.waarp.common.database.DbSession session,
                                                                 Timestamp start,
                                                                 Timestamp stop)
                                                                          throws org.waarp.common.database.exception.WaarpDatabaseNoConnectionException,
                                                                                 org.waarp.common.database.exception.WaarpDatabaseSqlException

Parameters:

session -

start -

stop -

Returns:

the DbPreparedStatement for getting Selected Object, whatever their status

Throws:

org.waarp.common.database.exception.WaarpDatabaseNoConnectionException

org.waarp.common.database.exception.WaarpDatabaseSqlException

getLogPrepareStament

public static org.waarp.common.database.DbPreparedStatement getLogPrepareStament(org.waarp.common.database.DbSession session,
                                                                 Timestamp start,
                                                                 Timestamp stop,
                                                                 org.waarp.common.command.ReplyCode status)
                                                                          throws org.waarp.common.database.exception.WaarpDatabaseNoConnectionException,
                                                                                 org.waarp.common.database.exception.WaarpDatabaseSqlException

Parameters:

session -

start -

stop -

Returns:

the DbPreparedStatement for getting Selected Object, whatever their status

Throws:

org.waarp.common.database.exception.WaarpDatabaseNoConnectionException

org.waarp.common.database.exception.WaarpDatabaseSqlException

getCountInfoPrepareStatement

public static org.waarp.common.database.DbPreparedStatement getCountInfoPrepareStatement(org.waarp.common.database.DbSession session)
                                                                                  throws org.waarp.common.database.exception.WaarpDatabaseNoConnectionException,
                                                                                         org.waarp.common.database.exception.WaarpDatabaseSqlException

Parameters:

session -

Returns:

the DbPreparedStatement for getting Updated Object

Throws:

org.waarp.common.database.exception.WaarpDatabaseNoConnectionException

org.waarp.common.database.exception.WaarpDatabaseSqlException

getResultCountPrepareStatement

public static long getResultCountPrepareStatement(org.waarp.common.database.DbPreparedStatement pstt,
                                  org.waarp.common.database.data.AbstractDbData.UpdatedInfo info,
                                  long time)

Parameters:

pstt -

info -

time -

Returns:

the number of elements (COUNT) from the statement

getCountStatusPrepareStatement

public static org.waarp.common.database.DbPreparedStatement getCountStatusPrepareStatement(org.waarp.common.database.DbSession session)
                                                                                    throws org.waarp.common.database.exception.WaarpDatabaseNoConnectionException,
                                                                                           org.waarp.common.database.exception.WaarpDatabaseSqlException

Parameters:

session -

Returns:

the DbPreparedStatement for getting Runner according to status ordered by start

Throws:

org.waarp.common.database.exception.WaarpDatabaseNoConnectionException

org.waarp.common.database.exception.WaarpDatabaseSqlException

getCountAllPrepareStatement

public static org.waarp.common.database.DbPreparedStatement getCountAllPrepareStatement(org.waarp.common.database.DbSession session)
                                                                                 throws org.waarp.common.database.exception.WaarpDatabaseNoConnectionException,
                                                                                        org.waarp.common.database.exception.WaarpDatabaseSqlException

Parameters:

session -

Returns:

the DbPreparedStatement for getting All according to status ordered by start

Throws:

org.waarp.common.database.exception.WaarpDatabaseNoConnectionException

org.waarp.common.database.exception.WaarpDatabaseSqlException

getResultCountPrepareStatement

public static long getResultCountPrepareStatement(org.waarp.common.database.DbPreparedStatement pstt,
                                  org.waarp.common.command.ReplyCode error,
                                  long time)

Parameters:

pstt -

error -

time -

Returns:

the number of elements (COUNT) from the statement

getResultCountPrepareStatement

public static long getResultCountPrepareStatement(org.waarp.common.database.DbPreparedStatement pstt)

Parameters:

pstt -

Returns:

the number of elements (COUNT) from the statement

finishSelectOrCountPrepareStatement

public static void finishSelectOrCountPrepareStatement(org.waarp.common.database.DbPreparedStatement pstt)
                                                throws org.waarp.common.database.exception.WaarpDatabaseNoConnectionException,
                                                       org.waarp.common.database.exception.WaarpDatabaseSqlException

Set the current time in the given updatedPreparedStatement

Parameters:

pstt -

Throws:

org.waarp.common.database.exception.WaarpDatabaseNoConnectionException

org.waarp.common.database.exception.WaarpDatabaseSqlException

finishSelectOrCountPrepareStatement

public static void finishSelectOrCountPrepareStatement(org.waarp.common.database.DbPreparedStatement pstt,
                                       long time)
                                                throws org.waarp.common.database.exception.WaarpDatabaseNoConnectionException,
                                                       org.waarp.common.database.exception.WaarpDatabaseSqlException

Set the current time in the given updatedPreparedStatement

Parameters:

pstt -

Throws:

org.waarp.common.database.exception.WaarpDatabaseNoConnectionException

org.waarp.common.database.exception.WaarpDatabaseSqlException

getCountInOutErrorPrepareStatement

public static org.waarp.common.database.DbPreparedStatement getCountInOutErrorPrepareStatement(org.waarp.common.database.DbSession session,
                                                                               boolean in)
                                                                                        throws org.waarp.common.database.exception.WaarpDatabaseNoConnectionException,
                                                                                               org.waarp.common.database.exception.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:

org.waarp.common.database.exception.WaarpDatabaseNoConnectionException

org.waarp.common.database.exception.WaarpDatabaseSqlException

getCountInOutRunningPrepareStatement

public static org.waarp.common.database.DbPreparedStatement getCountInOutRunningPrepareStatement(org.waarp.common.database.DbSession session,
                                                                                 boolean in,
                                                                                 boolean running)
                                                                                          throws org.waarp.common.database.exception.WaarpDatabaseNoConnectionException,
                                                                                                 org.waarp.common.database.exception.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:

org.waarp.common.database.exception.WaarpDatabaseNoConnectionException

org.waarp.common.database.exception.WaarpDatabaseSqlException

changeUpdatedInfo

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

Specified by:

changeUpdatedInfo in class org.waarp.common.database.data.AbstractDbData

setReplyCodeExecutionStatus

public void setReplyCodeExecutionStatus(org.waarp.common.command.ReplyCode code)

Set the ReplyCode for the UpdatedInfo

Parameters:

code -

getUpdatedInfo

public org.waarp.common.database.data.AbstractDbData.UpdatedInfo getUpdatedInfo()

Returns:

The current UpdatedInfo value

getErrorInfo

public org.waarp.common.command.ReplyCode getErrorInfo()

Returns:

the ReplyCode code associated with the Updated Info

setFilename

public void setFilename(String filename)

Parameters:

filename - the filename to set

isSender

public boolean isSender()

Returns:

the isSender

getFilename

public String getFilename()

Returns:

the filename

getSpecialId

public long getSpecialId()

Returns:

the specialId

getInfotransf

public String getInfotransf()

Returns:

the infotransf

setInfotransf

public void setInfotransf(String infotransf)

Parameters:

infotransf - the infotransf to set

getUser

public String getUser()

Returns:

the user

getAccount

public String getAccount()

Returns:

the account

setStop

public void setStop(Timestamp stop)

Parameters:

stop - the stop to set

getMode

public String getMode()

Returns:

the mode

saveStatus

public void saveStatus()
                throws org.waarp.common.database.exception.WaarpDatabaseException

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

Throws:

org.waarp.common.database.exception.WaarpDatabaseException

clear

public void clear()

Clear the runner

toString

public String toString()

Overrides:

toString in class Object

getStart

public Timestamp getStart()

Returns:

the start

getStop

public Timestamp getStop()

Returns:

the stop

saveDbTransferLog

public 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(org.waarp.common.database.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(org.waarp.common.database.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