com.hpe.caf.worker.document.model

Interface Application

All Superinterfaces:

DocumentWorkerObject

public interface Application
extends DocumentWorkerObject

Represents the entire service. This object can expose configuration, worker information, and other worker-level details.

Method Summary

Modifier and Type	Method and Description
BatchSizeController	getBatchSizeController() Returns the batch size controller.
InputMessageProcessor	getInputMessageProcessor() Returns the input message processor.
String	getName() Returns the name of the worker, or null if the name of the worker is unknown.
<S> S	getService(Class<S> service) Returns the specified service, or null if the service has not been registered.
ServiceLocator	getServiceLocator() Returns the service locator object.
String	getVersion() Returns the version of the worker, or null if the version of the worker is unknown.

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

getApplication

Method Detail

getBatchSizeController

@Nonnull
BatchSizeController getBatchSizeController()

Returns the batch size controller.

This object controls the sizes of the batches passed to implementations of the BulkDocumentWorker interface.

Returns:

the batch size controller

getInputMessageProcessor

@Nonnull
InputMessageProcessor getInputMessageProcessor()

Returns the input message processor.

This object controls how input messages are processed.

Returns:

the input message processor

getName

String getName()

Returns the name of the worker, or null if the name of the worker is unknown.

Returns:

the name of the worker

getService

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

Returns the specified service, or null if the service has not been registered.

This method can be used to retrieve services provided by the underlying Worker Framework, such as the DataStore or ConfigurationSource services.

For example, to use the Worker Framework DataStore service add the following dependency to the project POM:

  <dependency>
      <groupId>com.github.workerframework</groupId>
      <artifactId>worker-api</artifactId>
      <scope>provided</scope>
  </dependency>

and then retrieve the service using this method:

  DataStore dataStore = document.getApplication().getService(DataStore.class);

Type Parameters:

S - the type of the service to be returned

Parameters:

service - the interface or abstract class representing the service

Returns:

the service provider

See Also:

ServiceLocator.getService(), Task.getService()

getServiceLocator

@Nonnull
ServiceLocator getServiceLocator()

Returns the service locator object. This can be used to retrieve extra services provided by the host framework.

Returns:

the service locator

getVersion

String getVersion()

Returns the version of the worker, or null if the version of the worker is unknown.

Returns:

the version of the worker