FileSystemLogRepository (Bennu Scheduler 6.0.5-FORK API)

java.lang.Object
- org.fenixedu.bennu.scheduler.log.FileSystemLogRepository

All Implemented Interfaces:

ExecutionLogRepository
```
public class FileSystemLogRepository
extends Object
implements ExecutionLogRepository
```
This log repository implementation stores the execution logs in the file system, scattering them in the following way:
```
 ├ index.json
 ├ org_fenixedu_bennu_scheduler_example_ExampleTask
 │ ├── 4ea3e6
 │ │   └── e0f643
 │ │       └── 4cc7b2
 │ │           └── 381e01
 │ │               └── 4ea6f7
 │ │                   └── 1d
 │ │                       ├── execution.json
 │ │                       ├── files
 │ │                       │   ├── 02bbcba853c0c09a8df49feaf6799842
 │ │                       └── output
 
```
In the root of the repository, an index.json file contains the latest execution id for every different task. For every execution, a set of folders is generated based on the execution's id, dispersing the id among multiple sub-directories (in this case, each sub-directory has 6-character names, meaning the repository is configured with a dispersion factor of 6). Inside each execution's folder, there are three main components:
- An execution.json file, containing the JSON for the associated ExecutionLog, as well as the id for the previous execution of this task. This effectively creates a linked-list of executions with O(1) insertion complexity.
- An optional output file, containing the task log, if it is created by the task.
- A files folder, containing all the files added to by the task during its execution. To prevent path-traversal attacks, the filename is hashed.
Author:

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

Constructor Summary

Constructors
Constructor and Description
`FileSystemLogRepository(int dispersionFactor)` Creates a new `FileSystemLogRepository` with the given dispersion factor, and the default logs path.
`FileSystemLogRepository(String basePath, int dispersionFactor)` Creates a new `FileSystemLogRepository` with the given dispersion factor, and the given base path.

Method Summary

All Methods Instance Methods Concrete Methods
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> start, 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 fileName)` 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`	`setBasePath(String basePath)`
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FileSystemLogRepository
```
public FileSystemLogRepository(String basePath,
                               int dispersionFactor)
```
    Creates a new FileSystemLogRepository with the given dispersion factor, and the given base path. The dispersion factor is used to determine the maximum length that each execution's folder name has, thus dispersing the log files in a file tree, instead of a flat list.
    
    Parameters:
    
    basePath - The base path to use to store the logs
    
    dispersionFactor - The dispersion factor to be used
  - FileSystemLogRepository
```
public FileSystemLogRepository(int dispersionFactor)
```
    Creates a new FileSystemLogRepository with the given dispersion factor, and the default logs path.
    
    Parameters:
    
    dispersionFactor - The dispersion factor to be used
- Method Detail
  - setBasePath
```
public void setBasePath(String basePath)
```
  - update
```
public void update(ExecutionLog log)
```
    Stores the updated version of the task log for the given execution.
    
    Specified by:
    
    update in interface ExecutionLogRepository
    
    Parameters:
    
    log - The execution log to store
  - newExecution
```
public void newExecution(ExecutionLog log)
```
    Stores a new execution of a given task. This method differs from the ExecutionLogRepository.update(ExecutionLog) method, in that it may used to update the repository's index.
    
    Specified by:
    
    newExecution in interface ExecutionLogRepository
    
    Parameters:
    
    log - The new execution log to store
  - appendTaskLog
```
public void appendTaskLog(ExecutionLog log,
                          String text)
```
    Appends the given text to the task log for the given execution.
    
    Specified by:
    
    appendTaskLog in interface ExecutionLogRepository
    
    Parameters:
    
    log - The execution log for which the text is to be appended
    
    text - The text to be appended
  - storeFile
```
public void storeFile(ExecutionLog log,
                      String fileName,
                      byte[] contents,
                      boolean append)
```
    Stores the given file to the task execution related to the given ExecutionLog.
    
    Specified by:
    
    storeFile in interface ExecutionLogRepository
    
    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
```
public 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.
    
    Specified by:
    
    latest in interface ExecutionLogRepository
    
    Returns:
    
    The latest execution of all tasks stored in the repository
  - executionsFor
```
public Stream<ExecutionLog> executionsFor(String taskName,
                                          Optional<String> start,
                                          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.
    
    Specified by:
    
    executionsFor in interface ExecutionLogRepository
    
    Parameters:
    
    taskName - The name of the task for which to retrieve the logs
    
    start - 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
```
public 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.
    
    Specified by:
    
    getTaskLog in interface ExecutionLogRepository
    
    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
```
public Optional<byte[]> getFile(String taskName,
                                String id,
                                String fileName)
```
    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.
    
    Specified by:
    
    getFile in interface ExecutionLogRepository
    
    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
    
    fileName - The filename to be retrieved
    
    Returns:
    
    The contents of the requested file, may be empty
  - getLog
```
public 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.
    
    Specified by:
    
    getLog in interface ExecutionLogRepository
    
    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

Class FileSystemLogRepository

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileSystemLogRepository

FileSystemLogRepository

Method Detail

setBasePath

update

newExecution

appendTaskLog

storeFile

latest

executionsFor

getTaskLog

getFile

getLog