Index (Digital Collections Workflow Engine 0.5.0 API)

A B C D E F G H J M O P R S T U V W

A

ack(Message) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBroker: Acknowledges a message to remove it from the queue.
addFailurePolicy(FailurePolicy) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBrokerBuilder
apply(T) - Method in class de.digitalcollections.workflow.engine.flow.WriterAdapter

B

build() - Method in class de.digitalcollections.workflow.engine.flow.FlowBuilder: Finally builds the flow.
build() - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBrokerBuilder: Finally builds the MessageBroker as configured, up and running and connected it to RabbitMQ.

C

ConnectionConfig - Interface in de.digitalcollections.workflow.engine.messagebroker
connectTo(String) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBrokerBuilder
connectTo(String, int) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBrokerBuilder: Adds an RabbitMQ host to connect to.

D

de.digitalcollections.workflow.engine - package de.digitalcollections.workflow.engine
de.digitalcollections.workflow.engine.exceptions - package de.digitalcollections.workflow.engine.exceptions
de.digitalcollections.workflow.engine.flow - package de.digitalcollections.workflow.engine.flow
de.digitalcollections.workflow.engine.jackson - package de.digitalcollections.workflow.engine.jackson
de.digitalcollections.workflow.engine.messagebroker - package de.digitalcollections.workflow.engine.messagebroker
de.digitalcollections.workflow.engine.model - package de.digitalcollections.workflow.engine.model
de.digitalcollections.workflow.engine.reporting - package de.digitalcollections.workflow.engine.reporting
de.digitalcollections.workflow.engine.util - package de.digitalcollections.workflow.engine.util
deadLetterExchange(String) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBrokerBuilder: Sets the AMQP dead letter exchange (optional, defaults to 'workflow.dlx').
deadLetterWait(int) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBrokerBuilder: Sets the time to wait for dead-lettered messages before these are returned to the queue.
DefaultMessage - Class in de.digitalcollections.workflow.engine.model
DefaultMessage() - Constructor for class de.digitalcollections.workflow.engine.model.DefaultMessage
DefaultMessage(String) - Constructor for class de.digitalcollections.workflow.engine.model.DefaultMessage
DefaultMessageMixin - Interface in de.digitalcollections.workflow.engine.jackson
DefaultProcessReport - Class in de.digitalcollections.workflow.engine.reporting
DefaultProcessReport() - Constructor for class de.digitalcollections.workflow.engine.reporting.DefaultProcessReport

E

Engine - Class in de.digitalcollections.workflow.engine: Run flows Flow for every message from the MessageBroker - usually several in parallel.
Engine(MessageBroker, Flow) - Constructor for class de.digitalcollections.workflow.engine.Engine: Creates a new Engine instance with concurrent workers.
Engine(MessageBroker, Flow, int) - Constructor for class de.digitalcollections.workflow.engine.Engine: Creates a new Engine instance with a fixed number of concurrent workers.
Engine(MessageBroker, Flow, int, ProcessReport) - Constructor for class de.digitalcollections.workflow.engine.Engine: Creates a new Engine instance with a fixed number of concurrent workers.
Engine(MessageBroker, Flow, ProcessReport) - Constructor for class de.digitalcollections.workflow.engine.Engine: Creates a new Engine instance with a customized process report.
EngineStats - Class in de.digitalcollections.workflow.engine
EngineStats(int, int, int) - Constructor for class de.digitalcollections.workflow.engine.EngineStats
Envelope - Class in de.digitalcollections.workflow.engine.model: Technical metadata all implementations of Message must have.
Envelope() - Constructor for class de.digitalcollections.workflow.engine.model.Envelope: Default constructor setting the Envelope.timestamp to now.
EnvelopeMixin - Interface in de.digitalcollections.workflow.engine.jackson
exchange(String) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBrokerBuilder: Sets the AMQP exchange (optional, defaults to 'workflow').

F

fail(Message) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBroker
FailurePolicy - Class in de.digitalcollections.workflow.engine.messagebroker
FailurePolicy(String) - Constructor for class de.digitalcollections.workflow.engine.messagebroker.FailurePolicy
FailurePolicy(String, int) - Constructor for class de.digitalcollections.workflow.engine.messagebroker.FailurePolicy
FailurePolicy(String, String, String, int) - Constructor for class de.digitalcollections.workflow.engine.messagebroker.FailurePolicy
FinallyFailedProcessException - Exception in de.digitalcollections.workflow.engine.exceptions
FinallyFailedProcessException(String) - Constructor for exception de.digitalcollections.workflow.engine.exceptions.FinallyFailedProcessException
FinallyFailedProcessException(String, Throwable) - Constructor for exception de.digitalcollections.workflow.engine.exceptions.FinallyFailedProcessException
FinallyFailedProcessException(Throwable) - Constructor for exception de.digitalcollections.workflow.engine.exceptions.FinallyFailedProcessException
Flow<M extends Message,R,W> - Class in de.digitalcollections.workflow.engine.flow: Recipe for the data processing.
Flow(Supplier<Function<M, R>>, Supplier<Function<R, W>>, Supplier<Function<W, Collection<? extends Message>>>, Supplier<Consumer<W>>) - Constructor for class de.digitalcollections.workflow.engine.flow.Flow
FlowBuilder<M extends Message,R,W> - Class in de.digitalcollections.workflow.engine.flow: Builder to create the Flow to process the data using an Engine.
FlowBuilder() - Constructor for class de.digitalcollections.workflow.engine.flow.FlowBuilder

G

get(String) - Method in class de.digitalcollections.workflow.engine.model.DefaultMessage
getActiveWorkers() - Method in class de.digitalcollections.workflow.engine.EngineStats
getAddresses() - Method in interface de.digitalcollections.workflow.engine.messagebroker.ConnectionConfig
getAvailableWorkers() - Method in class de.digitalcollections.workflow.engine.EngineStats
getBody() - Method in interface de.digitalcollections.workflow.engine.jackson.DefaultMessageMixin
getBody() - Method in interface de.digitalcollections.workflow.engine.jackson.EnvelopeMixin
getBody() - Method in class de.digitalcollections.workflow.engine.model.Envelope: The original String representation before serializing into an Message instance.
getConcurrentWorkers() - Method in class de.digitalcollections.workflow.engine.EngineStats
getConfig() - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBroker
getData() - Method in class de.digitalcollections.workflow.engine.model.DefaultMessage
getDeadLetterExchange() - Method in interface de.digitalcollections.workflow.engine.messagebroker.RoutingConfig
getDeadLetterWait() - Method in interface de.digitalcollections.workflow.engine.messagebroker.MessageBrokerConfig
getDeliveryTag() - Method in interface de.digitalcollections.workflow.engine.jackson.DefaultMessageMixin
getDeliveryTag() - Method in interface de.digitalcollections.workflow.engine.jackson.EnvelopeMixin
getDeliveryTag() - Method in class de.digitalcollections.workflow.engine.model.Envelope: The delivery tag set by RabbitMQ for low level message handling.
getEnvelope() - Method in class de.digitalcollections.workflow.engine.model.DefaultMessage
getEnvelope() - Method in interface de.digitalcollections.workflow.engine.model.Message: Technical metadata like timestamps and retries.
getExchange() - Method in interface de.digitalcollections.workflow.engine.messagebroker.RoutingConfig
getFailedRoutingKey() - Method in class de.digitalcollections.workflow.engine.messagebroker.FailurePolicy
getFailurePolicy(Message) - Method in interface de.digitalcollections.workflow.engine.messagebroker.RoutingConfig
getFailurePolicy(String) - Method in interface de.digitalcollections.workflow.engine.messagebroker.RoutingConfig
getId() - Method in class de.digitalcollections.workflow.engine.model.DefaultMessage
getId() - Method in interface de.digitalcollections.workflow.engine.model.Message: The optional ID can hold the identifier of an corresponding object (e.g. a book to be indexed).
getInputQueue() - Method in class de.digitalcollections.workflow.engine.messagebroker.FailurePolicy
getJacksonModules() - Method in interface de.digitalcollections.workflow.engine.messagebroker.MessageBrokerConfig
getMaxRetries() - Method in class de.digitalcollections.workflow.engine.messagebroker.FailurePolicy
getMaxRetries() - Method in interface de.digitalcollections.workflow.engine.messagebroker.MessageBrokerConfig
getMessage() - Method in class de.digitalcollections.workflow.engine.model.Job
getMessageClass() - Method in interface de.digitalcollections.workflow.engine.messagebroker.MessageBrokerConfig
getPassword() - Method in interface de.digitalcollections.workflow.engine.messagebroker.ConnectionConfig
getReadFrom() - Method in interface de.digitalcollections.workflow.engine.messagebroker.RoutingConfig
getResult() - Method in class de.digitalcollections.workflow.engine.model.Job
getRetries() - Method in class de.digitalcollections.workflow.engine.model.Envelope: Gets the number of retries before a message is sent to the failed queue.
getRetryRoutingKey() - Method in class de.digitalcollections.workflow.engine.messagebroker.FailurePolicy
getSource() - Method in class de.digitalcollections.workflow.engine.model.Envelope: Gets the queue name where this message was received from.
getStats() - Method in class de.digitalcollections.workflow.engine.Engine
getTimestamp() - Method in class de.digitalcollections.workflow.engine.model.Envelope: Gets the timestamp when the Message was created.
getUsername() - Method in interface de.digitalcollections.workflow.engine.messagebroker.ConnectionConfig
getVirtualHost() - Method in interface de.digitalcollections.workflow.engine.messagebroker.ConnectionConfig
getWriteTo() - Method in interface de.digitalcollections.workflow.engine.messagebroker.RoutingConfig

H

hasMessagesToSend() - Method in class de.digitalcollections.workflow.engine.flow.Flow
hasWriteTo() - Method in interface de.digitalcollections.workflow.engine.messagebroker.RoutingConfig

J

jacksonModules(Module...) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBrokerBuilder: Registers Jackson Modules to use with the object mapper.
Job<M,R,W> - Class in de.digitalcollections.workflow.engine.model
Job(M) - Constructor for class de.digitalcollections.workflow.engine.model.Job

M

Maps - Class in de.digitalcollections.workflow.engine.util
Maps() - Constructor for class de.digitalcollections.workflow.engine.util.Maps
maxRetries(int) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBrokerBuilder: Sets the maximum number of attempts before a message is sent to the failed queue instead of the dead letter queue.
Message<ID> - Interface in de.digitalcollections.workflow.engine.model: A generic message as it will be sent over RabbitMQ.
MessageBroker - Class in de.digitalcollections.workflow.engine.messagebroker: A MessageBroker provides a high level API to interact with an MessageBroker like RabbitMQ and provides the framework engines logic for message operations like sending, retrieving or rejecting for messages.
MessageBrokerBuilder - Class in de.digitalcollections.workflow.engine.messagebroker: Builder to create an instance of the MessageBroker which manages the connection to RabbitMQ and all related configuration and setups like creating queues and exchanges.
MessageBrokerBuilder() - Constructor for class de.digitalcollections.workflow.engine.messagebroker.MessageBrokerBuilder
MessageBrokerConfig - Interface in de.digitalcollections.workflow.engine.messagebroker
messageMapping(Class<? extends Message>, Class<?>) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBrokerBuilder: Sets a Jackson mixin for a custom message implementation.

O

of(K, V) - Static method in class de.digitalcollections.workflow.engine.util.Maps
of(K, V, K, V) - Static method in class de.digitalcollections.workflow.engine.util.Maps

P

password(String) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBrokerBuilder: Sets the RabbitMQ password for authentication.
process(M) - Method in class de.digitalcollections.workflow.engine.flow.Flow
ProcessReport - Interface in de.digitalcollections.workflow.engine.reporting
put(String, String) - Method in class de.digitalcollections.workflow.engine.model.DefaultMessage
put(Map<String, String>) - Method in class de.digitalcollections.workflow.engine.model.DefaultMessage

R

read(Function<M, R>) - Method in class de.digitalcollections.workflow.engine.flow.FlowBuilder: Sets the reader for this flow.
read(Function<M, R>) - Method in class de.digitalcollections.workflow.engine.model.Job
read(Supplier<Function<M, R>>) - Method in class de.digitalcollections.workflow.engine.flow.FlowBuilder: Sets a reader factory for this flow which creates a new reader for every processed message.
readFrom(String...) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBrokerBuilder: The queues to read from.
receive() - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBroker: Gets one message from the input queue but does not acknowledge it.
receive(String) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBroker: Gets one message from the queue but does not acknowledge it.
receiving(Class<M>) - Static method in class de.digitalcollections.workflow.engine.flow.FlowBuilder
reject(Message) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBroker: Rejects a messaging and takes care of proper dead lettering, retries and, if the message failed too often, routing to the failed queue.
reportFail(Message, FinallyFailedProcessException) - Method in class de.digitalcollections.workflow.engine.reporting.DefaultProcessReport
reportFail(Message, FinallyFailedProcessException) - Method in interface de.digitalcollections.workflow.engine.reporting.ProcessReport: Report a failed (finally failed) message
reportFailAfterMaxRetries(Message, Exception) - Method in class de.digitalcollections.workflow.engine.reporting.DefaultProcessReport
reportFailAfterMaxRetries(Message, Exception) - Method in interface de.digitalcollections.workflow.engine.reporting.ProcessReport: Report a failed message, which failed after the maximum number of retries
reportReject(Message, Exception) - Method in class de.digitalcollections.workflow.engine.reporting.DefaultProcessReport
reportReject(Message, Exception) - Method in interface de.digitalcollections.workflow.engine.reporting.ProcessReport: Report a rejected (temporarily failed) message
reportSuccess(Message) - Method in class de.digitalcollections.workflow.engine.reporting.DefaultProcessReport
reportSuccess(Message) - Method in interface de.digitalcollections.workflow.engine.reporting.ProcessReport: Report a successfully handled message
RetriableProcessException - Exception in de.digitalcollections.workflow.engine.exceptions
RetriableProcessException(String) - Constructor for exception de.digitalcollections.workflow.engine.exceptions.RetriableProcessException
RetriableProcessException(Throwable) - Constructor for exception de.digitalcollections.workflow.engine.exceptions.RetriableProcessException
RoutingConfig - Interface in de.digitalcollections.workflow.engine.messagebroker

S

send(Message) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBroker: Sends a message to the default output queue as JSON document.
send(String, Message) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBroker: Sends a message to a certain queue as JSON document.
send(String, Collection<Message>) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBroker: Sends multiple messages to a certain queue as JSON documents.
setBody(String) - Method in class de.digitalcollections.workflow.engine.model.Envelope: The original String representation before serializing into an Message instance.
setData(Map<String, String>) - Method in class de.digitalcollections.workflow.engine.model.DefaultMessage
setDeliveryTag(long) - Method in class de.digitalcollections.workflow.engine.model.Envelope: The delivery tag set by RabbitMQ for low level message handling.
setRetries(int) - Method in class de.digitalcollections.workflow.engine.model.Envelope: Sets the number of retries before a message is sent to the failed queue.
setSource(String) - Method in class de.digitalcollections.workflow.engine.model.Envelope: Gets the queue name where this message was received from.
setTimestamp(LocalDateTime) - Method in class de.digitalcollections.workflow.engine.model.Envelope: Sets the timestamp when the Message was created.
SingleClassModule - Class in de.digitalcollections.workflow.engine.jackson
SingleClassModule(Class<?>, Class<?>) - Constructor for class de.digitalcollections.workflow.engine.jackson.SingleClassModule
start() - Method in class de.digitalcollections.workflow.engine.Engine: Starts processing messages until Engine.stop() is called.
stop() - Method in class de.digitalcollections.workflow.engine.Engine: Stops processing new messages or waiting for new messages to arrive.

T

toString() - Method in class de.digitalcollections.workflow.engine.model.DefaultMessage
toString() - Method in class de.digitalcollections.workflow.engine.model.Envelope
transform(Function<R, W>) - Method in class de.digitalcollections.workflow.engine.flow.FlowBuilder: Sets the transformer for this flow.
transform(Function<R, W>) - Method in class de.digitalcollections.workflow.engine.model.Job
transform(Supplier<Function<R, W>>) - Method in class de.digitalcollections.workflow.engine.flow.FlowBuilder: Sets the transformer factory for this flow which creates a new transformer for every processed message.

U

username(String) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBrokerBuilder: Sets the RabbitMQ username for authentication.

V

virtualHost(String) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBrokerBuilder: Sets the internal RabbitMQ virtualHost (default is "\").

W

WorkflowSetupException - Exception in de.digitalcollections.workflow.engine.exceptions: This exception is thrown when the workflow cannot be started because of configuration issues.
WorkflowSetupException(String) - Constructor for exception de.digitalcollections.workflow.engine.exceptions.WorkflowSetupException
WorkflowSetupException(Throwable) - Constructor for exception de.digitalcollections.workflow.engine.exceptions.WorkflowSetupException
write(Consumer<W>) - Method in class de.digitalcollections.workflow.engine.flow.FlowBuilder
write(Consumer<W>) - Method in class de.digitalcollections.workflow.engine.model.Job
write(Function<W, Collection<? extends Message>>) - Method in class de.digitalcollections.workflow.engine.model.Job
write(Supplier<Consumer<W>>) - Method in class de.digitalcollections.workflow.engine.flow.FlowBuilder
writeAndSend(Function<W, Message>) - Method in class de.digitalcollections.workflow.engine.flow.FlowBuilder: Sets output queue and writer for this flow.
writeAndSend(Supplier<Function<W, Message>>) - Method in class de.digitalcollections.workflow.engine.flow.FlowBuilder: Sets writer factory for this flow which creates a new writer for every processed message.
writeAndSendMany(Function<W, Collection<? extends Message>>) - Method in class de.digitalcollections.workflow.engine.flow.FlowBuilder: Sets output queue and writer for this flow.
writeAndSendMany(Supplier<Function<W, Collection<? extends Message>>>) - Method in class de.digitalcollections.workflow.engine.flow.FlowBuilder: Sets writer factory for this flow which creates a new writer for every processed message.
WriterAdapter<T> - Class in de.digitalcollections.workflow.engine.flow
WriterAdapter(Function<T, Message>) - Constructor for class de.digitalcollections.workflow.engine.flow.WriterAdapter
writeTo(String) - Method in class de.digitalcollections.workflow.engine.messagebroker.MessageBrokerBuilder

A B C D E F G H J M O P R S T U V W