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 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  }