org.apache.hivemind.internal
Interface ServiceInterceptorContribution

All Superinterfaces:

Locatable

All Known Implementing Classes:

ServiceInterceptorContributionImpl

public interface ServiceInterceptorContribution

extends Locatable

A contribution to a service extension point that creates an interceptor.

Author:

Howard Lewis Ship

Method Summary

void	createInterceptor(InterceptorStack stack) Invoked to actually create the interceptor and push it onto the stack.
java.lang.String	getFactoryServiceId() Returns the id of the factory that creates the interceptor.
java.lang.String	getFollowingInterceptorIds() As getPrecedingInterceptorIds(), but the indicating interceptors's behavior should follow this interceptor's.
java.lang.String	getName() Returns the name of the service interceptor.
java.lang.String	getPrecedingInterceptorIds() Returns a list interceptors service ids as a comma seperated list.

Methods inherited from interface org.apache.hivemind.Locatable

getLocation

Method Detail

getName

public java.lang.String getName()

Returns the name of the service interceptor. The name is used for ordering the service interceptor with respect to other interceptors. The name defaults to the factoryServiceId if no name is specified.

Returns:

the name of the service interceptor

Since:

1.1

getFactoryServiceId

public java.lang.String getFactoryServiceId()

Returns the id of the factory that creates the interceptor. Interceptor factories are simply another HiveMind service, one that implements ServiceInterceptorFactory.

createInterceptor

public void createInterceptor(InterceptorStack stack)

Invoked to actually create the interceptor and push it onto the stack.

getPrecedingInterceptorIds

public java.lang.String getPrecedingInterceptorIds()

Returns a list interceptors service ids as a comma seperated list. The behavior provided by these interceptors should precede the behavior of this interceptor.

Each service id is fully qualified. May return null.

getFollowingInterceptorIds

public java.lang.String getFollowingInterceptorIds()

As getPrecedingInterceptorIds(), but the indicating interceptors's behavior should follow this interceptor's.