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