org.hawkular.apm.server.api.task

Class AbstractProcessor<T,R>

java.lang.Object

org.hawkular.apm.server.api.task.AbstractProcessor<T,R>

All Implemented Interfaces:

Processor<T,R>

public abstract class AbstractProcessor<T,R>
extends Object
implements Processor<T,R>

This abstract class represents the base class for processors.

Author:

gbrown

Nested Class Summary

Nested classes/interfaces inherited from interface org.hawkular.apm.server.api.task.Processor

Processor.ProcessorType

Constructor Summary

Constructors

Constructor and Description
AbstractProcessor(Processor.ProcessorType type) This constructor initialises the type of the processor.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProcessor

public AbstractProcessor(Processor.ProcessorType type)

This constructor initialises the type of the processor.

Parameters:

type - The type

Method Detail

getType

public Processor.ProcessorType getType()

Description copied from interface: Processor

This method identifies the type of the processor.

Specified by:

getType in interface Processor<T,R>

Returns:

The processor type

initialise

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

Description copied from interface: Processor

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

Specified by:

initialise in interface Processor<T,R>

Parameters:

tenantId - The optional tenant id

Throws:

RetryAttemptException - Failed to process the item

getDeliveryDelay

public long getDeliveryDelay(List<R> results)

Description copied from interface: Processor

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

Specified by:

getDeliveryDelay in interface Processor<T,R>

Parameters:

results - The results

Returns:

The delivery delay, or 0 if no delay

getRetryDelay

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

Description copied from interface: Processor

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

Specified by:

getRetryDelay in interface Processor<T,R>

Parameters:

items - The items

retryCount - The retry count

Returns:

The retry delay, or 0 if no delay

processOneToOne

public R processOneToOne(String tenantId,
                         T item)
                  throws RetryAttemptException

Description copied from interface: Processor

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

Specified by:

processOneToOne in interface Processor<T,R>

Parameters:

tenantId - The optional tenant id

item - The item

Returns:

The optional value

Throws:

RetryAttemptException - Failed to process the item

processOneToMany

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

Description copied from interface: Processor

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

Specified by:

processOneToMany in interface Processor<T,R>

Parameters:

tenantId - The optional tenant id

item - The item

Returns:

The list of values

Throws:

RetryAttemptException - Failed to process the item

processManyToMany

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

Description copied from interface: Processor

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

Specified by:

processManyToMany in interface Processor<T,R>

Parameters:

tenantId - The optional tenant id

items - The items

Returns:

The list of values

Throws:

RetryAttemptException - Failed to process the item

cleanup

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

Description copied from interface: Processor

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.

Specified by:

cleanup in interface Processor<T,R>

Parameters:

tenantId - The optional tenant id