org.hawkular.apm.server.api.task

Interface Processor<T,R>

All Known Implementing Classes:

AbstractProcessor

public interface Processor<T,R>

This interface represents a processor.

Author:

gbrown

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Processor.ProcessorType This method determines what type of processing should be performed on the inbound information.

Method Summary

Modifier and Type	Method and Description
void	cleanup(String tenantId, List<T> items) This method is called once all of the items in the list of been processed to generate new information.
long	getDeliveryDelay(List<R> results) This method determines the delivery delay (in milliseconds) associated with the supplied list of results.
long	getRetryDelay(List<T> items, int retryCount) This method determines the retry delay (in milliseconds) associated with the supplied list of items.
Processor.ProcessorType	getType() This method identifies the type of the processor.
void	initialise(String tenantId, List<T> items) This method enables the processor to perform some initialisation tasks before processing the items individually to generate new information.
List<R>	processManyToMany(String tenantId, List<T> items) This method processes the supplied items to generate zero or more resulting values.
List<R>	processOneToMany(String tenantId, T item) This method processes the supplied item to generate zero or more resulting values.
R	processOneToOne(String tenantId, T item) This method processes the supplied item to optionally generated a new resulting value.

Method Detail

getType

Processor.ProcessorType getType()

This method identifies the type of the processor.

Returns:

The processor type

initialise

void initialise(String tenantId,
                List<T> items)
         throws RetryAttemptException

This method enables the processor to perform some initialisation tasks before processing the items individually to generate new information.

Parameters:

tenantId - The optional tenant id

items -

Throws:

RetryAttemptException - Failed to process the item

processOneToOne

R processOneToOne(String tenantId,
                  T item)
           throws RetryAttemptException

This method processes the supplied item to optionally generated a new resulting value.

Parameters:

tenantId - The optional tenant id

item - The item

Returns:

The optional value

Throws:

RetryAttemptException - Failed to process the item

processOneToMany

List<R> processOneToMany(String tenantId,
                         T item)
                  throws RetryAttemptException

This method processes the supplied item to generate zero or more resulting values.

Parameters:

tenantId - The optional tenant id

item - The item

Returns:

The list of values

Throws:

RetryAttemptException - Failed to process the item

processManyToMany

List<R> processManyToMany(String tenantId,
                          List<T> items)
                   throws RetryAttemptException

This method processes the supplied items to generate zero or more resulting values.

Parameters:

tenantId - The optional tenant id

items - The items

Returns:

The list of values

Throws:

RetryAttemptException - Failed to process the item

getDeliveryDelay

long getDeliveryDelay(List<R> results)

This method determines the delivery delay (in milliseconds) associated with the supplied list of results.

Parameters:

results - The results

Returns:

The delivery delay, or 0 if no delay

getRetryDelay

long getRetryDelay(List<T> items,
                   int retryCount)

This method determines the retry delay (in milliseconds) associated with the supplied list of items.

Parameters:

items - The items

retryCount - The retry count

Returns:

The retry delay, or 0 if no delay

cleanup

void cleanup(String tenantId,
             List<T> items)

This method is called once all of the items in the list of been processed to generate new information. It can be used to clean up any information managed by the processor related to those items. Generally the processor should not store any state outside the processing of the individual items.

Parameters:

tenantId - The optional tenant id

items -