io.apiman.gateway.engine.components

Interface ISharedStateComponent

All Superinterfaces:

IComponent

All Known Implementing Classes:

InMemorySharedStateComponent

public interface ISharedStateComponent
extends IComponent

A component that allows policies to share information across invokations and potentially across nodes in a cluster. The expectation is that policies will use this component to track aggregation information such as metrics, billing, or for throttling. 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:

eric.wittmann@redhat.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> 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.

Method Detail

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 -

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 -