View Javadoc

1   /*
2    * $Id: RequestAware.java 471756 2006-11-06 15:01:43Z husted $
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   * Actions that want access to the current serlvet request attributes should implement this interface.<p />
28   *
29   * This interface is only relevant if the Action is used in a servlet environment.<p/>
30   *
31   * Note that using this interface makes the Action tied to a servlet environment, so it should be
32   * avoided if possible since things like unit testing will become more difficult.
33   */
34  public interface RequestAware {
35  
36      /***
37       * Sets the Map of request attributes in the implementing class.
38       *
39       * @param request a Map of HTTP request attribute name/value pairs.
40       */
41      public void setRequest(Map request);
42  }