com.adaptris.core.cache

Interface Cache

All Superinterfaces:

ComponentLifecycle

All Known Implementing Classes:

ExpiringMapCache, NullCacheImplementation, RetryingCacheProxy

public interface Cache
extends ComponentLifecycle

Interface that defines basic general cache operations for use within the adapter.

Method Summary

Modifier and Type	Method and Description
default void	clear() Clears all entries from the cache
default void	close() Closes the component.
java.lang.Object	get(java.lang.String key) Retrieves an object from the cache
default java.util.List<java.lang.String>	getKeys() Retrieves a List of all the keys in the cache
default void	init() Initialises the component.
default void	put(java.lang.String key, java.lang.Object value) Puts any object into the cache.
void	put(java.lang.String key, java.io.Serializable value) Puts a serializable object into the cache.
void	remove(java.lang.String key) Removes an object from the cache.
default int	size()
default void	start() Starts the component.
default void	stop() Stop the component

Method Detail

put

void put(java.lang.String key,
         java.io.Serializable value)
  throws CoreException

Puts a serializable object into the cache. Guaranteed to be supported by all cache implementations.

Parameters:

key - key to store the value against

value - value to be stored

Throws:

CoreException - if there was an exception accessing the cache.

put

default void put(java.lang.String key,
                 java.lang.Object value)
          throws CoreException

Puts any object into the cache.

Not guaranteed to be supported by all cache implementations as some persistent caches require serialization.

Parameters:

key - key to store the value against

value - value to be stored

Throws:

java.lang.UnsupportedOperationException - if the put(String,Object) operation is not supported by this cache instance

CoreException - if there was an exception accessing the cache.

Implementation Note:

The default implementation throws an instance of UnsupportedOperationException and performs no other action.

get

java.lang.Object get(java.lang.String key)
              throws CoreException

Retrieves an object from the cache

Parameters:

key - the key to look up the object

Returns:

the object from the cache or null if it doesn't exist

Throws:

CoreException - if there was an exception accessing the cache.

remove

void remove(java.lang.String key)
     throws CoreException

Removes an object from the cache. Ignores nonexistent elements

Parameters:

key - the key to locate the object in the cache

Throws:

CoreException - if there was an exception accessing the cache.

getKeys

default java.util.List<java.lang.String> getKeys()
                                          throws CoreException

Retrieves a List of all the keys in the cache

Returns:

a List of all the keys in the cache

Throws:

java.lang.UnsupportedOperationException - if the getKeys operation is not supported by this cache instance

CoreException - if there was an exception accessing the cache.

Implementation Note:

The default implementation throws an instance of UnsupportedOperationException and performs no other action.

clear

default void clear()
            throws CoreException

Clears all entries from the cache

Throws:

java.lang.UnsupportedOperationException - if the clear operation is not supported by this cache instance

CoreException - if there was an exception accessing the cache.

Implementation Note:

The default implementation throws an instance of UnsupportedOperationException and performs no other action.

size

default int size()
          throws CoreException

Returns:

the number of items in the cache

Throws:

java.lang.UnsupportedOperationException - if the size operation is not supported by this cache instance

CoreException - if there was an exception accessing the cache.

Implementation Note:

The default implementation throws an instance of UnsupportedOperationException and performs no other action.

init

default 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

default 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

default 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

default 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