Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base
Class GroupManagerFactory

java.lang.Object
  extended by com.jivesoftware.base.GroupManagerFactory
All Implemented Interfaces:
JiveManager

public class GroupManagerFactory
extends java.lang.Object
implements JiveManager

A factory that returns a concrete instance of a group manager.


Field Summary
static Cache groupCache
          A cache for group objects.
static Cache groupIDCache
          A cache that maps group names to ID's.
static Cache groupMemberCache
          A cache for the list members of in each group.This cache is not instantiated until after this factory is initialized.
 
Method Summary
static void addListener(GroupListener listener)
          Method used internally by Jive.
 void destroy()
          Notifies the manager to release any resources that may be holding on too.
static void dispatchEvent(JiveEvent event)
          Method used internally by Jive.
static void doInitialize()
           
static GroupManager getInstance()
          Returns a concrete instance of the group manager interface.
 void initialize()
          Initialize the manager.
static void removeListener(GroupListener listener)
          Method used internally by Jive.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

groupCache

public static Cache groupCache
A cache for group objects. This cache is not instantiated until after this factory is initialized.


groupIDCache

public static Cache groupIDCache
A cache that maps group names to ID's. This cache is not instantiated until after this factory is initialized.


groupMemberCache

public static Cache groupMemberCache
A cache for the list members of in each group.This cache is not instantiated until after this factory is initialized.

Method Detail

getInstance

public static GroupManager getInstance()
Returns a concrete instance of the group manager interface. This method will return null until this class has been initialized.

Note: in general, this method is not intended to be called by outside users of the API. Doing so is dangerous since the GroupManager implementation returned will not be secured by a protection proxy.

Returns:
a concrete implementation of a group manager.

initialize

public void initialize()
Description copied from interface: JiveManager
Initialize the manager. It is within this method that it is ok to create, access and/or otherwise use external classes (including caches). Until this method is called implementation should not access any external classes that could possibly either access one of the main Factory classes or any caches since doing so can cause deadlocks and possible clustering issues during startup.

This method is used internally by Jive during application startup and should not be called during normal usage of the class.

Specified by:
initialize in interface JiveManager

destroy

public void destroy()
Description copied from interface: JiveManager
Notifies the manager to release any resources that may be holding on too. This could also be used to clear out the managers caches, etc.

This method is used internally by Jive during application startup and should not be called during normal usage of the class.

Specified by:
destroy in interface JiveManager

doInitialize

public static void doInitialize()

addListener

public static void addListener(GroupListener listener)
Method used internally by Jive. Do NOT use this method to register a listener for group events - use the GroupEventDispatcher to do that.


removeListener

public static void removeListener(GroupListener listener)
Method used internally by Jive. Do NOT use this method to unregister a listener for group events - use the GroupEventDispatcher to do that.


dispatchEvent

public static void dispatchEvent(JiveEvent event)
Method used internally by Jive.


Jive Forums Project Page

Copyright © 1999-2006 Jive Software.