org.hawkular.btm.server.api.task

Class AbstractProcessor<T,R>

java.lang.Object

org.hawkular.btm.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

Constructor Summary

Constructors

Constructor and Description
AbstractProcessor()

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) This method determines the retry delay (in milliseconds) associated with the supplied list of items.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hawkular.btm.server.api.task.Processor

isMultiple, processMultiple, processSingle

Constructor Detail

AbstractProcessor

public AbstractProcessor()

Method Detail

initialise

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

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

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)

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

Returns:

The retry delay, or 0 if no delay

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