| 
 | J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.sun.appserv.web.cache.DefaultCacheHelper
DefaultCacheHelper interface is the built-in implementation of the 
  CacheHelper interface to aide in:
  a) the key generation b) whether to cache the response.
  There is one CacheHelper instance per web application.
| Field Summary | |
| static java.lang.String | ATTR_CACHING_FILTER_NAME | 
| static java.lang.String | PROP_KEY_GENERATOR_ATTR_NAME | 
| Fields inherited from interface com.sun.appserv.web.cache.CacheHelper | 
| ATTR_CACHE_MAPPED_SERVLET_NAME, ATTR_CACHE_MAPPED_URL_PATTERN, TIMEOUT_VALUE_NOT_SET | 
| Constructor Summary | |
| DefaultCacheHelper() | |
| Method Summary | |
|  void | destroy()Stop this Context component. | 
|  java.lang.String | getCacheKey(HttpServletRequest request)getCacheKey: generate the key to be used to cache this request | 
|  int | getTimeout(HttpServletRequest request)get timeout for the cacheable data in this request | 
|  void | init(ServletContext context,
     java.util.Map props)initialize this helper | 
|  boolean | isCacheable(HttpServletRequest request)isCacheable: is the response to given request cachebale? | 
|  boolean | isRefreshNeeded(HttpServletRequest request)isRefreshNeeded: is the response to given request be refreshed? | 
|  void | setCacheManager(CacheManager manager)set the CacheManager for this application | 
| 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 ATTR_CACHING_FILTER_NAME
public static final java.lang.String PROP_KEY_GENERATOR_ATTR_NAME
| Constructor Detail | 
public DefaultCacheHelper()
| Method Detail | 
public void setCacheManager(CacheManager manager)
manager - associated with this application
public void init(ServletContext context,
                 java.util.Map props)
init in interface CacheHelpercontext - the web application context this helper belongs toprops - helper propertiespublic java.lang.String getCacheKey(HttpServletRequest request)
getCacheKey in interface CacheHelperrequest - incoming HttpServletRequestpublic boolean isCacheable(HttpServletRequest request)
isCacheable in interface CacheHelperrequest - incoming HttpServletRequest objectpublic boolean isRefreshNeeded(HttpServletRequest request)
isRefreshNeeded in interface CacheHelperrequest - incoming HttpServletRequest objectpublic int getTimeout(HttpServletRequest request)
getTimeout in interface CacheHelperrequest - incoming HttpServletRequest object
public void destroy()
             throws java.lang.Exception
destroy in interface CacheHelperjava.lang.Exception - if a shutdown error occurs| 
 | J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved.