Jive Forums API (5.5.20.2-oracle) Core Javadocs

com.jivesoftware.forum
Class AvatarManagerFactory

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

public final class AvatarManagerFactory
extends java.lang.Object
implements com.jivesoftware.base.JiveManager

Used to create Managers for Avatar feature. Also used for enabling disabling avatar feature, and for cache management.

Please use method for managing adding/removing items from the caches


Field Summary
static com.jivesoftware.util.Cache activeAvatarCache
           
static java.lang.String AVATAR_ENABLE_PROPERTY
           
static com.jivesoftware.util.Cache avatarCache
           
static com.jivesoftware.util.Cache reverseActiveAvatarCache
           
 
Method Summary
static void addActiveAvatarToCache(Avatar avatar, User user)
          Adds an avatar to the active avatar caches for a specific user
static void clearAvatarFromCache(Avatar avatar)
          Clears an avatar from all the caches
 void destroy()
           
static void doInitialize()
           
static AvatarManager getInstance()
          Returns a concrete instance of the Avatar interface.
 void initialize()
           
static boolean isAvatarsEnabled()
           
static void setAvatarsEnabled(boolean enabled)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

AVATAR_ENABLE_PROPERTY

public static final java.lang.String AVATAR_ENABLE_PROPERTY
See Also:
Constant Field Values

avatarCache

public static com.jivesoftware.util.Cache avatarCache

activeAvatarCache

public static com.jivesoftware.util.Cache activeAvatarCache

reverseActiveAvatarCache

public static com.jivesoftware.util.Cache reverseActiveAvatarCache
Method Detail

getInstance

public static AvatarManager getInstance()
Returns a concrete instance of the Avatar interface.

Note: in general this method intended to be called only by the DbForumFactory.

Returns:
a concrete implementation of avatar manager.

initialize

public void initialize()
Specified by:
initialize in interface com.jivesoftware.base.JiveManager

destroy

public void destroy()
Specified by:
destroy in interface com.jivesoftware.base.JiveManager

doInitialize

public static void doInitialize()

setAvatarsEnabled

public static void setAvatarsEnabled(boolean enabled)

isAvatarsEnabled

public static boolean isAvatarsEnabled()

addActiveAvatarToCache

public static void addActiveAvatarToCache(Avatar avatar,
                                          User user)
Adds an avatar to the active avatar caches for a specific user

Parameters:
avatar - active avatar
user - user key for avatar

clearAvatarFromCache

public static void clearAvatarFromCache(Avatar avatar)
Clears an avatar from all the caches

Parameters:
avatar - avatar to clear from caches

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.