A C D F G I M O Q R S T V W

A

addMessageListener(MessageListener) - Static method in class com.github.cafdataprocessing.utilities.taskreceiver.services.QueueServices

attemptToDecodeNode(JsonNode, ObjectMapper, String) - Static method in class com.github.cafdataprocessing.utilities.taskreceiver.taskmessage.TaskDataDecoder

Attempts to decode a node with the provided name on the provided JsonNode from base64 to a string representation.

C

CLEANUP_DATASTORE_AFTER_PROCESSING - Static variable in class com.github.cafdataprocessing.utilities.taskreceiver.properties.TaskReceiverProperties

com.github.cafdataprocessing.utilities.taskreceiver - package com.github.cafdataprocessing.utilities.taskreceiver

com.github.cafdataprocessing.utilities.taskreceiver.messagehandling - package com.github.cafdataprocessing.utilities.taskreceiver.messagehandling

com.github.cafdataprocessing.utilities.taskreceiver.properties - package com.github.cafdataprocessing.utilities.taskreceiver.properties

com.github.cafdataprocessing.utilities.taskreceiver.services - package com.github.cafdataprocessing.utilities.taskreceiver.services

com.github.cafdataprocessing.utilities.taskreceiver.taskmessage - package com.github.cafdataprocessing.utilities.taskreceiver.taskmessage

com.github.cafdataprocessing.utilities.taskreceiver.taskoutput - package com.github.cafdataprocessing.utilities.taskreceiver.taskoutput

CONTEXT - Static variable in class com.github.cafdataprocessing.utilities.taskreceiver.taskmessage.TaskMessageConstants

createFolderFromDocument(SharedDocument, String) - Method in class com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.OutputHelper

Makes and returns the appropriate folder to output the provided document to.

createFolderFromTaskMessageId(TaskMessage, String) - Method in class com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.OutputHelper

Creates a folder in the specified directory, using the ID of the provided task message.

D

decodeTaskData(JsonNode, ObjectMapper) - Static method in class com.github.cafdataprocessing.utilities.taskreceiver.taskmessage.TaskDataDecoder

Replaces a base64 encoded taskData node on provided node with the decoded version on the provided JsonNode object.

determineSubDocumentFolder(SharedDocument) - Static method in class com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.SubDocumentHelper

Determines the appropriate folder path to output data about a sub document to.

F

FileNameHelper - Class in com.github.cafdataprocessing.utilities.taskreceiver.taskoutput

Provides facilities to determine file names to use for documents.

FileNameHelper() - Constructor for class com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.FileNameHelper

FileSystemStorageServices - Class in com.github.cafdataprocessing.utilities.taskreceiver.services

Provides access to filesystem storage configuration and operations.

G

getCleanupDataStoreAfterProcessing() - Method in class com.github.cafdataprocessing.utilities.taskreceiver.properties.TaskReceiverProperties

getCodec() - Method in class com.github.cafdataprocessing.utilities.taskreceiver.services.Services

getDataDirectory() - Method in class com.github.cafdataprocessing.utilities.taskreceiver.properties.StorageProperties

getDataStore() - Method in class com.github.cafdataprocessing.utilities.taskreceiver.services.FileSystemStorageServices

getDocumentOutputFilename(SharedDocument) - Static method in class com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.FileNameHelper

Gets a name to use for the output file representing the original document passed in.

getInstance() - Static method in class com.github.cafdataprocessing.utilities.taskreceiver.services.FileSystemStorageServices

Retrieves the shared instance of FileSystemStorageServices.

getInstance() - Static method in class com.github.cafdataprocessing.utilities.taskreceiver.services.Services

getIsSaveTaskDataOnly() - Method in class com.github.cafdataprocessing.utilities.taskreceiver.properties.TaskReceiverProperties

getMetadataRefOutputFilename(Map.Entry<String, ReferencedData>) - Static method in class com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.FileNameHelper

Gets a file name to use for the provided metadata reference

getOutputDirectory() - Method in class com.github.cafdataprocessing.utilities.taskreceiver.properties.TaskReceiverProperties

getQueues() - Method in class com.github.cafdataprocessing.utilities.taskreceiver.messagehandling.MessageListenerImpl

getRabbitConfiguration() - Method in class com.github.cafdataprocessing.utilities.taskreceiver.services.Services

getRabbitProperties() - Method in class com.github.cafdataprocessing.utilities.taskreceiver.services.Services

getRawTaskMessageFilename() - Static method in class com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.FileNameHelper

Gets the name to give the file containing the raw task message as retrieved from the queue.

getStorageConfiguration() - Method in class com.github.cafdataprocessing.utilities.taskreceiver.services.FileSystemStorageServices

getStorageConfiguration() - Method in class com.github.cafdataprocessing.utilities.taskreceiver.services.Services

getStorageDataStore() - Method in class com.github.cafdataprocessing.utilities.taskreceiver.services.Services

getStorageProperties() - Method in class com.github.cafdataprocessing.utilities.taskreceiver.services.FileSystemStorageServices

getStorageProperties() - Method in class com.github.cafdataprocessing.utilities.taskreceiver.services.Services

getTaskMessageFilename() - Static method in class com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.FileNameHelper

Gets the name to give the file containing the user-friendly version of the task message.

getTaskReceiverProperties() - Method in class com.github.cafdataprocessing.utilities.taskreceiver.services.Services

I

isSubDocument(SharedDocument) - Static method in class com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.SubDocumentHelper

Determines if a provided document is a sub-document.

M

Main - Class in com.github.cafdataprocessing.utilities.taskreceiver

Entry point for running the task receiver application.

Main() - Constructor for class com.github.cafdataprocessing.utilities.taskreceiver.Main

main(String[]) - Static method in class com.github.cafdataprocessing.utilities.taskreceiver.Main

MessageListenerImpl - Class in com.github.cafdataprocessing.utilities.taskreceiver.messagehandling

Message listener implementation that sends received message to task writer so it may be output to disk.

MessageListenerImpl() - Constructor for class com.github.cafdataprocessing.utilities.taskreceiver.messagehandling.MessageListenerImpl

messageReceived(TaskMessage) - Method in class com.github.cafdataprocessing.utilities.taskreceiver.messagehandling.MessageListenerImpl

O

OUTPUT_DIRECTORY_PROP_NAME - Static variable in class com.github.cafdataprocessing.utilities.taskreceiver.properties.TaskReceiverProperties

OutputHelper - Class in com.github.cafdataprocessing.utilities.taskreceiver.taskoutput

Provides methods to output data to the storage medium.

OutputHelper() - Constructor for class com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.OutputHelper

outputStream(String, String, InputStream) - Method in class com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.OutputHelper

Outputs provided input stream to a specified file in the destination provided.

outputString(String, String, String) - Method in class com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.OutputHelper

Outputs provided string content to a specified file in the destination provided.

Q

QueueServices - Class in com.github.cafdataprocessing.utilities.taskreceiver.services

Initialises objects for communication with RabbitMQ and provides access to receive tasks from the queue.

QueueServices() - Constructor for class com.github.cafdataprocessing.utilities.taskreceiver.services.QueueServices

R

run() - Method in class com.github.cafdataprocessing.utilities.taskreceiver.Main

S

sanitizeForFilesystem(String) - Static method in class com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.FileNameHelper

Replaces illegal filesystem characters in provided string with '_'.

SAVE_TASK_DATA_ONLY - Static variable in class com.github.cafdataprocessing.utilities.taskreceiver.properties.TaskReceiverProperties

Services - Class in com.github.cafdataprocessing.utilities.taskreceiver.services

Provides access to commonly used components across application.

shutdown() - Static method in class com.github.cafdataprocessing.utilities.taskreceiver.services.QueueServices

StorageProperties - Class in com.github.cafdataprocessing.utilities.taskreceiver.properties

Properties relevant to using worker-store implementation to store/retrieve files.

StorageProperties() - Constructor for class com.github.cafdataprocessing.utilities.taskreceiver.properties.StorageProperties

SubDocumentHelper - Class in com.github.cafdataprocessing.utilities.taskreceiver.taskoutput

Contains methods for assisting in the output of sub-documents.

SubDocumentHelper() - Constructor for class com.github.cafdataprocessing.utilities.taskreceiver.taskoutput.SubDocumentHelper

T

TASK_API_VERSION - Static variable in class com.github.cafdataprocessing.utilities.taskreceiver.taskmessage.TaskMessageConstants

TASK_CLASSIFIER - Static variable in class com.github.cafdataprocessing.utilities.taskreceiver.taskmessage.TaskMessageConstants

TASK_DATA - Static variable in class com.github.cafdataprocessing.utilities.taskreceiver.taskmessage.TaskMessageConstants

TASK_ID - Static variable in class com.github.cafdataprocessing.utilities.taskreceiver.taskmessage.TaskMessageConstants

TASK_STATUS - Static variable in class com.github.cafdataprocessing.utilities.taskreceiver.taskmessage.TaskMessageConstants

TaskDataDecoder - Class in com.github.cafdataprocessing.utilities.taskreceiver.taskmessage

Decode methods tied to task data.

TaskDataDecoder() - Constructor for class com.github.cafdataprocessing.utilities.taskreceiver.taskmessage.TaskDataDecoder

TaskMessageConstants - Class in com.github.cafdataprocessing.utilities.taskreceiver.taskmessage

// the constant here reflect the properties used within the existing com.hpe.caf.api.worker.TaskMessage;

TaskMessageConstants() - Constructor for class com.github.cafdataprocessing.utilities.taskreceiver.taskmessage.TaskMessageConstants

TaskMessageWriter - Class in com.github.cafdataprocessing.utilities.taskreceiver.taskmessage

Class responsible for output of task messages.

TaskMessageWriter(String, ManagedDataStore, OutputHelper, boolean, boolean) - Constructor for class com.github.cafdataprocessing.utilities.taskreceiver.taskmessage.TaskMessageWriter

Constructs a TaskMessageWriter that will use provided parameters.

TaskReceiverProperties - Class in com.github.cafdataprocessing.utilities.taskreceiver.properties

Properties specific to this application.

TaskReceiverProperties() - Constructor for class com.github.cafdataprocessing.utilities.taskreceiver.properties.TaskReceiverProperties

V

validate() - Static method in class com.github.cafdataprocessing.utilities.taskreceiver.ValidateEnvironment

Validates the application environment is valid to run in e.g.

ValidateEnvironment - Class in com.github.cafdataprocessing.utilities.taskreceiver

Validates that the environment the application is running in is correct.

ValidateEnvironment() - Constructor for class com.github.cafdataprocessing.utilities.taskreceiver.ValidateEnvironment

W

writeMessage(TaskMessage) - Method in class com.github.cafdataprocessing.utilities.taskreceiver.taskmessage.TaskMessageWriter

Writes out details about the provided task message.

A C D F G I M O Q R S T V W