All Classes and Interfaces
Class
Description
A partial Worker implementation with utility methods.
A WorkerFactory that uses a pre-defined configuration and Worker task class.
A bootstrap configuration is a method of providing basic, initial startup configuration.
This interface should be implemented by CAF Workers which are able to process multiple tasks together.
This object is supplied to CAF Workers which are able to process multiple tasks together.
Implements a default mechanism for selecting a Decoder to use when interpreting configuration files.
Partial implementation of a ManagedConfigurationSource that performs hierarchical lookups based upon the service's ServicePath, and
recursive lookup for configuration objects that themselves have configuration in marked with the @Configuration annotation.
Provides a method of encrypting and decrypting string data, such as passwords.
Thrown when a Cipher encounters a failure when encrypting or decrypting information.
Simple boilerplate for returning a Cipher implementation.
A Codec specifies methods to serialise data from a Java object to byte format, and deserialise data from byte format back into a
specified Java class.
Thrown when a Codec fails to encode or decode information.
Indicates either that the class is a simple Java object that stores configuration, or for fields within a class, indicates this object
is an embedded configuration object that can be overridden by a ConfigurationSource.
Simple interface to return the Decoder to use when reading the configuration files.
Indicates there was a problem in the ConfigurationSource module.
Provides metrics for a ConfigurationSource.
A ConfigurationSource is intended to provide an implementation-agnostic method of retrieving application-specific configuration.
Simple boilerplate to return a ConfigurationSource.
An acknowledge Event for a Consumer.
A deliver Event for a Consumer.
A message drop Event for a Consumer.
A message reject Event for a Consumer.
Used on a field of type Map with String keys to indicate that they keys must contains specific Strings.
Validates a specific String key is present within a Map.
Interface for defining how to retrieve objects or streams from a reference.
General exception for DataSource acquisition failures.
A representation of a generic data store, for reading and writing data typically used by workers in the course of their computation.
Thrown by classes relevant to DataStore when it cannot handle a request.
Provides metrics for a DataStore.
Supported by
DataStore implementations which can supply an output stream for storing data.Simple boilerplate to return a DataStore implementation.
An implementation of a DataSource that uses a Worker DataStore and a CAF Codec.
Dictates the decoding method for a Codec, specifying whether the Codec should perform strict decoding or be more lenient which can help
in being tolerant to data from a subtly different class version of the object.
A Decoder provides a facility to convert data to an object representation.
Default RabbitConsumer that uses QueueConsumer Event objects.
Default RabbitPublisher that uses QueuePublisher Event objects.
Structure that contains data and metadata from a RabbitMQ queue delivery.
The action to be taken by a worker when it receives a message that has been diverted.
A worker should implement this interface if it is capable of evaluating task messages that have been diverted (maybe because the
worker's input queue is different from the target/to queue in the task message), and deciding what to do with them.
Possible states of durability for a RabbitMQ queue.
Allows interaction with the election process of an individual service election.
The endpoint that an election process will call to upon election or rejection of this instance from a particular Election.
Thrown if there is a problem with the election process.
Factory class for returning Election objects for a specific service election.
Simple boilerplate for providing an ElectionFactory.
Possible actions to perform when a queue is empty for a RabbitMQ queue.
Utility app for using a ServiceProvider to encrypt some data.
Marker annotation that specifies an item, typically in a configuration class, that a SecurityProvider can decrypt.
A general event trigger with a target.
An abstract class to poll a BlockingQueue for events and defer them for handling.
Possible states of exclusivity for a RabbitMQ queue.
This is a ConfigurationProvider that reads from a local disk file.
Used to associate a class with a file extension or a set of file extensions.
An interface intended to be implemented by DataStores that support the concept of a unique filepath to each stored asset.
This is a simple DataStore that reads and writes files to and from a directory upon the file system.
A more complicated Event whereby a Future is obtainable in order to block/wait upon the result of it.
Utility app for generating configuration files.
Configuration for the liveness and readiness checks.
Indicates this object can report on its health.
A result returned from a class that implements HealthReporter, indicating its health status and if necessary, a message detailing
further information.
The overall, concise status of the health of a service.
A
DataStore that reads and writes files to and from a HTTP server.ManagedDataStore implementation for an In Memory Datastore which uses a HashMap.
Indicates that a job task identifier, used in job tracking, has an invalid format.
Indicates this task is fundamentally flawed in some manner, and is likely an error situation that would not be resolved through
retrying.
Implementation of a SecurityProvider that uses Jasypt to provide basic text encryption/decryption capabilities.
Decoder implementation that supports building objects from JavaScript.
Compatibility class to allow Jersey 1 libraries to co-exist with Jersey 2 apps, such as Dropwizard.
Indicates that a job has not been found.
Job status returned by the status check URL.
An implementation of CacheRequest supporting the caching of job status requests.
An implementation of CacheResponse supporting the caching of job status responses.
An implementation of ResponseCache supporting the caching of job status responses.
An implementation of SecureCacheResponse supporting the caching of job status responses.
Implementation of Codec that supports serialisation and deserialisation to and form JSON format.
Implementation of Codec that supports serialisation and deserialisation to and form JSON format that itself is compressed with a
high-speed LZF algorithm.
A DataStore with management methods for use within an application.
A WorkerQueue for use at an application level, supporting management methods.
Utility class that provides methods for finding and returning components at runtime using the Java ServiceLoader.
Thrown when there is a problem finding or instantiating a requested component.
Allows retrieval of a module based on the Interface that it implements and its simple name.
A class that is similar to java.naming.Name, but is iterable.
Pass-through module when no encryption/decryption is desired.
Provides pre-configured strict and lenient Jackson JSON ObjectMapper instances.
Provides pre-configured strict and lenient Jackson JSON ObjectMapper instances.
Provides a unique identifier representing the current process.
Provides access to properties requested during decoding.
A publish event for a class implementing the Publisher interface.
The basic RabbitMQ consumer-side API methods.
Builder pattern class to create queues with parameters and properties.
Thrown by classes related to WorkerQueue when a request cannot be handled.
Simplest possible RabbitMQ publishing API
Utility class for use with try-with-resources, for classes where the close operation may throw an exception, but this is not a useful
check.
General configuration for a RabbitMQ server connection from a client.
A basic framework for handling consumption of messages from a RabbitMQ queue.
CAF RabbitMQ headers
Utility wrapper methods for interacting with RabbitMQ.
This implementation uses a separate thread for a consumer and producer, each with their own Channel.
Configuration for the worker-queue-rabbit module.
Utility wrapper for allowing data to potentially be within a message or located on a remote DataStore.
Utility wrapper for allowing data to potentially be within a message or located on a remote DataStore.
Indicates the reference passed to the DataStore did not point to any resolvable location.
Provides in-memory caching of web responses on per-URI basis.
ManagedDataStore implementation for Amazon S3.
Provides access to secrets requested during decoding.
Simple object to store the service path, expected to be in the form /group/subgroup/id.
Thrown when the source reference is not found.
Provides bootstrap configuration from Java system properties and environment variables.
A callback interface used to announce the arrival of a new task for a worker to process or signal that the core should cancel its
tasks.
An unchecked exception to throw if a Worker fails its task in an unrecoverable way.
The generic task message class to be serialised from or to a queue.
Deprecated.
This interface is limited in the arguments the determineForwardingAction method takes, and the fact that it can only
return void.
Indicates that a task cannot be accepted right now, but that it should be retried at a later time.
Records information about the agent that initiated a task message.
The state of a worker thread upon termination.
Simple test worker used for testing the Worker Framework.
Holds fields used in tracking task messages, for Progress Reporting and Job Control.
Holds tracking report data.
Holds the tracked job task failure details in the event of an invalid task or exception.
Enumeration indicating how the tracked job task should be reported.
This task is used to report on the progress of a number of tracked job tasks.
A Worker can be constructed in any way as per suits the developer, but should only perform the bare minimum of tasks in the constructor
to set itself up to perform the computational work.
This is the main SaaS asynchronous micro-service worker entry point.
The callback interface for a task to report it is complete or that it must be subject to some further action, e.g.
Trivial ConnectionListener primarily to handle aborting in-progress tasks when the RabbitMQ connection is recovered - this is because
RabbitMQ will automatically re-queue the message when it detected our client dropped, and we don't want to produce a result for these
tasks running when the connection dropped to try and avoid duplicate results.
Thrown by classes related to Worker when a request cannot be handled.
Instantiates a new instance of a Worker given task-specific data.
The responsibility of a WorkerFactory is to provide a mechanism to generate new Worker objects and specify how many simultaneous
workers should be running.
A publisher that publishes to a specific queue and acknowledges another message subsequent to publishing.
A RabbitMQ publisher that uses a ConfirmListener, sending data as plain text with headers.
Event for publishing via a WorkerPublisher.
A general representation of a queue for the purposes of a worker service.
QueueConsumer implementation for a WorkerQueue.
Provides metrics for a WorkerQueue.
Boilerplate for retrieving a WorkerQueue implementation.
Object to represent a response from a Worker, to be interpreted by the core worker framework.
Provides access onto Worker Task Data and ability to set response.
Represents a task to be completed by the CAF Worker.