com.adaptris.core.services.conditional.conditions

Class ExistsInCache

java.lang.Object

com.adaptris.core.services.conditional.conditions.ExistsInCache

All Implemented Interfaces:

ComponentLifecycle, Condition

@ComponentProfile(summary="Check the cache for a key",
                  tag="condition,cache",
                  since="3.9.1",
                  recommended=CacheConnection.class)
public class ExistsInCache
extends java.lang.Object
implements Condition

Condition that checks whether a key exists in a Cache

In the adapter configuration file this class is aliased as exists-in-cache which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
ExistsInCache()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the component.
boolean	evaluate(AdaptrisMessage msg)
AdaptrisConnection	getConnection()
java.lang.String	getKey()
void	init() Initialises the component.
void	setConnection(AdaptrisConnection connection) Set the connection to the Cache instance.
void	setKey(java.lang.String key) Specify the key to check for in the cache.
void	start() Starts the component.
void	stop() Stop the component
ExistsInCache	withConnection(AdaptrisConnection c)
ExistsInCache	withKey(java.lang.String key)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExistsInCache

public ExistsInCache()

Method Detail

init

public void init()
          throws CoreException

Description copied from interface: ComponentLifecycle

Initialises the component.

Component initialisation includes config verification, creation of connections etc.

Specified by:

init in interface ComponentLifecycle

Throws:

CoreException - wrapping any underlying Exceptions

start

public void start()
           throws CoreException

Description copied from interface: ComponentLifecycle

Starts the component.

Once a component is started it should be ready to process messages. In the case of AdaptrisMessageConsumer, calling start will begin message delivery.

Specified by:

start in interface ComponentLifecycle

Throws:

CoreException - wrapping any underlying Exceptions

stop

public void stop()

Description copied from interface: ComponentLifecycle

Stop the component

A stopped component is not expected to be ready to process messages. In the case of AdaptrisMessageConsumer, calling stop will pause message delivery. Throwing a RuntimeException may cause unintended consequences

Specified by:

stop in interface ComponentLifecycle

close

public void close()

Description copied from interface: ComponentLifecycle

Closes the component.

A closed component should release any connections it uses, etc. and clean up completely. Throwing a RuntimeException may cause unintended consequences

Specified by:

close in interface ComponentLifecycle

evaluate

public boolean evaluate(AdaptrisMessage msg)
                 throws CoreException

Specified by:

evaluate in interface Condition

Throws:

CoreException

getConnection

public AdaptrisConnection getConnection()

setConnection

public void setConnection(AdaptrisConnection connection)

Set the connection to the Cache instance.

Parameters:

connection - the connection.

getKey

public java.lang.String getKey()

setKey

public void setKey(java.lang.String key)

Specify the key to check for in the cache.

Parameters:

key - the key.

withConnection

public ExistsInCache withConnection(AdaptrisConnection c)

withKey

public ExistsInCache withKey(java.lang.String key)