CacheKeyGenerator


1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the License).  You may not use this file except in
5    * compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9    * glassfish/bootstrap/legal/CDDLv1.0.txt.
10   * See the License for the specific language governing 
11   * permissions and limitations under the License.
12   * 
13   * When distributing Covered Code, include this CDDL 
14   * Header Notice in each file and include the License file 
15   * at glassfish/bootstrap/legal/CDDLv1.0.txt.  
16   * If applicable, add the following below the CDDL Header, 
17   * with the fields enclosed by brackets [] replaced by
18   * you own identifying information: 
19   * "Portions Copyrighted [year] [name of copyright owner]"
20   * 
21   * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22   */
23  
24  package com.sun.appserv.web.cache;
25  
26  import javax.servlet.ServletContext  ;
27  import javax.servlet.http.HttpServletRequest  ;
28  
29  /** CacheKeyGenerator: a helper interface to generate the key that is 
30   *  used to cache this request.
31   */
32  public interface CacheKeyGenerator {
33      
34      /** getCacheKey: generate the key to be used to cache the response.
35       *  @param context the web application context
36       *  @param request incoming <code>HttpServletRequest</code>
37       *  @return key string used to access the cache entry.
38       *  if the return value is null, a default key is used.
39       */
40      public String   getCacheKey(ServletContext   context,
41                                  HttpServletRequest   request);
42  }
43

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags