org.fenixedu.bennu.scheduler.log

Interface ExecutionLogRepository

All Known Implementing Classes:

FileSystemLogRepository

public interface ExecutionLogRepository

A log repository is responsible for storing and retrieving execution logs for scheduler tasks.

Author:

João Carvalho (joao.pedro.carvalho@tecnico.ulisboa.pt)

Method Summary

Modifier and Type	Method and Description
void	appendTaskLog(ExecutionLog log, String text) Appends the given text to the task log for the given execution.
Stream<ExecutionLog>	executionsFor(String taskName, Optional<String> startId, int max) Returns a Stream containing the execution logs for the given task, up to max elements.
Optional<byte[]>	getFile(String taskName, String id, String file) Retrieves the file with the given name, generated by the execution of the given task with the given ID, if it is found.
Optional<ExecutionLog>	getLog(String taskName, String id) Returns the ExecutionLog for the given task execution, by task name and execution id, if it exists in the repository.
Optional<String>	getTaskLog(String taskName, String id) Returns the log generated by CronTask's taskLog method, from the given task with the given execution id, if it is present on the repository.
Stream<ExecutionLog>	latest() Returns the latest execution of every task that has been stored in this repository.
void	newExecution(ExecutionLog log) Stores a new execution of a given task.
void	storeFile(ExecutionLog log, String fileName, byte[] contents, boolean append) Stores the given file to the task execution related to the given ExecutionLog.
void	update(ExecutionLog log) Stores the updated version of the task log for the given execution.

Method Detail

update

void update(ExecutionLog log)

Stores the updated version of the task log for the given execution.

Parameters:

log - The execution log to store

newExecution

void newExecution(ExecutionLog log)

Stores a new execution of a given task. This method differs from the update(ExecutionLog) method, in that it may used to update the repository's index.

Parameters:

log - The new execution log to store

appendTaskLog

void appendTaskLog(ExecutionLog log,
                   String text)

Appends the given text to the task log for the given execution.

Parameters:

log - The execution log for which the text is to be appended

text - The text to be appended

storeFile

void storeFile(ExecutionLog log,
               String fileName,
               byte[] contents,
               boolean append)

Stores the given file to the task execution related to the given ExecutionLog.

Parameters:

log - The execution log for which this file is to be stored

fileName - The name of the file to store

contents - The contents to store

append - Whether the contents should be appended or replace the potentially existing file

latest

Stream<ExecutionLog> latest()

Returns the latest execution of every task that has been stored in this repository. This acts as an index for all task executions. The size of the returned stream is bound by the number of different tasks run in the system.

Returns:

The latest execution of all tasks stored in the repository

executionsFor

Stream<ExecutionLog> executionsFor(String taskName,
                                   Optional<String> startId,
                                   int max)

Returns a Stream containing the execution logs for the given task, up to max elements. If a start id is provided, the logs will start with the one with the given id, otherwise, the latest executions are returned.

Parameters:

taskName - The name of the task for which to retrieve the logs

startId - The optional task id for which to start returning the logs. If empty, the latest executions are returned, if invalid, an empty stream is returned.

max - The maximum number of elements to return

Returns:

The max latest executions for the given task

getTaskLog

Optional<String> getTaskLog(String taskName,
                            String id)

Returns the log generated by CronTask's taskLog method, from the given task with the given execution id, if it is present on the repository. Otherwise, returns an empty Optional.

Parameters:

taskName - The name of the task for which to retrieve the log

id - The identifier of the execution for which to retrieve the log

Returns:

The contents of the task log, may be empty

getFile

Optional<byte[]> getFile(String taskName,
                         String id,
                         String file)

Retrieves the file with the given name, generated by the execution of the given task with the given ID, if it is found. Otherwise, returns an empty Optional.

Parameters:

taskName - The name of the task for which to retrieve the file

id - The identifier of the execution for which to retrieve the file

file - The filename to be retrieved

Returns:

The contents of the requested file, may be empty

getLog

Optional<ExecutionLog> getLog(String taskName,
                              String id)

Returns the ExecutionLog for the given task execution, by task name and execution id, if it exists in the repository. Otherwise, returns an empty Optional.

Parameters:

taskName - The name of the task for which to retrieve the log

id - The identifier of the execution for which to retrieve the log

Returns:

The execution log for the given id, may be empty