A B C D E F G M P Q R S T V W

A

AbstractValidateApi - Class in com.github.cafdataprocessing.utilities.tasksubmitter.environment

Common methods for use when validating connection to external API's.

AbstractValidateApi() - Constructor for class com.github.cafdataprocessing.utilities.tasksubmitter.environment.AbstractValidateApi

B

BaseData() - Constructor for class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames.BaseData

BOILERPLATE_API_URL - Static variable in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames.BaseData

BOILERPLATE_BASE_DATA_INPUT_FILE - Static variable in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames.BaseData

BOILERPLATE_BASE_DATA_OUTPUT_FILE - Static variable in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames.BaseData

buildTaskMessageForDocument(Long, String, String) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage.TaskMessageBuilder

Constructs a task message for the document at specified path.

buildTaskMessagesForDirectory(Long, String, String) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage.TaskMessageBuilder

Constructs a task message for each file in the defined directory.

C

CLASSIFICATION_API_URL - Static variable in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames.BaseData

CLASSIFICATION_BASE_DATA_INPUT_FILE - Static variable in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames.BaseData

CLASSIFICATION_BASE_DATA_OUTPUT_FILE - Static variable in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames.BaseData

com.github.cafdataprocessing.utilities.tasksubmitter - package com.github.cafdataprocessing.utilities.tasksubmitter

com.github.cafdataprocessing.utilities.tasksubmitter.environment - package com.github.cafdataprocessing.utilities.tasksubmitter.environment

com.github.cafdataprocessing.utilities.tasksubmitter.monitor - package com.github.cafdataprocessing.utilities.tasksubmitter.monitor

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

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

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

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

CREATE_BOILERPLATE_BASE_DATA - Static variable in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames.BaseData

CREATE_CLASSIFICATION_BASE_DATA - Static variable in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames.BaseData

D

delayCall(String) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.environment.AbstractValidateApi

Delays thread progression.

DirectoryWatcher - Class in com.github.cafdataprocessing.utilities.tasksubmitter.monitor

Tasked with setting up a watch on a directory for new files and perform a provided action.

DirectoryWatcher() - Constructor for class com.github.cafdataprocessing.utilities.tasksubmitter.monitor.DirectoryWatcher

DOCUMENT_INPUT_DIRECTORY - Static variable in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames

DocumentAndFile - Class in com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage

Policy Document representation alongside the FileObject it represents.

DocumentAndFile(Document, FileObject) - Constructor for class com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage.DocumentAndFile

Create new instance for specified Document and associated FileObject.

DocumentsMover - Class in com.github.cafdataprocessing.utilities.tasksubmitter

Responsible for moving documents that have had task messages submitted.

DocumentsMover() - Constructor for class com.github.cafdataprocessing.utilities.tasksubmitter.DocumentsMover

E

EXTERNAL_API_READY_RETRY_ATTEMPTS - Static variable in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames.BaseData

F

FileAccessChecker - Class in com.github.cafdataprocessing.utilities.tasksubmitter

Used to verify that access can be obtained to a file at the current time.

FileAccessChecker() - Constructor for class com.github.cafdataprocessing.utilities.tasksubmitter.FileAccessChecker

FileAndTaskMessage - Class in com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage

Task Message and the File it represents

FileAndTaskMessage(FileObject, TaskMessage) - Constructor for class com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage.FileAndTaskMessage

Create new instance for specified FileObject and TaskMessage.

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

Provides access to filesystem storage configuration and operations.

G

getBoilerplateApiUrl() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties

getBoilerplateBaseDataInputFile() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties

getBoilerplateBaseDataOutputFile() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties

getClassificationApiUrl() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties

getClassificationBaseDataInputFile() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties

getClassificationBaseDataOutputFile() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties

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

getCreateBoilerplateBaseData() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties

getCreateClassificationBaseData() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties

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

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

getDocument() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage.DocumentAndFile

getDocument(String) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage.PolicyDocumentsBuilder

Constructs a Policy Worker Document with basic metadata for specified document path.

getDocumentInputDirectory() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties

getDocuments(String) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage.PolicyDocumentsBuilder

Constructs a list of Policy Worker Documents with basic metadata for each file filesToSendLocation directory.

getExternalApiRetryAttempts() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties

getFile() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage.DocumentAndFile

getFile() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage.FileAndTaskMessage

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

Retrieves the shared instance of FileSystemStorageServices.

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

getProcessingApiUrl() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties

getProjectId() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties

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

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

getSentDocumentsDirectory() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties

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

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

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

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

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

getTaskMessage() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage.FileAndTaskMessage

getTaskSubmitterProperties() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.services.Services

getWorkflowBaseDataFile() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties

getWorkflowId() - Method in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties

M

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

Main entry point for task submitter application, reading in arguments and performing application function

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

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

moveDocumentFromTaskMessage(FileAndTaskMessage, String, String) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.DocumentsMover

moveDocumentsFromTaskMessages(List<FileAndTaskMessage>, String, String) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.DocumentsMover

Moves the provided files to the destination folder.

P

PolicyDocumentsBuilder - Class in com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage

Tasked with providing Policy Documents representing provided folder or file location

PolicyDocumentsBuilder() - Constructor for class com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage.PolicyDocumentsBuilder

PROCESSING_API_URL - Static variable in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames.BaseData

PROJECT_ID - Static variable in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames

PropertyNames() - Constructor for class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames

publishAllMessages(List<FileAndTaskMessage>) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.services.QueueServices

publishMessage(FileAndTaskMessage) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.services.QueueServices

publishTaskMessagesForDirectory(String, Long, String, String) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage.TaskMessagePublisher

Constructs and publishes policy worker task messages for files in provided directory.

publishTaskMessagesForDirectoryAndMonitor(String, Long, String, String) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage.TaskMessagePublisher

Constructs and publishes policy worker task messages for files in provided directory.

Q

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

Initialises objects for communication with RabbitMQ and provides access to submit tasks to the queue through these.

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

R

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

S

SENT_DOCUMENTS_DIRECTORY - Static variable in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames

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

Provides access to commonly used components across application.

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

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

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

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

T

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

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

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

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

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

TaskMessageBuilder - Class in com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage

Utility Class that creates a Policy Worker TaskMessage for each document in the specified directory.

TaskMessageBuilder() - Constructor for class com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage.TaskMessageBuilder

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

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

TaskMessagePublisher - Class in com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage

Responsible for publishing task messages.

TaskMessagePublisher() - Constructor for class com.github.cafdataprocessing.utilities.tasksubmitter.taskmessage.TaskMessagePublisher

TaskSubmitterProperties - Class in com.github.cafdataprocessing.utilities.tasksubmitter.properties

Application specific properties such as input directory and workflow ID.

TaskSubmitterProperties() - Constructor for class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties

TaskSubmitterProperties.PropertyNames - Class in com.github.cafdataprocessing.utilities.tasksubmitter.properties

TaskSubmitterProperties.PropertyNames.BaseData - Class in com.github.cafdataprocessing.utilities.tasksubmitter.properties

V

validate(TaskSubmitterProperties) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.environment.ValidateBoilerplateProperties

Validate that properties specified are suitable for the application's boilerplate expression needs.

validate(TaskSubmitterProperties) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.environment.ValidateClassificationProperties

Validate that properties specified are suitable for the application's classification workflow needs.

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

Validate that properties set in the environment are suitable for the application's needs.

validate(TaskSubmitterProperties) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.environment.ValidateWorkflowProperties

Validate that properties specified are suitable for the application's processing workflow needs.

ValidateBoilerplateProperties - Class in com.github.cafdataprocessing.utilities.tasksubmitter.environment

Verification functionality for properties relating to boilerplate expressions and their usage in actions in processing workflows.

ValidateBoilerplateProperties() - Constructor for class com.github.cafdataprocessing.utilities.tasksubmitter.environment.ValidateBoilerplateProperties

ValidateClassificationProperties - Class in com.github.cafdataprocessing.utilities.tasksubmitter.environment

Verification functionality for properties relating to classification workflows and their usage in actions in processing workflows.

ValidateClassificationProperties() - Constructor for class com.github.cafdataprocessing.utilities.tasksubmitter.environment.ValidateClassificationProperties

ValidateEnvironment - Class in com.github.cafdataprocessing.utilities.tasksubmitter.environment

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

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

validateWorkflowBaseDataProperties(TaskSubmitterProperties) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.environment.ValidateWorkflowProperties

ValidateWorkflowProperties - Class in com.github.cafdataprocessing.utilities.tasksubmitter.environment

Verification functionality for processing workflow properties read in.

ValidateWorkflowProperties() - Constructor for class com.github.cafdataprocessing.utilities.tasksubmitter.environment.ValidateWorkflowProperties

verifyFileReadyForUse(FileObject) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.FileAccessChecker

Verifies that a file is ready for use e.g.

W

watchDirectoryForNewFiles(String, Consumer<FileObject>) - Static method in class com.github.cafdataprocessing.utilities.tasksubmitter.monitor.DirectoryWatcher

Watches a given directory for new files being added to it and when they are executes the provided function.

WORKFLOW_BASE_DATA_FILE - Static variable in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames.BaseData

WORKFLOW_ID - Static variable in class com.github.cafdataprocessing.utilities.tasksubmitter.properties.TaskSubmitterProperties.PropertyNames

A B C D E F G M P Q R S T V W