01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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: * Normalized and pluggable cache key generator
32: *
33: * @param context
34: * @param windowId The window id of the portlet to be cached.
35: * @since 2.1.2
36: * @return
37: */
38: ContentCacheKey createCacheKey(RequestContext context,
39: 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,
50: String pipeline, String windowId);
51:
52: /**
53: * Create a cache key without request context information, but by providing required parameters sessinid and windowid
54: *
55: * @param sessionid
56: * @param pipeline "desktop" or "portal"
57: * @param windowId
58: * @return
59: */
60: ContentCacheKey createSessionCacheKey(String sessionid,
61: String pipeline, String windowId);
62:
63: /**
64: * return true if caching is by session id, not username
65: *
66: * @return
67: */
68: boolean isCacheBySessionId();
69:
70: /**
71: * return true if caching is by username, not sessionid
72: *
73: * @return
74: */
75: boolean isCacheByUsername();
76: }
|