View Javadoc

1   /*
2    * $Id: SessionAware.java 576956 2007-09-18 15:52:26Z jholmes $
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  package org.apache.struts2.interceptor;
22  
23  import java.util.Map;
24  
25  
26  /***
27   * Actions that want access to the user's HTTP session should implement this interface.<p>
28   * <p/>
29   * This will give them access to a Map where they can put objects that can be made available
30   * to subsequent requests.<p/>
31   * <p/>
32   * Typical uses may be cached user data such as name, or a shopping cart.
33   *
34   */
35  public interface SessionAware {
36  
37      /***
38       * Sets the Map of session attributes in the implementing class.
39       *
40       * @param session a Map of HTTP session attribute name/value pairs.
41       */
42      public void setSession(Map session);
43  }