View Javadoc

1   /*
2    * $Id: StrutsStatics.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;
23  
24  
25  /***
26   * Constants used by Struts. The constants can be used to get or set objects
27   * out of the action context or other collections.
28   *
29   * <p/>
30   *
31   * Example:
32   * <ul><code>ActionContext.getContext().put(HTTP_REQUEST, request);</code></ul>
33   * <p/>
34   * or
35   * <p/>
36   * <ul><code>
37   * ActionContext context = ActionContext.getContext();<br>
38   * HttpServletRequest request = (HttpServletRequest)context.get(HTTP_REQUEST);</code></ul>
39   */
40  public interface StrutsStatics {
41  
42      /***
43       * Constant for the HTTP request object.
44       */
45      public static final String HTTP_REQUEST = "com.opensymphony.xwork2.dispatcher.HttpServletRequest";
46  
47      /***
48       * Constant for the HTTP response object.
49       */
50      public static final String HTTP_RESPONSE = "com.opensymphony.xwork2.dispatcher.HttpServletResponse";
51  
52      /***
53       * Constant for an HTTP {@link javax.servlet.RequestDispatcher request dispatcher}.
54       */
55      public static final String SERVLET_DISPATCHER = "com.opensymphony.xwork2.dispatcher.ServletDispatcher";
56  
57      /***
58       * Constant for the {@link javax.servlet.ServletContext servlet context} object.
59       */
60      public static final String SERVLET_CONTEXT = "com.opensymphony.xwork2.dispatcher.ServletContext";
61  
62      /***
63       * Constant for the JSP {@link javax.servlet.jsp.PageContext page context}.
64       */
65      public static final String PAGE_CONTEXT = "com.opensymphony.xwork2.dispatcher.PageContext";
66  
67      /*** Constant for the PortletContext object */
68      public static final String STRUTS_PORTLET_CONTEXT = "struts.portlet.context";
69  }