View Javadoc

1   /*
2    * $Id: SessionAware.java 651946 2008-04-27 13:41:38Z apetrelli $
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  package org.apache.struts2.interceptor;
23  
24  import java.util.Map;
25  
26  
27  /***
28   * Actions that want access to the user's HTTP session attributes should implement this interface.<p>
29   * <p/>
30   * This will give them access to a Map where they can put objects that can be made available
31   * to subsequent requests.<p/>
32   * <p/>
33   * Typical uses may be cached user data such as name, or a shopping cart.
34   *
35   */
36  public interface SessionAware {
37  
38      /***
39       * Sets the Map of session attributes in the implementing class.
40       *
41       * @param session a Map of HTTP session attribute name/value pairs.
42       */
43      public void setSession(Map<String,Object> session);
44  }