com.hpe.caf.worker.document.tasks

Class AbstractTask

java.lang.Object

com.hpe.caf.worker.document.impl.DocumentWorkerObjectImpl

com.hpe.caf.worker.document.tasks.AbstractTask

All Implemented Interfaces:

DocumentWorkerObject, Task

Direct Known Subclasses:

DocumentTask, FieldEnrichmentTask

public abstract class AbstractTask
extends DocumentWorkerObjectImpl
implements Task

Field Summary

Fields

Modifier and Type	Field and Description
protected DocumentImpl	document
protected ResponseImpl	response
protected ScriptsImpl	scripts

Fields inherited from class com.hpe.caf.worker.document.impl.DocumentWorkerObjectImpl

application

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTask(ApplicationImpl application, com.hpe.caf.api.worker.WorkerTaskData workerTask, ReadOnlyDocument effectiveDocument, Map<String,String> customData)
protected	AbstractTask(ApplicationImpl application, com.hpe.caf.api.worker.WorkerTaskData workerTask, ReadOnlyDocument effectiveDocument, Map<String,String> customData, List<DocumentWorkerScript> scripts)

Method Summary

Modifier and Type	Method and Description
com.hpe.caf.api.worker.WorkerResponse	createWorkerResponse()
protected abstract com.hpe.caf.api.worker.WorkerResponse	createWorkerResponseImpl()
String	getCustomData(String dataKey)
DocumentImpl	getDocument()
Response	getResponse()
ScriptsImpl	getScripts()
<S> S	getService(Class<S> service)
com.hpe.caf.api.worker.WorkerResponse	handleGeneralFailure(Throwable failure) Returns appropriate WorkerResponse for the task in the event of a general task failure.
protected abstract com.hpe.caf.api.worker.WorkerResponse	handleGeneralFailureImpl(Throwable failure)
void	loadScripts() Load the customization scripts and if there is an exception then try to determine if it is a transient issue.
void	raiseAfterProcessDocumentEvent(Document document)
void	raiseAfterProcessTaskEvent()
boolean	raiseBeforeProcessDocumentEvent(Document document)
boolean	raiseOnErrorEvent(RuntimeException ex)
void	raiseProcessDocumentEvent(Document document)
void	raiseProcessTaskEvent()
void	unloadScripts()

Methods inherited from class com.hpe.caf.worker.document.impl.DocumentWorkerObjectImpl

getApplication

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.hpe.caf.worker.document.model.DocumentWorkerObject

getApplication

Field Detail

document

protected final DocumentImpl document

response

protected final ResponseImpl response

scripts

protected final ScriptsImpl scripts

Constructor Detail

AbstractTask

protected AbstractTask(ApplicationImpl application,
                       com.hpe.caf.api.worker.WorkerTaskData workerTask,
                       ReadOnlyDocument effectiveDocument,
                       Map<String,String> customData)

AbstractTask

protected AbstractTask(ApplicationImpl application,
                       com.hpe.caf.api.worker.WorkerTaskData workerTask,
                       ReadOnlyDocument effectiveDocument,
                       Map<String,String> customData,
                       List<DocumentWorkerScript> scripts)
                throws InvalidScriptException

Throws:

InvalidScriptException

Method Detail

getDocument

@Nonnull
public final DocumentImpl getDocument()

Specified by:

getDocument in interface Task

getCustomData

public final String getCustomData(String dataKey)

Specified by:

getCustomData in interface Task

getScripts

@Nonnull
public final ScriptsImpl getScripts()

Specified by:

getScripts in interface Task

getService

public <S> S getService(Class<S> service)

Specified by:

getService in interface Task

getResponse

@Nonnull
public Response getResponse()

Specified by:

getResponse in interface Task

createWorkerResponse

@Nonnull
public final com.hpe.caf.api.worker.WorkerResponse createWorkerResponse()

createWorkerResponseImpl

@Nonnull
protected abstract com.hpe.caf.api.worker.WorkerResponse createWorkerResponseImpl()

handleGeneralFailure

@Nonnull
public final com.hpe.caf.api.worker.WorkerResponse handleGeneralFailure(Throwable failure)

Returns appropriate WorkerResponse for the task in the event of a general task failure.

Parameters:

failure - detail of the failure that occurred

Returns:

response with task appropriate failure details

handleGeneralFailureImpl

@Nonnull
protected abstract com.hpe.caf.api.worker.WorkerResponse handleGeneralFailureImpl(Throwable failure)

loadScripts

public void loadScripts()
                 throws DocumentWorkerTransientException,
                        InterruptedException

Load the customization scripts and if there is an exception then try to determine if it is a transient issue.

Throws:

DocumentWorkerTransientException - if one of the scripts could not be loaded due to a transient issue

InterruptedException - if any thread has interrupted the current thread

unloadScripts

public void unloadScripts()

raiseProcessTaskEvent

public void raiseProcessTaskEvent()
                           throws DocumentWorkerTransientException,
                                  InterruptedException

Throws:

DocumentWorkerTransientException

InterruptedException

raiseBeforeProcessDocumentEvent

public boolean raiseBeforeProcessDocumentEvent(Document document)
                                        throws DocumentWorkerTransientException,
                                               InterruptedException

Throws:

DocumentWorkerTransientException

InterruptedException

raiseProcessDocumentEvent

public void raiseProcessDocumentEvent(Document document)
                               throws DocumentWorkerTransientException,
                                      InterruptedException

Throws:

DocumentWorkerTransientException

InterruptedException

raiseAfterProcessDocumentEvent

public void raiseAfterProcessDocumentEvent(Document document)
                                    throws DocumentWorkerTransientException,
                                           InterruptedException

Throws:

DocumentWorkerTransientException

InterruptedException

raiseAfterProcessTaskEvent

public void raiseAfterProcessTaskEvent()
                                throws DocumentWorkerTransientException,
                                       InterruptedException

Throws:

DocumentWorkerTransientException

InterruptedException

raiseOnErrorEvent

public boolean raiseOnErrorEvent(RuntimeException ex)
                          throws DocumentWorkerTransientException,
                                 InterruptedException

Throws:

DocumentWorkerTransientException

InterruptedException