com.hpe.caf.worker.document

Class DocumentWorkerAdapter

java.lang.Object

com.hpe.caf.worker.document.DocumentWorkerAdapter

All Implemented Interfaces:

com.hpe.caf.api.HealthReporter, com.hpe.caf.api.worker.WorkerFactory

Direct Known Subclasses:

BulkDocumentWorkerAdapter

public class DocumentWorkerAdapter
extends Object
implements com.hpe.caf.api.worker.WorkerFactory

Allows implementations of the DocumentWorker class can be used with the Worker Framework.

Field Summary

Fields

Modifier and Type	Field and Description
protected ApplicationImpl	application This object stores the global data that was initially passed to the WorkerFactoryProvider when it was called.

Constructor Summary

Constructors

Constructor and Description
DocumentWorkerAdapter(ApplicationImpl application, DocumentWorker documentWorker) Constructs the DocumentWorkerAdapter object, which adapts the DocumentWorker interface so that objects which implement it can be used with the Worker Framework.

Method Summary

Modifier and Type	Method and Description
String	getInvalidTaskQueue()
com.hpe.caf.api.worker.Worker	getWorker(com.hpe.caf.api.worker.WorkerTaskData workerTask)
com.hpe.caf.api.worker.WorkerConfiguration	getWorkerConfiguration()
int	getWorkerThreads()
com.hpe.caf.api.HealthResult	healthCheck()
void	shutdown()

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.api.worker.WorkerFactory

getWorker

Field Detail

application

protected final ApplicationImpl application

This object stores the global data that was initially passed to the WorkerFactoryProvider when it was called. It effectively acts as a global object for the worker.

Constructor Detail

DocumentWorkerAdapter

public DocumentWorkerAdapter(ApplicationImpl application,
                             DocumentWorker documentWorker)

Constructs the DocumentWorkerAdapter object, which adapts the DocumentWorker interface so that objects which implement it can be used with the Worker Framework.

Parameters:

application - the global data for the worker

documentWorker - the actual implementation of the worker

Method Detail

healthCheck

public com.hpe.caf.api.HealthResult healthCheck()

Specified by:

healthCheck in interface com.hpe.caf.api.HealthReporter

getWorker

public com.hpe.caf.api.worker.Worker getWorker(com.hpe.caf.api.worker.WorkerTaskData workerTask)
                                        throws com.hpe.caf.api.worker.TaskRejectedException,
                                               com.hpe.caf.api.worker.InvalidTaskException

Specified by:

getWorker in interface com.hpe.caf.api.worker.WorkerFactory

Throws:

com.hpe.caf.api.worker.TaskRejectedException

com.hpe.caf.api.worker.InvalidTaskException

getWorkerConfiguration

@Nonnull
public com.hpe.caf.api.worker.WorkerConfiguration getWorkerConfiguration()

Specified by:

getWorkerConfiguration in interface com.hpe.caf.api.worker.WorkerFactory

getInvalidTaskQueue

public String getInvalidTaskQueue()

Specified by:

getInvalidTaskQueue in interface com.hpe.caf.api.worker.WorkerFactory

getWorkerThreads

public int getWorkerThreads()

Specified by:

getWorkerThreads in interface com.hpe.caf.api.worker.WorkerFactory

shutdown

public void shutdown()

Specified by:

shutdown in interface com.hpe.caf.api.worker.WorkerFactory