net.proteusframework.core.automation

Class TaskManager

java.lang.Object

net.proteusframework.core.automation.TaskManager

public class TaskManager
extends Object

Task Log.

Author:

Russ Tennant (russ@i2rd.com)

Method Summary

Modifier and Type	Method and Description
(package private) static void	generateSelectAndFromClauseForTaskLog(StringBuilder sql) Generate a select and from clause.
DataSource	getDataSource() Get the data source.
static TaskManager	getInstance(DataSource ds) Get an instance of the logger.
TaskLog	getLastLog(Task task) Get the last log.
TaskLog	getLastTaskLog(Class<? extends Task> type) Get the task log for the last data conversion.
TaskLog	getTaskLog(int databaseID) Get a task log by database ID.
List<TaskLog>	getTaskLogs(String identifier, Long version, String user, TaskRunStatus status) Get TaskLogs that match the specified criteria.
List<TaskLog>	getTaskLogs(Task task) Get all task logs for the specified task.
Map<DataConversion,TaskRunStatus>	getTaskRunStatusMap(List<DataConversion> tasks) Get a mapping of task statuses.
TaskRunStatus	getTaskStatus(Task task) Get the status of a task.
(package private) static List<Loggable>	loadLogs(Connection conn, int databaseID) Load the logs.
(package private) List<Loggable>	loadLogs(TaskLog taskLog) Load the logs.
(package private) TaskLog	loadTaskLog(Connection conn, ResultSet rs) Loads a row from a result set.
void	log(TaskLog taskLog) Write the log to the database.

Methods inherited from class java.lang.Object

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

Method Detail

generateSelectAndFromClauseForTaskLog

static void generateSelectAndFromClauseForTaskLog(StringBuilder sql)

Generate a select and from clause.

Parameters:

sql - the string builder.

getDataSource

public DataSource getDataSource()

Get the data source.

Returns:

the data source.

getInstance

public static TaskManager getInstance(DataSource ds)
                               throws SQLException

Get an instance of the logger.

Parameters:

ds - the data source.

Returns:

the logger.

Throws:

SQLException - if the logger couldn't be initialized.

getLastLog

public TaskLog getLastLog(Task task)
                   throws SQLException

Get the last log.

Parameters:

task - the task.

Returns:

the log or null.

Throws:

SQLException - if an error occurs.

getLastTaskLog

@Nullable
public TaskLog getLastTaskLog(Class<? extends Task> type)
                                 throws SQLException

Get the task log for the last data conversion.

Parameters:

type - the type of Task.

Returns:

the task log or null.

Throws:

SQLException - on error.

getTaskLog

@Nullable
public TaskLog getTaskLog(int databaseID)
                             throws SQLException

Get a task log by database ID.

Parameters:

databaseID - the database ID.

Returns:

the TaskLog or null.

Throws:

SQLException - if an error occurs.

getTaskLogs

public List<TaskLog> getTaskLogs(String identifier,
                                 @Nullable
                                 Long version,
                                 @Nullable
                                 String user,
                                 @Nullable
                                 TaskRunStatus status)
                          throws SQLException

Get TaskLogs that match the specified criteria.

Parameters:

identifier - optional Task identifier.

version - optional version.

user - optional user.

status - optional status.

Returns:

a list of TaskLogs order by date run descending.

Throws:

SQLException - if an error occurs.

getTaskLogs

public List<TaskLog> getTaskLogs(Task task)
                          throws SQLException

Get all task logs for the specified task. Logs are ordered from newest to oldest.

Parameters:

task - the task.

Returns:

the task logs.

Throws:

SQLException - if an error occurs.

getTaskRunStatusMap

public Map<DataConversion,TaskRunStatus> getTaskRunStatusMap(List<DataConversion> tasks)
                                                      throws SQLException

Get a mapping of task statuses.

Parameters:

tasks - the tasks.

Returns:

the mapping.

Throws:

SQLException - on error.

getTaskStatus

public TaskRunStatus getTaskStatus(Task task)
                            throws SQLException

Get the status of a task. A task is considered successful if it ran successfully at least once.

Parameters:

task - the task.

Returns:

the status.

Throws:

SQLException - on error.

loadLogs

static List<Loggable> loadLogs(Connection conn,
                               int databaseID)
                        throws SQLException

Load the logs.

Parameters:

conn - the database connection.

databaseID - the database ID of the TaskLog to load.

Returns:

the Logs.

Throws:

SQLException - on error.

loadLogs

final List<Loggable> loadLogs(TaskLog taskLog)

Load the logs.

Parameters:

taskLog - the task log.

Returns:

the logs.

loadTaskLog

final TaskLog loadTaskLog(Connection conn,
                          ResultSet rs)
                   throws SQLException

Loads a row from a result set.

Parameters:

conn - the connection

rs - the result set.

Returns:

the task log.

Throws:

SQLException - on error.

log

public void log(TaskLog taskLog)
         throws SQLException

Write the log to the database.

Parameters:

taskLog - the log.

Throws:

SQLException - if an error occurs.