io.apiman.gateway.engine.components

Interface ICacheStoreComponent

All Superinterfaces:

IComponent

All Known Implementing Classes:

InMemoryCacheStoreComponent

public interface ICacheStoreComponent
extends IComponent

A component that provides a way to cache content. The cache store supports caching of serializeable objects in addition to the binary content associated with it (if any).

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
<T> void	get(String cacheKey, Class<T> type, IAsyncResultHandler<T> handler) Gets a cache entry.
<T> void	getBinary(String cacheKey, Class<T> type, IAsyncResultHandler<ISignalReadStream<T>> handler) Gets a cache entry with its binary data.
<T> void	put(String cacheKey, T jsonObject, long timeToLive) Put an entry into the cache.
<T> ISignalWriteStream	putBinary(String cacheKey, T jsonObject, long timeToLive) Open a cache store entry so that data can be streamed into it.

Method Detail

put

<T> void put(String cacheKey,
           T jsonObject,
           long timeToLive)
         throws IOException

Put an entry into the cache. The entry will not include any binary content - just the JSON object.

Parameters:

cacheKey -

jsonObject -

timeToLive -

Throws:

IOException

putBinary

<T> ISignalWriteStream putBinary(String cacheKey,
                               T jsonObject,
                               long timeToLive)
                             throws IOException

Open a cache store entry so that data can be streamed into it.

Parameters:

cacheKey -

jsonObject -

timeToLive -

Throws:

IOException

get

<T> void get(String cacheKey,
           Class<T> type,
           IAsyncResultHandler<T> handler)

Gets a cache entry.

Parameters:

cacheKey -

type -

Throws:

IOException

getBinary

<T> void getBinary(String cacheKey,
                 Class<T> type,
                 IAsyncResultHandler<ISignalReadStream<T>> handler)

Gets a cache entry with its binary data.

Parameters:

cacheKey -

Throws:

IOException