|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.database.DbInterceptorManager
public class DbInterceptorManager
Implementation of the InterceptorManager interface.
Field Summary | |
---|---|
static java.lang.String[] |
ENT_DEFAULT_INTERCEPTOR_CLASSES
The list of the class names of the interceptors that are available for installation by default. |
static java.lang.String[] |
PRO_DEFAULT_INTERCEPTOR_CLASSES
|
Constructor Summary | |
---|---|
DbInterceptorManager(int objectType,
long objectID)
Creates a new interceptor manager. |
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. |
void |
destroy()
Notifies the manager to release any resources that may be holding on too. |
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 |
initialize()
Initialize the manager. |
void |
invokeInterceptors(ForumMessage message,
int type)
Invokes all currently-installed interceptors on the specified message. |
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 |
Field Detail |
---|
public static final java.lang.String[] ENT_DEFAULT_INTERCEPTOR_CLASSES
public static final java.lang.String[] PRO_DEFAULT_INTERCEPTOR_CLASSES
Constructor Detail |
---|
public DbInterceptorManager(int objectType, long objectID)
objectType
- the type of the object to manage interceptors on.objectID
- the objectID to manage interceptors on.Method Detail |
---|
public void initialize()
JiveManager
This method is used internally by Jive during application startup and should not be called during normal usage of the class.
initialize
in interface JiveManager
public void destroy()
JiveManager
destroy
in interface JiveManager
public MessageInterceptor getInterceptor(int index)
InterceptorManager
getInterceptor
in interface InterceptorManager
index
- the index in the list of interceptors.
public int getInterceptorCount()
InterceptorManager
getInterceptorCount
in interface InterceptorManager
public void addInterceptor(int index, MessageInterceptor interceptor)
InterceptorManager
addInterceptor
in interface InterceptorManager
index
- the index in the list to insert the new interceptor at.interceptor
- the interceptor to add.public void removeInterceptor(int index)
InterceptorManager
removeInterceptor
in interface InterceptorManager
index
- the index of the interceptor to remove.public void saveInterceptors()
InterceptorManager
saveInterceptors
in interface InterceptorManager
public MessageInterceptor[] getAvailableInterceptors()
InterceptorManager
getAvailableInterceptors
in interface InterceptorManager
public void addInterceptorClass(java.lang.String className) throws java.lang.ClassNotFoundException, java.lang.IllegalArgumentException
InterceptorManager
addInterceptorClass
in interface InterceptorManager
className
- the fully qualified name of the class to add to the list of available
filters in the system.
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.public void invokeInterceptors(ForumMessage message, int type) throws MessageRejectedException
message
- the message to run interceptors on.type
- the type of the interceptor to invoke.
MessageRejectedException
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |