Index (worker-document-interface 5.1.1-1139 API)

A B C D F G H I L O P R S T U V

A

add(String, String) - Method in interface com.hpe.caf.worker.document.model.Failures: Adds the specified failure.
add(String, String, Throwable) - Method in interface com.hpe.caf.worker.document.model.Failures: Adds the specified failure.
add(String) - Method in interface com.hpe.caf.worker.document.model.Field: Adds the specified value to this field.
add(byte[]) - Method in interface com.hpe.caf.worker.document.model.Field: Adds the specified binary blob value to this field.
add() - Method in interface com.hpe.caf.worker.document.model.Scripts: Creates a new uninitialized customization script and appends it to the end of this list.
add(int) - Method in interface com.hpe.caf.worker.document.model.Scripts: Creates a new uninitialized customization script and inserts it at the specified position in this list.
add(String) - Method in interface com.hpe.caf.worker.document.model.Subdocuments: Creates a new subdocument and adds it to the collection.
addFailure(String, String) - Method in interface com.hpe.caf.worker.document.model.Document: Records the specified failure on the document.
addReference(String) - Method in interface com.hpe.caf.worker.document.model.Field: Associates data stored in the remote data store with this field.
Application - Interface in com.hpe.caf.worker.document.model: Represents the entire service.

B

BatchSizeController - Interface in com.hpe.caf.worker.document.model: Used for controlling the sizes of the batches passed to implementations of the BulkDocumentWorker interface.
BulkDocumentWorker - Interface in com.hpe.caf.worker.document.extensibility: The BulkDocumentWorker interface is designed to allow multiple documents to be processed together.

C

checkHealth(HealthMonitor) - Method in interface com.hpe.caf.worker.document.extensibility.DocumentWorker: This method provides an opportunity for the worker to report if it has any problems which would prevent it processing documents correctly.
clear() - Method in interface com.hpe.caf.worker.document.model.Failures: Removes all the failures in this collection.
clear() - Method in interface com.hpe.caf.worker.document.model.Field: Removes all values from this field.
close() - Method in interface com.hpe.caf.worker.document.extensibility.DocumentWorker: This method will be called when the worker is shutting down.
closeBatch() - Method in interface com.hpe.caf.worker.document.model.Documents: Draws this batch of documents to a close.
com.hpe.caf.worker.document.exceptions - package com.hpe.caf.worker.document.exceptions: This package contains exceptions which may be used by Document Worker implementations.
com.hpe.caf.worker.document.extensibility - package com.hpe.caf.worker.document.extensibility: This package contains a set of interfaces which may be implemented when developing a worker based on the Document Worker Framework.
com.hpe.caf.worker.document.model - package com.hpe.caf.worker.document.model: This package defines a set of objects which are made available by the Document Worker Framework.
createDocumentWorker(Application) - Method in interface com.hpe.caf.worker.document.extensibility.DocumentWorkerFactory: Constructs a new Document Worker.
currentSize() - Method in interface com.hpe.caf.worker.document.model.Documents: Returns the number of documents that are currently in this batch.

D

delete() - Method in interface com.hpe.caf.worker.document.model.Subdocument: Deletes this subdocument.
disable() - Method in interface com.hpe.caf.worker.document.model.ResponseQueue: Disables the response queue.
Document - Interface in com.hpe.caf.worker.document.model: Represents a document being processed.
Documents - Interface in com.hpe.caf.worker.document.model: Represents a batch of documents to be processed.
DocumentWorker - Interface in com.hpe.caf.worker.document.extensibility: This is the main interface that must be implemented by a Document Worker.
DocumentWorkerFactory - Interface in com.hpe.caf.worker.document.extensibility: When a Document Worker is initialised it will first look for an implementation of this interface (using the standard Java service loader).
DocumentWorkerObject - Interface in com.hpe.caf.worker.document.model: This is the base object of the Document Worker Object Model.
DocumentWorkerTransientException - Exception in com.hpe.caf.worker.document.exceptions: A DocumentWorkerTransientException indicates that a transient failure has occurred; the operation might be able to succeed if it is retried at a later time.
DocumentWorkerTransientException(String) - Constructor for exception com.hpe.caf.worker.document.exceptions.DocumentWorkerTransientException: Constructs a DocumentWorkerTransientException with a given reason.
DocumentWorkerTransientException(String, Throwable) - Constructor for exception com.hpe.caf.worker.document.exceptions.DocumentWorkerTransientException: Constructs a DocumentWorkerTransientException with a given reason and cause.
DocumentWorkerTransientException(Throwable) - Constructor for exception com.hpe.caf.worker.document.exceptions.DocumentWorkerTransientException: Constructs a DocumentWorkerTransientException with a given cause.

F

Failure - Interface in com.hpe.caf.worker.document.model: Represents a failure attached to the document.
Failures - Interface in com.hpe.caf.worker.document.model: Represents the collection of failures that are attached to a document.
Field - Interface in com.hpe.caf.worker.document.model: Represents a field of the document.
Fields - Interface in com.hpe.caf.worker.document.model: Represents the collection of fields that are attached to a document.
FieldValue - Interface in com.hpe.caf.worker.document.model: Represents one of the data values of a field.
FieldValues - Interface in com.hpe.caf.worker.document.model: Represents the collection of data values that belong to a field.

G

get(String) - Method in interface com.hpe.caf.worker.document.model.Fields: Gets a field object for the specified field.
get(String) - Method in interface com.hpe.caf.worker.document.model.ResponseCustomData: Used to retrieve any custom data that has been set on the response.
get(int) - Method in interface com.hpe.caf.worker.document.model.Scripts: Retrieves the script at the specified position in this list.
get(int) - Method in interface com.hpe.caf.worker.document.model.Subdocuments: Retrieves the subdocument at the specified position.
getApplication() - Method in interface com.hpe.caf.worker.document.model.DocumentWorkerObject: Returns the Application object, which represents the Document Worker itself.
getBatchSizeController() - Method in interface com.hpe.caf.worker.document.model.Application: Returns the batch size controller.
getCustomData(String) - Method in interface com.hpe.caf.worker.document.model.Document: Used to retrieve any custom data that was sent with the document, but which is not technically part of it.
getCustomData() - Method in interface com.hpe.caf.worker.document.model.Response: Returns an object which can be used to manipulate the custom data that will be sent as a part of the response.
getCustomData(String) - Method in interface com.hpe.caf.worker.document.model.Task: Used to retrieve any custom data that was sent with the task.
getDocument() - Method in interface com.hpe.caf.worker.document.model.Failure: Returns the document that this failure is associated with.
getDocument() - Method in interface com.hpe.caf.worker.document.model.Failures: Returns the document that this collection of failures is associated with.
getDocument() - Method in interface com.hpe.caf.worker.document.model.Field: Returns the document that this field is associated with.
getDocument() - Method in interface com.hpe.caf.worker.document.model.Fields: Returns the document that this collection of fields is associated with.
getDocument() - Method in interface com.hpe.caf.worker.document.model.Subdocuments: Returns the document that this collection of subdocuments is associated with.
getDocument() - Method in interface com.hpe.caf.worker.document.model.Task: Returns the document to be processed by this task.
getDocumentTasksAccepted() - Method in interface com.hpe.caf.worker.document.model.InputMessageProcessor: Returns whether input messages in the composite document message format are accepted.
getFailureId() - Method in interface com.hpe.caf.worker.document.model.Failure: Returns the non-localisable identifier related to the failure.
getFailureMessage() - Method in interface com.hpe.caf.worker.document.model.Failure: Returns a human readable message relating to the failure.
getFailureQueue() - Method in interface com.hpe.caf.worker.document.model.Response: Returns the queue that the response will be published to if any failures are newly added to the document or to any of its subdocuments.
getFailures() - Method in interface com.hpe.caf.worker.document.model.Document: Gets the collection of failures that are currently associated with the document.
getFailureStack() - Method in interface com.hpe.caf.worker.document.model.Failure: Returns the stack trace relating to the failure, or null if it was not recorded.
getField(String) - Method in interface com.hpe.caf.worker.document.model.Document: Gets a field object for the specified field.
getField() - Method in interface com.hpe.caf.worker.document.model.FieldValue: Returns the field that this field value is associated with.
getField() - Method in interface com.hpe.caf.worker.document.model.FieldValues: Returns the field that this collection of field values is associated with.
getFieldEnrichmentTasksAccepted() - Method in interface com.hpe.caf.worker.document.model.InputMessageProcessor: Returns whether input messages in the fields enrichment task message format are accepted.
getFields() - Method in interface com.hpe.caf.worker.document.model.Document: Gets the list of fields currently associated with the document.
getIndex() - Method in interface com.hpe.caf.worker.document.model.Script: Returns the current position of this customization script in the parent list.
getInputMessageProcessor() - Method in interface com.hpe.caf.worker.document.model.Application: Returns the input message processor.
getMaximumBatchSize() - Method in interface com.hpe.caf.worker.document.model.BatchSizeController: Gets the maximum number of documents that should be included in a batch before it is automatically closed.
getMaximumBatchTime() - Method in interface com.hpe.caf.worker.document.model.BatchSizeController: Gets the maximum length of time (in milliseconds) that a batch should be allowed to build up before it is automatically closed.
getName() - Method in interface com.hpe.caf.worker.document.model.Application: Returns the name of the worker, or null if the name of the worker is unknown.
getName() - Method in interface com.hpe.caf.worker.document.model.Field: Retrieves the name of the field.
getName() - Method in interface com.hpe.caf.worker.document.model.ResponseQueue: Returns the name of the response queue.
getName() - Method in interface com.hpe.caf.worker.document.model.Script: Returns the name of the customization script.
getObject() - Method in interface com.hpe.caf.worker.document.model.Script: This property allows for communication between scripts.
getParentDocument() - Method in interface com.hpe.caf.worker.document.model.Document: Returns the parent document of this document, or null if this document does not have a parent document.
getParentDocument() - Method in interface com.hpe.caf.worker.document.model.Subdocument: Returns the parent document of this subdocument.
getProcessSubdocumentsSeparately() - Method in interface com.hpe.caf.worker.document.model.InputMessageProcessor: Returns whether the worker's processDocument() method is called for each document in a hierarchy of documents, or whether it is only called for the root document of the document hierarchy.
getReference() - Method in interface com.hpe.caf.worker.document.model.Document: Returns the reference that is associated with the document.
getReference() - Method in interface com.hpe.caf.worker.document.model.FieldValue: If this field value is a reference (i.e.
getResponse() - Method in interface com.hpe.caf.worker.document.model.ResponseCustomData: Returns the response customization object that this custom data object is associated with.
getResponse() - Method in interface com.hpe.caf.worker.document.model.ResponseQueue: Returns the response customization object that this response queue object is associated with.
getResponse() - Method in interface com.hpe.caf.worker.document.model.Task: Returns an object which can be used to customise the response to the document processing task.
getRootDocument() - Method in interface com.hpe.caf.worker.document.model.Document: Returns the root document of this document's hierarchy.
getScript() - Method in interface com.hpe.caf.worker.document.model.Script: Retrieves the text of the script.
getScripts() - Method in interface com.hpe.caf.worker.document.model.Task: Gets the list of customization scripts associated with this task.
getService(Class<S>) - Method in interface com.hpe.caf.worker.document.model.Application: Returns the specified service, or null if the service has not been registered.
getService(Class<S>) - Method in interface com.hpe.caf.worker.document.model.ServiceLocator: Returns the specified service, or null if the service has not been registered.
getService(Class<S>) - Method in interface com.hpe.caf.worker.document.model.Task: Returns the specified task-level service, or null if the service has not been registered.
getServiceLocator() - Method in interface com.hpe.caf.worker.document.model.Application: Returns the service locator object.
getStringValue() - Method in interface com.hpe.caf.worker.document.model.FieldValue: Decodes the data assuming that it is a UTF-8 encoded string and returns it.
getStringValues() - Method in interface com.hpe.caf.worker.document.model.Field: Returns all the non-reference field values that contain valid UTF-8 encoded strings.
getSubdocuments() - Method in interface com.hpe.caf.worker.document.model.Document: Gets the list of subdocuments currently associated with the document.
getSuccessQueue() - Method in interface com.hpe.caf.worker.document.model.Response: Returns the queue that the response will be published to if it does not contain any new failures.
getTask() - Method in interface com.hpe.caf.worker.document.model.Document: Returns the task that is associated with the document.
getTask() - Method in interface com.hpe.caf.worker.document.model.Response: Returns the task that this response customization object is associated with.
getTask() - Method in interface com.hpe.caf.worker.document.model.Script: Returns the task that this customization script is associated with.
getTask() - Method in interface com.hpe.caf.worker.document.model.Scripts: Returns the task that this list of scripts is associated with.
getValue() - Method in interface com.hpe.caf.worker.document.model.FieldValue: Returns the data if the field value is not a reference (i.e.
getValues() - Method in interface com.hpe.caf.worker.document.model.Field: Returns a collection of all of the values that are currently associated with this field.
getVersion() - Method in interface com.hpe.caf.worker.document.model.Application: Returns the version of the worker, or null if the version of the worker is unknown.

H

hasChanges() - Method in interface com.hpe.caf.worker.document.model.Document: Returns true if the document has been modified from its original state.
hasChanges() - Method in interface com.hpe.caf.worker.document.model.Field: Returns true if the field has been modified from its original state.
hasSubdocuments() - Method in interface com.hpe.caf.worker.document.model.Document: Returns true if this document currently has any child subdocuments.
hasValues() - Method in interface com.hpe.caf.worker.document.model.Field: Returns true if this field has some values associated with it.
HealthMonitor - Interface in com.hpe.caf.worker.document.model: Used for reporting any health issues detected.

I

InputMessageProcessor - Interface in com.hpe.caf.worker.document.model: Used for controlling how messages that are received from the input queue are processed.
install() - Method in interface com.hpe.caf.worker.document.model.Script: Installs this customization script.
isBatchClosed() - Method in interface com.hpe.caf.worker.document.model.Documents: Returns whether or not this batch is closed.
isChanged() - Method in interface com.hpe.caf.worker.document.model.Failures: Returns true if this collection has been modified from its original state.
isDeleted() - Method in interface com.hpe.caf.worker.document.model.Subdocument: Returns true if the subdocument has been deleted.
isEmpty() - Method in interface com.hpe.caf.worker.document.model.Failures: Returns true if there are no failures in this collection.
isEmpty() - Method in interface com.hpe.caf.worker.document.model.FieldValues: Returns true if there are no field values in this collection.
isEmpty() - Method in interface com.hpe.caf.worker.document.model.Scripts: Returns true if there are no scripts in this list.
isEmpty() - Method in interface com.hpe.caf.worker.document.model.Subdocuments: Returns true if there are no subdocuments in this collection.
isEnabled() - Method in interface com.hpe.caf.worker.document.model.ResponseQueue: Returns true if the response queue is enabled.
isInstalled() - Method in interface com.hpe.caf.worker.document.model.Script: Checks whether this customization script is currently installed.
isLoaded() - Method in interface com.hpe.caf.worker.document.model.Script: Checks whether this customization script is currently loaded.
isReference() - Method in interface com.hpe.caf.worker.document.model.FieldValue: Returns true if the data is actually stored in the remote data store.
isStringValue() - Method in interface com.hpe.caf.worker.document.model.FieldValue: Checks if the field value data is a valid UTF-8 encoded string.

L

load() - Method in interface com.hpe.caf.worker.document.model.Script: Loads this customization script.

O

openInputStream() - Method in interface com.hpe.caf.worker.document.model.FieldValue: Opens an InputStream for the field value.

P

processDocument(Document) - Method in interface com.hpe.caf.worker.document.extensibility.DocumentWorker: Processes a single document.
processDocuments(Documents) - Method in interface com.hpe.caf.worker.document.extensibility.BulkDocumentWorker: Processes a batch of documents.
put(String, String) - Method in interface com.hpe.caf.worker.document.model.ResponseCustomData: Used to set custom data to be sent with the response.
putAll(Map<String, String>) - Method in interface com.hpe.caf.worker.document.model.ResponseCustomData: Used to set custom data to be sent with the response.

R

remove(String) - Method in interface com.hpe.caf.worker.document.model.ResponseCustomData: Removes a custom data value that has been set on the response.
reportUnhealthy(String) - Method in interface com.hpe.caf.worker.document.model.HealthMonitor: This method is used during a health check to report that a health issue has been detected with the worker.
reset() - Method in interface com.hpe.caf.worker.document.model.Document: Resets the document, and all of its subdocuments, back to its original state, undoing any modifications that have been made to the document.
reset() - Method in interface com.hpe.caf.worker.document.model.Failures: Resets this collection of failures back to its original state, undoing any changes made to it using the add() or clear() methods.
reset() - Method in interface com.hpe.caf.worker.document.model.Field: Resets the field back to its original state, undoing any changes made to it using the add() or clear() methods.
reset() - Method in interface com.hpe.caf.worker.document.model.Fields: Resets this collection of fields back to its original state, undoing any changes made to any of the fields in the collection.
reset() - Method in interface com.hpe.caf.worker.document.model.ResponseQueue: Resets the response queue back to its original state, undoing any changes made to it using the disable() or set() methods.
resetReference() - Method in interface com.hpe.caf.worker.document.model.Document: Resets the reference back to its original state, undoing any changes made to it using the setReference() method.
Response - Interface in com.hpe.caf.worker.document.model: Used for customizing the response to the document processing task.
ResponseCustomData - Interface in com.hpe.caf.worker.document.model: Represents the custom data that is sent as part of the response to the document processing task.
ResponseQueue - Interface in com.hpe.caf.worker.document.model: Used for managing the queue that response messages are published to.

S

Script - Interface in com.hpe.caf.worker.document.model: Represents a customization script which is attached to a task.
ScriptEngineType - Enum in com.hpe.caf.worker.document.model: Scripting engines supported by the Document Worker Framework.
Scripts - Interface in com.hpe.caf.worker.document.model: Represents the list of customization scripts which are attached to a task.
ServiceLocator - Interface in com.hpe.caf.worker.document.model: Used for caching and loading extra services that may be made available.
set(String) - Method in interface com.hpe.caf.worker.document.model.Field: Sets the value in this field.
set(byte[]) - Method in interface com.hpe.caf.worker.document.model.Field: Sets the binary blob value in this field.
set(String) - Method in interface com.hpe.caf.worker.document.model.ResponseQueue: Sets the response queue.
setDocumentTasksAccepted(boolean) - Method in interface com.hpe.caf.worker.document.model.InputMessageProcessor: Sets whether input messages in the composite document message format are accepted.
setFieldEnrichmentTasksAccepted(boolean) - Method in interface com.hpe.caf.worker.document.model.InputMessageProcessor: Sets whether input messages in the fields enrichment task message format are accepted.
setMaximumBatchSize(int) - Method in interface com.hpe.caf.worker.document.model.BatchSizeController: Sets the maximum number of documents that should be included in a batch before it is automatically closed.
setMaximumBatchTime(long) - Method in interface com.hpe.caf.worker.document.model.BatchSizeController: Sets the maximum length of time (in milliseconds) that a batch should be allowed to build up before it is automatically closed.
setName(String) - Method in interface com.hpe.caf.worker.document.model.Script: Sets the name of the customization script.
setProcessSubdocumentsSeparately(boolean) - Method in interface com.hpe.caf.worker.document.model.InputMessageProcessor: Sets whether the processDocument() method should be called for each subdocument in a document hierarchy in addition to being called for the root document of the hierarchy.
setReference(String) - Method in interface com.hpe.caf.worker.document.model.Document: Sets the reference that should be associated with the document.
setReference(String) - Method in interface com.hpe.caf.worker.document.model.Field: Sets the reference in this field to the data stored in the remote data store.
setScriptByReference(String) - Method in interface com.hpe.caf.worker.document.model.Script: Sets the customization script.
setScriptByReference(String, ScriptEngineType) - Method in interface com.hpe.caf.worker.document.model.Script: Sets the customization script.
setScriptByUrl(URL) - Method in interface com.hpe.caf.worker.document.model.Script: Sets the customization script.
setScriptByUrl(URL, ScriptEngineType) - Method in interface com.hpe.caf.worker.document.model.Script: Sets the customization script.
setScriptInline(String) - Method in interface com.hpe.caf.worker.document.model.Script: Sets the customization script.
setScriptInline(String, ScriptEngineType) - Method in interface com.hpe.caf.worker.document.model.Script: Sets the customization script.
size() - Method in interface com.hpe.caf.worker.document.model.Failures: Returns the number of failures in this collection.
size() - Method in interface com.hpe.caf.worker.document.model.FieldValues: Returns the number of field values in this collection.
size() - Method in interface com.hpe.caf.worker.document.model.Scripts: Returns the number of scripts in this list.
size() - Method in interface com.hpe.caf.worker.document.model.Subdocuments: Returns the number of subdocuments in this collection.
stream() - Method in interface com.hpe.caf.worker.document.model.Documents: Returns a sequential Stream with this document batch as its source.
stream() - Method in interface com.hpe.caf.worker.document.model.Failures: Returns a sequential Stream with this failures collection as its source.
stream() - Method in interface com.hpe.caf.worker.document.model.Fields: Returns a sequential Stream with this field collection as its source.
stream() - Method in interface com.hpe.caf.worker.document.model.FieldValues: Returns a sequential Stream with this field value collection as its source.
stream() - Method in interface com.hpe.caf.worker.document.model.Scripts: Returns a sequential Stream with this list of scripts as its source.
stream() - Method in interface com.hpe.caf.worker.document.model.Subdocuments: Returns a sequential Stream with this subdocuments collection as its source.
Subdocument - Interface in com.hpe.caf.worker.document.model: Represents a direct or indirect subdocument of the document being processed.
Subdocuments - Interface in com.hpe.caf.worker.document.model: Represents the list of subdocuments that are attached to a document.

T

Task - Interface in com.hpe.caf.worker.document.model: Represents the document processing task.

U

uninstall() - Method in interface com.hpe.caf.worker.document.model.Script: Uninstalls this customization script.
uninstallAll() - Method in interface com.hpe.caf.worker.document.model.Scripts: Uninstalls all of the scripts in this list.
unload() - Method in interface com.hpe.caf.worker.document.model.Script: Unloads this customization script.

V

valueOf(String) - Static method in enum com.hpe.caf.worker.document.model.ScriptEngineType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.hpe.caf.worker.document.model.ScriptEngineType: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D F G H I L O P R S T U V