View Javadoc

    1   /*
    2    * $Id: PortletActionConstants.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.portlet;
    22
    23  /***
    24   * Interface defining some constants used in the Struts portlet implementation
    25   *
    26   */
    27  public interface PortletActionConstants {
    28      /***
    29       * Default action name to use when no default action has been configured in the portlet
    30       * init parameters.
    31       */
    32      String DEFAULT_ACTION_NAME = "default";
    33
    34      /***
    35       * Action name parameter name
    36       */
    37      String ACTION_PARAM = "struts.portlet.action";
    38
    39      /***
    40       * Key for parameter holding the last executed portlet mode.
    41       */
    42      String MODE_PARAM = "struts.portlet.mode";
    43
    44      /***
    45       * Key used for looking up and storing the portlet phase
    46       */
    47      String PHASE = "struts.portlet.phase";
    48
    49      /***
    50       * Constant used for the render phase (
    51       * {@link javax.portlet.Portlet#render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)})
    52       */
    53      Integer RENDER_PHASE = new Integer(1);
    54
    55      /***
    56       * Constant used for the event phase (
    57       * {@link javax.portlet.Portlet#processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)})
    58       */
    59      Integer EVENT_PHASE = new Integer(2);
    60
    61      /***
    62       * Key used for looking up and storing the
    63       * {@link javax.portlet.PortletRequest}
    64       */
    65      String REQUEST = "struts.portlet.request";
    66
    67      /***
    68       * Key used for looking up and storing the
    69       * {@link javax.portlet.PortletResponse}
    70       */
    71      String RESPONSE = "struts.portlet.response";
    72
    73      /***
    74       * Key used for looking up and storing the action that was invoked in the event phase.
    75       */
    76      String EVENT_ACTION = "struts.portlet.eventAction";
    77
    78      /***
    79       * Key used for looking up and storing the
    80       * {@link javax.portlet.PortletConfig}
    81       */
    82      String PORTLET_CONFIG = "struts.portlet.config";
    83
    84      /***
    85       * Name of the action used as error handler
    86       */
    87      String ERROR_ACTION = "errorHandler";
    88
    89      /***
    90       * Key for the portlet namespace stored in the
    91       * {@link org.apache.struts2.portlet.context.PortletActionContext}.
    92       */
    93      String PORTLET_NAMESPACE = "struts.portlet.portletNamespace";
    94
    95      /***
    96       * Key for the mode-to-namespace map stored in the
    97       * {@link org.apache.struts2.portlet.context.PortletActionContext}.
    98       */
    99      String MODE_NAMESPACE_MAP = "struts.portlet.modeNamespaceMap";
    100
    101     /***
    102      * Key for the default action name for the portlet, stored in the
    103      * {@link org.apache.struts2.portlet.context.PortletActionContext}.
    104      */
    105     String DEFAULT_ACTION_FOR_MODE = "struts.portlet.defaultActionForMode";
    106 }