Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base
Class UserManagerFactory

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

public class UserManagerFactory
extends java.lang.Object
implements JiveManager

A factory that returns a concrete instance of a UserManager. Note that the UserManager returned is not wrapped by a protection proxy. Therefore, it's critical that any code that implements end-user functionality does not use this class directly. Instead, the product-specific methods to retrieve a UserManager should be used instead, such as the method available in the ForumFactory class.


Field Summary
static Cache userCache
          A cache for user objects.
static Cache userIDCache
          A cache that maps user names to ID's.
 
Method Summary
static void addListener(UserListener 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 doDestroy()
          Method used internally by Jive.
static void doInitialize()
           
static UserManager getInstance()
          Returns a concrete instance of the user manager interface.
 void initialize()
          Initialize the manager.
static void removeListener(UserListener 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

userIDCache

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


userCache

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

Method Detail

getInstance

public static UserManager getInstance()
Returns a concrete instance of the user 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 UserManager implementation returned will not be secured by a protection proxy.

Returns:
a concrete implementation of a user 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

doDestroy

public static void doDestroy()
Method used internally by Jive. Do NOT use this method. Allows the class to be re-initialized.


doInitialize

public static void doInitialize()

addListener

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


removeListener

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


dispatchEvent

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


Jive Forums Project Page

Copyright © 1999-2006 Jive Software.