org.ikasan.spec.exclusion

Interface ExclusionService<ENTITY,IDENTIFIER>

public interface ExclusionService<ENTITY,IDENTIFIER>

ExclusionService contract.

Author:

Ikasan Development Team

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_TIME_TO_LIVE one year default time to live

Method Summary

Modifier and Type	Method and Description
void	addBlacklisted(IDENTIFIER identifier, String uri, FlowInvocationContext flowInvocationContext) Add this identifier to the blacklist based on a specified identifier and associated URI.
String	getErrorUri(IDENTIFIER identifier) Get the errorUri from the blacklist associated with the identifier.
FlowInvocationContext	getFlowInvocationContext(IDENTIFIER identifier) Get the flow invocation from the blacklist associated with the identifier.
void	housekeep() Housekeep expired exclusionEvents.
boolean	isBlackListed(IDENTIFIER identifier) Is this identifier on the blacklist.
boolean	isBlackListEmpty()
void	park(ENTITY entity, IDENTIFIER identifier) Park this entity
void	removeBlacklisted(IDENTIFIER identifier) Remove this entity from the blacklist
void	setTimeToLive(Long timeToLive) Allow entities blacklisted to be marked with a timeToLive.

Field Detail

DEFAULT_TIME_TO_LIVE

static final long DEFAULT_TIME_TO_LIVE

one year default time to live

Method Detail

isBlackListed

boolean isBlackListed(IDENTIFIER identifier)

Is this identifier on the blacklist.

Parameters:

identifier -

Returns:

addBlacklisted

void addBlacklisted(IDENTIFIER identifier,
                    String uri,
                    FlowInvocationContext flowInvocationContext)

Add this identifier to the blacklist based on a specified identifier and associated URI.

Parameters:

identifier -

uri -

getErrorUri

String getErrorUri(IDENTIFIER identifier)

Get the errorUri from the blacklist associated with the identifier.

getFlowInvocationContext

FlowInvocationContext getFlowInvocationContext(IDENTIFIER identifier)

Get the flow invocation from the blacklist associated with the identifier.

Parameters:

identifier -

Returns:

park

void park(ENTITY entity,
          IDENTIFIER identifier)

Park this entity

Parameters:

entity -

removeBlacklisted

void removeBlacklisted(IDENTIFIER identifier)

Remove this entity from the blacklist

Parameters:

identifier -

setTimeToLive

void setTimeToLive(Long timeToLive)

Allow entities blacklisted to be marked with a timeToLive. On expiry of the timeToLive the entity will no longer be blacklisted.

Parameters:

timeToLive -

housekeep

void housekeep()

Housekeep expired exclusionEvents.

isBlackListEmpty

boolean isBlackListEmpty()