io.apiman.gateway.engine.components

Interface IDataStoreComponent

All Superinterfaces:

IComponent

All Known Implementing Classes:

InMemoryDataStoreComponent

public interface IDataStoreComponent
extends IComponent

A Component that allows policies to share data across invocations and potentially across nodes (depending on the implementation). The data managed will be related to requests and/or responses such as CachedResponse instances It is up to the implementation of this component to determine how transactional it might be (there are time vs. accuracy tradeoffs to be made here). Users of API Management will need to ensure they use an appropriate implementation of this component based on the data integrity/accuracy guarantees they require. All operations in this component are assumed to be asyncrhonous, so a handler must be provided if the policy implementation needs the operation to finish prior to moving on.

Author:

rubenrm1@gmail.com

Method Summary

Methods

Modifier and Type	Method and Description
<T> void	clearProperty(String namespace, String propertyName, IAsyncResultHandler<T> handler) Clears a property from the shared state environment, returning the previous value of the property or null if it was not previously set.
<T> void	getProperty(String namespace, String propertyName, T defaultValue, IAsyncResultHandler<T> handler) Gets the value of a single property stored in the shared state environment.
<T> boolean	hasProperty(String namespace, String propertyName) Checks whether the requested property exists in the Data Store
<T> void	setProperty(String namespace, String propertyName, T value, IAsyncResultHandler<T> handler) Sets a single property in the shared state environment, returning the previous value of the property or null if it was not previously set.
<T> void	setProperty(String namespace, String propertyName, T value, Long expiration, IAsyncResultHandler<T> handler) Sets a single property in the shared state environment for the given period of time, returning the previous value of the property or null if it was not previously set.

Method Detail

hasProperty

<T> boolean hasProperty(String namespace,
                      String propertyName)

Checks whether the requested property exists in the Data Store

Parameters:

namespace -

propertyName -

Returns:

true if has property; else false.

getProperty

<T> void getProperty(String namespace,
                   String propertyName,
                   T defaultValue,
                   IAsyncResultHandler<T> handler)

Gets the value of a single property stored in the shared state environment. Null is returned if the property is not set.

Parameters:

namespace -

propertyName -

defaultValue -

handler -

setProperty

<T> void setProperty(String namespace,
                   String propertyName,
                   T value,
                   IAsyncResultHandler<T> handler)

Sets a single property in the shared state environment, returning the previous value of the property or null if it was not previously set.

Parameters:

namespace -

propertyName -

value -

handler -

setProperty

<T> void setProperty(String namespace,
                   String propertyName,
                   T value,
                   Long expiration,
                   IAsyncResultHandler<T> handler)

Sets a single property in the shared state environment for the given period of time, returning the previous value of the property or null if it was not previously set.

Parameters:

namespace -

propertyName -

value -

expiration - time for the property to be kept in the DataStore before being considered as expired

handler -

clearProperty

<T> void clearProperty(String namespace,
                     String propertyName,
                     IAsyncResultHandler<T> handler)

Clears a property from the shared state environment, returning the previous value of the property or null if it was not previously set.

Parameters:

namespace -

propertyName -

handler -