io.apiman.gateway.engine.policy

Class PolicyContextImpl

java.lang.Object

io.apiman.gateway.engine.policy.PolicyContextImpl

All Implemented Interfaces:

IPolicyContext

public class PolicyContextImpl
extends Object
implements IPolicyContext

A simple implementation of a IPolicyContext.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
PolicyContextImpl(IComponentRegistry componentRegistry) Constructor.

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PolicyContextImpl

public PolicyContextImpl(IComponentRegistry componentRegistry)

Constructor.

Parameters:

componentRegistry - the component registry

Method Detail

setAttribute

public void setAttribute(String name,
                Object value)

Description copied from interface: IPolicyContext

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

Specified by:

setAttribute in interface IPolicyContext

See Also:

IPolicyContext.setAttribute(java.lang.String, java.lang.Object)

getAttribute

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

Description copied from interface: IPolicyContext

Fetches an attribute value from the conversation.

Specified by:

getAttribute in interface IPolicyContext

Returns:

attribute if present, else default value

See Also:

IPolicyContext.getAttribute(java.lang.String, java.lang.Object)

removeAttribute

public boolean removeAttribute(String name)

Description copied from interface: IPolicyContext

Removes an attribute from the conversation.

Specified by:

removeAttribute in interface IPolicyContext

Returns:

whether attribute was removed

See Also:

IPolicyContext.removeAttribute(java.lang.String)

getComponent

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

Description copied from interface: IPolicyContext

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.

Specified by:

getComponent in interface IPolicyContext

Returns:

the component of type T

Throws:

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

See Also:

IPolicyContext.getComponent(java.lang.Class)

setConnectorInterceptor

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

Description copied from interface: IPolicyContext

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

Specified by:

setConnectorInterceptor in interface IPolicyContext

Parameters:

connectorInterceptor - the connector interceptor

Throws:

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

See Also:

IPolicyContext.setConnectorInterceptor(IConnectorInterceptor)

getConnectorInterceptor

public IConnectorInterceptor getConnectorInterceptor()

Specified by:

getConnectorInterceptor in interface IPolicyContext

Returns:

IConnectorInterceptor set to the context or null otherwise

See Also:

IPolicyContext.getConnectorInterceptor()