1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.jetspeed.cache;
18
19 import java.io.Serializable;
20
21
22 /***
23 * <p>
24 * Provides interface to all Content Caches (Portlet API cache)
25 * </p>
26 *
27 * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
28 * @version $Id: $
29 */
30 public interface ContentCacheKey extends Serializable
31 {
32 /***
33 * Get the username or null if not used
34 * @return
35 */
36 String getUsername();
37
38 /***
39 * Get the pipeline name or null if not used
40 * @return
41 */
42 String getPipeline();
43
44 /***
45 * Get the window (portlet fragment) id
46 * @return
47 */
48 String getWindowId();
49
50 /***
51 * Get the session id or null if not used
52 *
53 * @return
54 */
55 String getSessionId();
56
57 /***
58 *
59 * @return
60 */
61 String getRequestParameter();
62
63 /***
64 *
65 * @return
66 */
67 String getSessionAttribute();
68
69 /***
70 * Return the full key as a string
71 * @return
72 */
73 String getKey();
74
75 void createFromUser(String username, String pipeline, String windowId);
76
77 void createFromSession(String sessionid, String pipeline, String windowId);
78 }