com.bea.wlcp.wlng.api.interceptor
Interface InterceptorManager

public interface InterceptorManager

InterceptorManager interface. This interface is responsible for handling the registration, unregistration and invocation of the interceptors.

Method Summary

abstract java.util.List	getInterceptors(InterceptionPoint ip) Returns the list of interceptors available at the given position.
abstract java.util.Map	getInterceptorsAndIndice(InterceptionPoint ip) Returns the list of interceptors and their indices available at the given position.
abstract void	register(Interceptor interceptor, InterceptionPoint ip, int index) Registers an interceptor at a given index and position.
abstract void	register(Interceptor interceptor, InterceptionPoint ip, int index, boolean replacementAllowed) Registers an interceptor at a given index and position.
abstract void	registerListener(InterceptorManagerListener listener) Register a listener.
abstract void	unregister(Interceptor interceptor, InterceptionPoint ip) Unregister an interceptor.
abstract void	unregister(int index, InterceptionPoint ip) Unregister an interceptor.
abstract void	unregisterListener(InterceptorManagerListener listener) Unregister a listener.
abstract void	update() Updates the current interceptors with any changes that have been made since the last call to update().

Method Detail

getInterceptors

public java.util.List getInterceptors(InterceptionPoint ip)

Returns the list of interceptors available at the given position.

Parameters:

ip - The interception point to get the interceptors.

Returns:

The interceptors found at the given position.

getInterceptorsAndIndice

public java.util.Map getInterceptorsAndIndice(InterceptionPoint ip)

Returns the list of interceptors and their indices available at the given position.

Parameters:

ip - The interception point to get the interceptors.

Returns:

The interceptors found at the given position.

register

public void register(Interceptor interceptor,
                     InterceptionPoint ip,
                     int index)

Registers an interceptor at a given index and position. The index indicates where the interceptor will be located in the flow of interceptors for a given position. The index can be any positive (MAX_INT) or negative integer (MIN_INT): the interceptors will be executed from the lowest to the largest index. Note: the method update() must be called for this action to take effect.

Parameters:

interceptor - The interceptor to register.

ip - The interception point of the request at which the interceptor should be invoked.

index - The index where the interceptor will be located in the flow.

register

public void register(Interceptor interceptor,
                     InterceptionPoint ip,
                     int index,
                     boolean replacementAllowed)

Registers an interceptor at a given index and position. The index indicates where the interceptor will be located in the flow of interceptors for a given position. The index can be any positive (MAX_INT) or negative integer (MIN_INT): the interceptors will be executed from the lowest to the largest index.

Parameters:

interceptor - The interceptor to register.

ip - interceptor The interceptor to register.

index - The index where the interceptor will be located in the flow.

replacementAllowed - If true, it means the interceptor can replace existed one with same index.

registerListener

public void registerListener(InterceptorManagerListener listener)

Register a listener.

Parameters:

listener - listener.

unregister

public void unregister(Interceptor interceptor,
                       InterceptionPoint ip)

Unregister an interceptor. Note: the method update() must be called for this action to take effect.

Parameters:

interceptor - The interceptor to unregister.

ip - The interception point of the request at which the interceptor should be invoked.

unregister

public void unregister(int index,
                       InterceptionPoint ip)

Unregister an interceptor. Note: the method update() must be called for this action to take effect.

Parameters:

index - The index of the interceptor.

ip - The interception point of the request at which the interceptor should be invoked.

unregisterListener

public void unregisterListener(InterceptorManagerListener listener)

Unregister a listener.

Parameters:

listener - listener.

update

public void update()

Updates the current interceptors with any changes that have been made since the last call to update().