View Javadoc

1   /*
2    * $Id: RequestAware.java 440597 2006-09-06 03:34:39Z wsmoak $
3    *
4    * Copyright 2006 The Apache Software Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *      http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.struts2.interceptor;
19  
20  import java.util.Map;
21  
22  /***
23   * Actions that want access to the current serlvet request attributes should implement this interface.<p />
24   * 
25   * This interface is only relevant if the Action is used in a servlet environment.<p/>
26   * 
27   * Note that using this interface makes the Action tied to a servlet environment, so it should be
28   * avoided if possible since things like unit testing will become more difficult.
29   */
30  public interface RequestAware {
31  
32  	/***
33       * Sets the Map of request attributes in the implementing class.
34       *
35       * @param request a Map of HTTP request attribute name/value pairs.
36       */
37      public void setRequest(Map request);
38  }