View Javadoc

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