View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.cache;
18  
19  import org.apache.jetspeed.request.RequestContext;
20  
21  /***
22   * <p>
23   *  Provides interface to Jetspeed for content cache key generation
24   * </p>
25   * 
26   * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
27   * @version $Id: $
28   */
29  public interface ContentCacheKeyGenerator
30  {
31      /***
32       * Normalized and pluggable cache key generator
33       * 
34       * @param context
35       * @param windowId The window id of the portlet to be cached.
36       * @since 2.1.2
37       * @return
38       */
39      ContentCacheKey createCacheKey(RequestContext context, String windowId);
40      
41      /***
42       * Create a cache key without request context information, but by providing required parameters username and windowid
43       * 
44       * @param username
45       * @param pipeline "desktop" or "portal"
46       * @param windowId
47       * @return
48       */
49      ContentCacheKey createUserCacheKey(String username, String pipeline, String windowId);
50  
51      /***
52       * Create a cache key without request context information, but by providing required parameters sessinid and windowid
53       * 
54       * @param sessionid
55       * @param pipeline "desktop" or "portal"
56       * @param windowId
57       * @return
58       */
59      ContentCacheKey createSessionCacheKey(String sessionid, String pipeline, String windowId);
60      
61      /***
62       *  return true if caching is by session id, not username
63       *  
64       * @return
65       */
66      boolean isCacheBySessionId();
67      
68      /***
69       *  return true if caching is by username, not sessionid
70       *  
71       * @return
72       */    
73      boolean isCacheByUsername();
74  }