Class CommandLog

java.lang.Object

org.deltava.beans.system.CommandLog

All Implemented Interfaces:

Serializable, Comparable<CommandLog>, RemoteAddressBean, ViewEntry

public class CommandLog
extends Object
implements Serializable, Comparable<CommandLog>, RemoteAddressBean, ViewEntry

A bean to log Web Site Command invocations.

Since:

1.0

Version:

10.2

Author:

Luke

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CommandLog(String cmdName, CommandResult cr)	Creates a new Command log entry.
CommandLog(Instant d)	Creates a new Command log entry.

Method Summary

Modifier and Type	Method	Description
int	compareTo(CommandLog cl2)	Compares two log entries by comparing their dates.
long	getBackEndTime()	Returns the amount of time the database was in use.
Instant	getDate()	Returns the date the Command was executed.
String	getName()	Returns the Command name.
int	getPilotID()	Returns the database ID of the Pilot executing the Command.
String	getRemoteAddr()	Returns the remote IP address.
String	getRemoteHost()	Returns the remote host name.
String	getResult()	Returns the command result data.
String	getRowClassName()	Returns the CSS table row class name.
boolean	getSuccess()	Returns if the Command completed succesfully.
long	getTime()	Returns the execution time.
void	setBackEndTime(long time)	Updates the time spent accessing the database.
void	setName(String cmdName)	Updates the Command name.
void	setPilotID(int id)	Updates the database ID of the user executing this Command.
void	setRemoteAddr(String addr)	Updates the IP address of the user executing the Command.
void	setRemoteHost(String hostName)	Updates the host name of the user executing the Command.
void	setResult(String msg)	Updates the Command result data.
void	setSuccess(boolean isOK)	Marks whether this Command executed successfully.
void	setTime(long time)	Updates the total execution time.

Methods inherited from class Object

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

Methods inherited from interface RemoteAddressBean

getIsResolved

Constructor Details

CommandLog

public CommandLog(Instant d)

Creates a new Command log entry.

Parameters:

d - the date/time of the command invocation.

See Also:

• getDate()

CommandLog

public CommandLog(String cmdName,
 CommandResult cr)

Creates a new Command log entry.

Parameters:

cmdName - the Command name

cr - the CommandResult bean

Method Details

getDate

public Instant getDate()

Returns the date the Command was executed.

Returns:

the execution date/time

getName

public String getName()

Returns the Command name.

Returns:

the Command name

See Also:

• setName(String)

getRemoteAddr

public String getRemoteAddr()

Description copied from interface: RemoteAddressBean

Returns the remote IP address.

Specified by:

getRemoteAddr in interface RemoteAddressBean

Returns:

an IPv4 or IPv6 address

getRemoteHost

public String getRemoteHost()

Description copied from interface: RemoteAddressBean

Returns the remote host name.

Specified by:

getRemoteHost in interface RemoteAddressBean

Returns:

the host name, or address if unresolved

getResult

public String getResult()

Returns the command result data.

Returns:

the result data

See Also:

• setResult(String)

getPilotID

public int getPilotID()

Returns the database ID of the Pilot executing the Command.

Returns:

the database ID

See Also:

• setPilotID(int)
• DatabaseBean.getID()

getSuccess

public boolean getSuccess()

Returns if the Command completed succesfully.

Returns:

TRUE if execution was successful, otherwise FALSE

See Also:

• setSuccess(boolean)

getBackEndTime

public long getBackEndTime()

Returns the amount of time the database was in use.

Returns:

the time in milliseconds

See Also:

• setBackEndTime(long)
• getTime()

getTime

public long getTime()

Returns the execution time.

Returns:

the time of milliseconds

See Also:

• setTime(long)
• getBackEndTime()

setName

public void setName(String cmdName)

Updates the Command name.

Parameters:

cmdName - the name

See Also:

• getName()

setRemoteAddr

public void setRemoteAddr(String addr)

Updates the IP address of the user executing the Command.

Parameters:

addr - the IP address

See Also:

• getRemoteAddr()
• setRemoteHost(String)

setRemoteHost

public void setRemoteHost(String hostName)

Updates the host name of the user executing the Command.

Parameters:

hostName - the host name

See Also:

• getRemoteHost()
• setRemoteAddr(String)

setResult

public void setResult(String msg)

Updates the Command result data.

Parameters:

msg - the result data

See Also:

• getResult()

setPilotID

public void setPilotID(int id)

Updates the database ID of the user executing this Command.

Parameters:

id - the Pilot's database ID

See Also:

• getPilotID()
• DatabaseBean.getID()

setSuccess

public void setSuccess(boolean isOK)

Marks whether this Command executed successfully.

Parameters:

isOK - TRUE if the Command completed successfully, otherwise FALSE

See Also:

• getSuccess()

setBackEndTime

public void setBackEndTime(long time)

Updates the time spent accessing the database.

Parameters:

time - the time in milliseconds

See Also:

• getBackEndTime()
• setTime(long)

setTime

public void setTime(long time)

Updates the total execution time.

Parameters:

time - the time in milliseconds

See Also:

• getTime()
• setBackEndTime(long)

compareTo

public int compareTo(CommandLog cl2)

Compares two log entries by comparing their dates.

Specified by:

compareTo in interface Comparable<CommandLog>

getRowClassName

public String getRowClassName()

Returns the CSS table row class name.

Specified by:

getRowClassName in interface ViewEntry

Returns:

null or "warn" if execution not successful

See Also:

• getSuccess()