Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.util
Class AdminCacheInfo

java.lang.Object
  extended by com.jivesoftware.forum.util.AdminCacheInfo

public class AdminCacheInfo
extends java.lang.Object

A utility class for the Jive Forums admin console to handle Cache administration.

Since:
4.0

Nested Class Summary
static class AdminCacheInfo.CacheWrapper
          A simple class which wraps a standard Jive cache object.
 
Field Summary
static java.lang.String CACHE_MODE_COOKIE
          Name of the cookie used to store the cache mode (simple or advanced).
static int CUSTOM_PRESET
          Constant for custom size cache preset.
static int LARGE_PRESET
          Constant for large cache preset.
static int MEDIUM_PRESET
          Constant for medium cache preset.
static int SMALL_PRESET
          Constant for small cache preset.
 
Method Summary
static void clearAllClusterCaches()
           
static java.lang.String getCacheMode(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Returns the cache mode (simple or advanced) currently set for the user.
static int[] getCachePresets()
          Returns an array of all available preset types.
static Cache[] getCaches()
          Returns an array of all caches in the system.
static int getCurrentPreset()
          Returns the current preset - either SMALL_PRESET, MEDIUM_PRESET, LARGE_PRESET, or CUSTOM_PRESET.
static AdminCacheInfo.CacheWrapper[] getWrappedCaches()
          Returns a list of caches in the system.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CACHE_MODE_COOKIE

public static final java.lang.String CACHE_MODE_COOKIE
Name of the cookie used to store the cache mode (simple or advanced).

See Also:
getCacheMode(HttpServletRequest, HttpServletResponse), Constant Field Values

SMALL_PRESET

public static int SMALL_PRESET
Constant for small cache preset.


MEDIUM_PRESET

public static int MEDIUM_PRESET
Constant for medium cache preset.


LARGE_PRESET

public static int LARGE_PRESET
Constant for large cache preset.


CUSTOM_PRESET

public static int CUSTOM_PRESET
Constant for custom size cache preset.

Method Detail

clearAllClusterCaches

public static void clearAllClusterCaches()

getCacheMode

public static java.lang.String getCacheMode(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)
Returns the cache mode (simple or advanced) currently set for the user.

Returns:
the cache mode ("simple" or "advanced") currently set for the user.

getCachePresets

public static int[] getCachePresets()
Returns an array of all available preset types.

Returns:
an array of all available preset types.

getWrappedCaches

public static AdminCacheInfo.CacheWrapper[] getWrappedCaches()
Returns a list of caches in the system. Each cache is wrapped in a AdminCacheInfo.CacheWrapper object.

Returns:
a list of wrapped caches.

getCaches

public static Cache[] getCaches()
Returns an array of all caches in the system.


getCurrentPreset

public static int getCurrentPreset()
Returns the current preset - either SMALL_PRESET, MEDIUM_PRESET, LARGE_PRESET, or CUSTOM_PRESET.

Returns:
the current cache size preset being used.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.