com.jivesoftware.forum.proxy
Class InterceptorManagerProxy

java.lang.Object
  com.jivesoftware.forum.proxy.InterceptorManagerProxy

All Implemented Interfaces:

InterceptorManager

public class InterceptorManagerProxy
extends java.lang.Object
implements InterceptorManager

Protection proxy for InterceptorManager instances.

Constructor Summary

InterceptorManagerProxy(InterceptorManager interceptorManager, Permissions permissions)

Method Summary

void	addInterceptor(int index, MessageInterceptor interceptor) Inserts a new interceptor at specified index in the list of currently configured interceptors.
void	addInterceptorClass(java.lang.String className) Installs a new class into the list of available interceptors for the system.
MessageInterceptor[]	getAvailableInterceptors() Returns an array of MessageInterceptor objects that are all of the currently available incerceptors in the system.
MessageInterceptor	getInterceptor(int index) Return the interceptor at the specified index in the list of currently configured interceptors.
int	getInterceptorCount() Returns the count of currently active interceptors.
void	removeInterceptor(int index) Removes the specified interceptor from the list of interceptors.
void	saveInterceptors() Saves all interceptors to the persistent store.

Methods inherited from class java.lang.Object

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

Constructor Detail

InterceptorManagerProxy

public InterceptorManagerProxy(InterceptorManager interceptorManager,
                               Permissions permissions)

Method Detail

getInterceptorCount

public int getInterceptorCount()

Description copied from interface: InterceptorManager

Returns the count of currently active interceptors.

Specified by:

getInterceptorCount in interface InterceptorManager

Returns:

a count of the currently active interceptors.

getInterceptor

public MessageInterceptor getInterceptor(int index)

Description copied from interface: InterceptorManager

Return the interceptor at the specified index in the list of currently configured interceptors.

Specified by:

getInterceptor in interface InterceptorManager

Parameters:

index - the index in the list of interceptors.

Returns:

the interceptor at the specified index.

addInterceptor

public void addInterceptor(int index,
                           MessageInterceptor interceptor)

Description copied from interface: InterceptorManager

Inserts a new interceptor at specified index in the list of currently configured interceptors.

Specified by:

addInterceptor in interface InterceptorManager

Parameters:

index - the index in the list to insert the new interceptor at.

interceptor - the interceptor to add.

removeInterceptor

public void removeInterceptor(int index)

Description copied from interface: InterceptorManager

Removes the specified interceptor from the list of interceptors.

Specified by:

removeInterceptor in interface InterceptorManager

Parameters:

index - the index of the interceptor to remove.

saveInterceptors

public void saveInterceptors()

Description copied from interface: InterceptorManager

Saves all interceptors to the persistent store. This method should be called after setting any properties on individual interceptors that are being managed by this interceptor manager.

Specified by:

saveInterceptors in interface InterceptorManager

getAvailableInterceptors

public MessageInterceptor[] getAvailableInterceptors()

Description copied from interface: InterceptorManager

Returns an array of MessageInterceptor objects that are all of the currently available incerceptors in the system.

Specified by:

getAvailableInterceptors in interface InterceptorManager

Returns:

an array of all available interceptors in the current context.

addInterceptorClass

public void addInterceptorClass(java.lang.String className)
                         throws UnauthorizedException,
                                java.lang.ClassNotFoundException,
                                java.lang.IllegalArgumentException

Description copied from interface: InterceptorManager

Installs a new class into the list of available interceptors for the system. Exceptions are thrown if you're not an administrator, the class can't be loaded from the classpath, or the class isn't an instance of MessageInterceptor.

Specified by:

addInterceptorClass in interface InterceptorManager

Parameters:

className - the fully qualified name of the class to add to the list of available filters in the system.

Throws:

UnauthorizedException - if not a system administator.

java.lang.ClassNotFoundException - if the class could not be loaded.

java.lang.IllegalArgumentException - if the class is not a filter or could not be instantiated.