Class SetSystemData

java.lang.Object

org.deltava.dao.DAO

org.deltava.dao.SetSystemData

public class SetSystemData
extends DAO

A Data Access Object to write system logging (user commands, tasks) entries.

Since:

1.0

Version:

12.0

Author:

Luke

Field Summary

Fields inherited from class DAO

_queryMax, _queryStart, _queryTimeout, WGS84_SRID

Modifier and Type	Field	Description
protected int	_queryMax	The maximum number of rows to return.
protected int	_queryStart	The row number at which to start returning results.
protected int	_queryTimeout	The query timeout, in seconds.
protected static final int	WGS84_SRID	The SRID used for geolocation queries.

Constructor Summary

Constructors

Constructor	Description
SetSystemData(Connection c)	Initialize the Data Access Object.

Method Summary

Modifier and Type	Method	Description
void	deleteBlacklist(String addr)	Removes a login/registration blacklist entry containing a particular IP address.
void	logAPIRequests(Collection<APIRequest> reqs)	Writes external API requests to the database.
void	logCommands(Collection<CommandLog> entries)	Logs Web Site Command invocation.
void	login(String dbName, int id, String addr, String host)	Logs user authentication.
void	logTaskExecution(String name, long execTime)	Logs the execution time of a Scheduled Task.
int	purgeCommands(int days)	Purges entries out of a System commands log table.
void	update(String oldID, TZInfo tz)	Updates an existing Time Zone entry in the database.
void	write(BlacklistEntry be)	Writes a login/registration blacklist entry to the database.
void	write(BrowserReport r)	Writes a Browser policy violation report to the database.
void	write(TZInfo tz)	Writes a new Time Zone entry to the database.

Methods inherited from class DAO

commitTransaction, createTimestamp, executeIDs, executeUpdate, executeUpdate, expandDate, formatDBName, formatLocation, getNewID, getQueryCount, prepare, prepareWithoutLimits, rollbackTransaction, setQueryMax, setQueryStart, setQueryTimeout, startTransaction, toID, toID, toInstant

Modifier and Type	Method	Description
protected void	commitTransaction()	Commits a multi-step transaction to the database.
protected static Timestamp	createTimestamp(Instant i)	Null-safe conversion of an Instant to a Timestamp.
protected static List<Integer>	executeIDs(PreparedStatement ps)	Helper method to extract database ID data from the result set.
protected static int	executeUpdate(PreparedStatement ps, int minUpdateCount)	Executes an UPDATE transaction on a prepared statement, and throws a SQLExceptionif less than the expected number of rows were updated.
protected static int	executeUpdate(PreparedStatement ps, int minPerUpdate, int minTotal)	Executes an batched UPDATE transaction on a prepared statement, and throws a SQLExceptionif less than the expected number of rows were updated per batch entry.
protected static Instant	expandDate(Date dt)	Converts a date-only JDBC value into a full timestamp.
protected static String	formatDBName(String db)	Formats a database name by converting to lowercase.
protected static String	formatLocation(GeoLocation loc)	Converts a geographic location into a MySQL WKT formatted point.
protected int	getNewID()	Returns the AUTO_INC column value generated by the previous JDBC transaction.
static final long	getQueryCount()	Returns the total number of queries executed since the JVM was started.
protected PreparedStatement	prepare(String sql)	Initialize the prepared statement with an arbitrary SQL statement.
protected PreparedStatement	prepareWithoutLimits(String sql)	Initialize the prepared statement with an abitrary SQL statement, without applying the DAO's query result limitations.
protected void	rollbackTransaction()	Rolls back a multi-step transaction before it is completed.
final void	setQueryMax(int maxRows)	Sets the maximum number of rows in the returned result set.
final void	setQueryStart(int rowStart)	Sets the first row of the results to return.
void	setQueryTimeout(int timeout)	Sets the timeout for any SQL operations.
protected void	startTransaction()	Marks the start of a multi-step database transaction.
protected static Integer	toID(Object o)	Converts a Database bean or an Integer into an Integer.
protected static Collection<Integer>	toID(Collection<?> ids)	Converts a collection of Objects into Integer IDs.
protected static Instant	toInstant(Timestamp dt)	Null-safe conversion of a Timestamp to an Instant.

Methods inherited from class Object

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

Constructor Details

SetSystemData

public SetSystemData(Connection c)

Initialize the Data Access Object.

Parameters:

c - the JDBC connection to use

Method Details

logCommands

public void logCommands(Collection<CommandLog> entries)
                 throws DAOException

Logs Web Site Command invocation.

Parameters:

entries - the Command log entries

Throws:

DAOException - if a JDBC error occurs

logAPIRequests

public void logAPIRequests(Collection<APIRequest> reqs)
                    throws DAOException

Writes external API requests to the database.

Parameters:

reqs - a Collection of APIRequest beans

Throws:

DAOException - if a JDBC error occurs

logTaskExecution

public void logTaskExecution(String name,
 long execTime)
                      throws DAOException

Logs the execution time of a Scheduled Task.

Parameters:

name - the Scheduled Task name

execTime - the execution time in milliseconds

Throws:

DAOException - if a JDBC error occurs

purgeCommands

public int purgeCommands(int days)
                  throws DAOException

Purges entries out of a System commands log table.

Parameters:

days - the number of days back to set the cutoff date

Returns:

the number of entries deleted

Throws:

DAOException - if a JDBC error occurs

write

public void write(BrowserReport r)
           throws DAOException

Writes a Browser policy violation report to the database.

Parameters:

r - a BrowserReport

Throws:

DAOException - if a JDBC error occurs

login

public void login(String dbName,
 int id,
 String addr,
 String host)
           throws DAOException

Logs user authentication.

Parameters:

dbName - the database name

id - the User's database ID

addr - the remote IP address

host - the remote host name

Throws:

DAOException - if a JDBC error occurs

deleteBlacklist

public void deleteBlacklist(String addr)
                     throws DAOException

Removes a login/registration blacklist entry containing a particular IP address.

Parameters:

addr - the IP address

Throws:

DAOException - if a JDBC error occurs

write

public void write(BlacklistEntry be)
           throws DAOException

Writes a login/registration blacklist entry to the database.

Parameters:

be - a BlacklistEntry bean

Throws:

DAOException - if a JDBC error occurs

write

public void write(TZInfo tz)
           throws DAOException

Writes a new Time Zone entry to the database.

Parameters:

tz - the Time Zone bean

Throws:

DAOException - if a JDBC error occurs

update

public void update(String oldID,
 TZInfo tz)
            throws DAOException

Updates an existing Time Zone entry in the database.

Parameters:

oldID - the old Time Zone code

tz - the Time Zone bean

Throws:

DAOException - if a JDBC error occurs