io.apiman.gateway.engine.policy

Interface IPolicyContext

All Known Implementing Classes:

PolicyContextImpl

public interface IPolicyContext

Context information provided to an executing policy.

Author:

Marc Savy

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	getAttribute(String name, T defaultValue) Fetches an attribute value from the conversation.
<T extends IComponent> T	getComponent(Class<T> componentClass) Gets a component by type.
IConnectorInterceptor	getConnectorInterceptor()
boolean	removeAttribute(String name) Removes an attribute from the conversation.
void	setAttribute(String name, Object value) Sets a conversation-scoped attribute, allowing policies to pass interesting information to each other and to themselves.
void	setConnectorInterceptor(IConnectorInterceptor connectorInterceptor) Sets the IConnectorInterceptor to be used instead of the real connection.

Method Detail

setAttribute

void setAttribute(String name,
                Object value)

Sets a conversation-scoped attribute, allowing policies to pass interesting information to each other and to themselves.

Parameters:

name -

value -

getAttribute

<T> T getAttribute(String name,
                 T defaultValue)

Fetches an attribute value from the conversation.

Parameters:

name -

defaultValue -

removeAttribute

boolean removeAttribute(String name)

Removes an attribute from the conversation.

Parameters:

name -

getComponent

<T extends IComponent> T getComponent(Class<T> componentClass)
                                  throws io.apiman.gateway.engine.beans.exceptions.ComponentNotFoundException

Gets a component by type. Components are provided by the APIMan system for use by policies during their execution. Examples of components include the Shared State Component and the HTTP Client Component.

Parameters:

componentClass -

Throws:

io.apiman.gateway.engine.beans.exceptions.ComponentNotFoundException

setConnectorInterceptor

void setConnectorInterceptor(IConnectorInterceptor connectorInterceptor)
                             throws io.apiman.gateway.engine.beans.exceptions.InterceptorAlreadyRegisteredException

Sets the IConnectorInterceptor to be used instead of the real connection.

Throws:

io.apiman.gateway.engine.beans.exceptions.InterceptorAlreadyRegisteredException

getConnectorInterceptor

IConnectorInterceptor getConnectorInterceptor()

Returns:

IConnectorInterceptor set to the context or null otherwise