View Javadoc

1   /*
2    * $Id: PortletActionConstants.java 671156 2008-06-24 12:33:59Z nilsga $
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.portlet;
23  
24  import org.apache.struts2.ServletActionContext;
25  import org.apache.struts2.portlet.dispatcher.DispatcherServlet;
26  
27  /***
28   * Interface defining some constants used in the Struts portlet implementation
29   *
30   */
31  public interface PortletActionConstants {
32      /***
33       * Default action name to use when no default action has been configured in the portlet
34       * init parameters.
35       */
36      String DEFAULT_ACTION_NAME = "default";
37  
38      /***
39       * Action name parameter name
40       */
41      String ACTION_PARAM = "struts.portlet.action";
42  
43      /***
44       * Key for parameter holding the last executed portlet mode.
45       */
46      String MODE_PARAM = "struts.portlet.mode";
47  
48      /***
49       * Key used for looking up and storing the portlet phase
50       */
51      String PHASE = "struts.portlet.phase";
52  
53      /***
54       * Constant used for the render phase (
55       * {@link javax.portlet.Portlet#render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)})
56       */
57      Integer RENDER_PHASE = new Integer(1);
58  
59      /***
60       * Constant used for the event phase (
61       * {@link javax.portlet.Portlet#processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)})
62       */
63      Integer EVENT_PHASE = new Integer(2);
64  
65      /***
66       * Key used for looking up and storing the
67       * {@link javax.portlet.PortletRequest}
68       */
69      String REQUEST = "struts.portlet.request";
70  
71      /***
72       * Key used for looking up and storing the
73       * {@link javax.portlet.PortletResponse}
74       */
75      String RESPONSE = "struts.portlet.response";
76  
77      /***
78       * Key used for looking up and storing the action that was invoked in the event phase.
79       */
80      String EVENT_ACTION = "struts.portlet.eventAction";
81  
82      /***
83       * Key used for looking up and storing the
84       * {@link javax.portlet.PortletConfig}
85       */
86      String PORTLET_CONFIG = "struts.portlet.config";
87  
88      /***
89       * Name of the action used as error handler
90       */
91      String ERROR_ACTION = "errorHandler";
92  
93      /***
94       * Key for the portlet namespace stored in the
95       * {@link org.apache.struts2.portlet.context.PortletActionContext}.
96       */
97      String PORTLET_NAMESPACE = "struts.portlet.portletNamespace";
98  
99      /***
100      * Key for the mode-to-namespace map stored in the
101      * {@link org.apache.struts2.portlet.context.PortletActionContext}.
102      */
103     String MODE_NAMESPACE_MAP = "struts.portlet.modeNamespaceMap";
104 
105     /***
106      * Key for the default action name for the portlet, stored in the
107      * {@link org.apache.struts2.portlet.context.PortletActionContext}.
108      */
109     String DEFAULT_ACTION_FOR_MODE = "struts.portlet.defaultActionForMode";
110     
111     /***
112      * Key for request attribute indicating if the action has been reset. 
113      */
114     String ACTION_RESET = "struts.portlet.actionReset";
115     
116     /***
117      * Key for session attribute indicating the location of the render direct action.
118      */
119     String RENDER_DIRECT_LOCATION = "struts.portlet.renderDirectLocation";
120     
121     /***
122      * Key for the dispatch instruction for the {@link DispatcherServlet}
123      */
124 	String DISPATCH_TO = "struts.portlet.dispatchTo";
125 	
126 	/***
127 	 * Session key where the value stack from the event phase is stored.
128 	 */
129 	String STACK_FROM_EVENT_PHASE = "struts.portlet.valueStackFromEventPhase";
130 
131 	/***
132 	 * Default name of dispatcher servlet in web.xml
133 	 */
134 	String DEFAULT_DISPATCHER_SERVLET_NAME = "Struts2PortletDispatcherServlet";
135 	
136 	/***
137 	 * Key for the action mapping in the context
138     */
139 	String ACTION_MAPPING = ServletActionContext.ACTION_MAPPING;
140 }