Jive Forums API (5.5.20.2-oracle) Core Javadocs

com.jivesoftware.forum
Interface InterceptorManager


public interface InterceptorManager

Manages interceptors.

See Also:
MessageInterceptor

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.
 

Method Detail

getInterceptorCount

int getInterceptorCount()
Returns the count of currently active interceptors.

Returns:
a count of the currently active interceptors.

getInterceptor

MessageInterceptor getInterceptor(int index)
Return the interceptor at the specified index in the list of currently configured interceptors.

Parameters:
index - the index in the list of interceptors.
Returns:
the interceptor at the specified index.

addInterceptor

void addInterceptor(int index,
                    MessageInterceptor interceptor)
Inserts a new interceptor at specified index in the list of currently configured interceptors.

Parameters:
index - the index in the list to insert the new interceptor at.
interceptor - the interceptor to add.

removeInterceptor

void removeInterceptor(int index)
Removes the specified interceptor from the list of interceptors.

Parameters:
index - the index of the interceptor to remove.

saveInterceptors

void saveInterceptors()
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.


getAvailableInterceptors

MessageInterceptor[] getAvailableInterceptors()
Returns an array of MessageInterceptor objects that are all of the currently available incerceptors in the system.

Returns:
an array of all available interceptors in the current context.

addInterceptorClass

void addInterceptorClass(java.lang.String className)
                         throws UnauthorizedException,
                                java.lang.ClassNotFoundException,
                                java.lang.IllegalArgumentException
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.

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.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.