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 cache related activities
24   *  Abstraction around actual cache implementation
25   * </p>
26   * 
27   * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
28   * @version $Id: $
29   */
30  public interface JetspeedContentCache extends JetspeedCache
31  {
32      /***
33       * Creates a session key used to store associated information in the session.
34       * 
35       * @param context
36       * @return
37       */
38      String createSessionKey(RequestContext context);
39      
40      /*** 
41       * remove from the cache and invalidate any associated caches or session attributes
42       * 
43       * @param context
44       * @param key
45       */
46      void invalidate(RequestContext context);
47  }