com.adaptris.core.runtime

Class LruBoundedMessageCache

java.lang.Object

com.adaptris.core.runtime.LruBoundedMessageCache

All Implemented Interfaces:

ComponentLifecycle, MessageCache

public class LruBoundedMessageCache
extends java.lang.Object
implements MessageCache

A MessageCache implementation that uses an ArrayBlockingQueue to hold the messages.

Once the internal queue reaches it's limit, the oldest message will be removed and the newer message added.

You can control the limit of the internal queue by configuring "max-messages".

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

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
LruBoundedMessageCache()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the component.
boolean	contains(java.lang.String messageId)
java.util.concurrent.ArrayBlockingQueue<CacheableAdaptrisMessageWrapper>	getBoundedCache()
int	getMaxMessages()
void	init() Initialises the component.
void	put(CacheableAdaptrisMessageWrapper message)
CacheableAdaptrisMessageWrapper	remove(java.lang.String messageId)
void	setBoundedCache(java.util.concurrent.ArrayBlockingQueue<CacheableAdaptrisMessageWrapper> boundedCache)
void	setMaxMessages(int maxMessages)
void	start() Starts the component.
void	stop() Stop the component

Methods inherited from class java.lang.Object

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

Field Detail

log

protected transient org.slf4j.Logger log

Constructor Detail

LruBoundedMessageCache

public LruBoundedMessageCache()

Method Detail

put

public void put(CacheableAdaptrisMessageWrapper message)

Specified by:

put in interface MessageCache

remove

public CacheableAdaptrisMessageWrapper remove(java.lang.String messageId)

Specified by:

remove in interface MessageCache

contains

public boolean contains(java.lang.String messageId)

Specified by:

contains in interface MessageCache

init

public void init()

Description copied from interface: ComponentLifecycle

Initialises the component.

Component initialisation includes config verification, creation of connections etc.

Specified by:

init in interface ComponentLifecycle

start

public void start()

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

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

getMaxMessages

public int getMaxMessages()

setMaxMessages

public void setMaxMessages(int maxMessages)

getBoundedCache

public java.util.concurrent.ArrayBlockingQueue<CacheableAdaptrisMessageWrapper> getBoundedCache()

setBoundedCache

public void setBoundedCache(java.util.concurrent.ArrayBlockingQueue<CacheableAdaptrisMessageWrapper> boundedCache)