A B C D E F G H I J L M N O P R S W

A

ACTION_MAPPING - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Key for the action mapping in the context
ACTION_PARAM - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Action name parameter name
ACTION_RESET - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Key for request attribute indicating if the action has been reset.
actionName - Variable in class org.apache.struts2.portlet.result.PortletActionRedirectResult
 
addCookie(Cookie) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
addDateHeader(String, long) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
addHeader(String, String) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
addIntHeader(String, int) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
addParameter(String, Object) - Method in class org.apache.struts2.portlet.result.PortletActionRedirectResult
Adds a request parameter to be added to the redirect url
available() - Method in class org.apache.struts2.portlet.servlet.PortletServletInputStream
 

B

beforeRenderUrl(UrlProvider) - Method in class org.apache.struts2.components.PortletUrlRenderer
 
buildResourceUrl(String, Map<String, Object>) - Static method in class org.apache.struts2.portlet.util.PortletUrlHelper
Encode an url to a non Struts action resource, like stylesheet, image or servlet.
buildUrl(String, String, String, Map, String, String, String) - Static method in class org.apache.struts2.portlet.util.PortletUrlHelper
Create a portlet URL with for the specified action and namespace.
buildUrl(String, String, String, Map, String, String, String, String, boolean, boolean) - Static method in class org.apache.struts2.portlet.util.PortletUrlHelper
Create a portlet URL with for the specified action and namespace.

C

clear() - Method in class org.apache.struts2.portlet.PortletApplicationMap
Removes all entries from the Map and removes all attributes from the portlet context.
clear() - Method in class org.apache.struts2.portlet.PortletRequestMap
Removes all attributes from the request as well as clears entries in this map.
clear() - Method in class org.apache.struts2.portlet.PortletSessionMap
 
close() - Method in class org.apache.struts2.portlet.servlet.PortletServletInputStream
 
close() - Method in class org.apache.struts2.portlet.servlet.PortletServletOutputStream
 
configuration - Variable in class org.apache.struts2.views.freemarker.PortletFreemarkerResult
 
containsHeader(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
contextDestroyed(ServletContextEvent) - Method in class org.apache.struts2.portlet.context.ServletContextHolderListener
Deprecated.  
contextInitialized(ServletContextEvent) - Method in class org.apache.struts2.portlet.context.ServletContextHolderListener
Deprecated. Stores the reference to the ServletContext.
convertQueryParamsToRenderParams(ActionResponse, String) - Static method in class org.apache.struts2.portlet.result.PortletResult
Converts the query params to render params.
createContext(VelocityManager, ValueStack, HttpServletRequest, HttpServletResponse, String) - Method in class org.apache.struts2.portlet.result.PortletVelocityResult
Creates the VelocityContext that we'll use to render this page.
createContextMap(Map<String, Object>, Map<String, String[]>, Map<String, Object>, Map<String, Object>, PortletRequest, PortletResponse, HttpServletRequest, HttpServletResponse, ServletContext, PortletConfig, Integer) - Method in class org.apache.struts2.portlet.dispatcher.Jsr168Dispatcher
Merges all application and portlet attributes into a single HashMap to represent the entire Action context.
createModel() - Method in class org.apache.struts2.views.freemarker.PortletFreemarkerResult
Build the instance of the ScopesHashModel, including JspTagLib support

Objects added to the model are

Application - servlet context attributes hash model JspTaglibs - jsp tag lib factory model Request - request attributes hash model Session - session attributes hash model request - the HttpServletRequst object for direct access response - the HttpServletResponse object for direct access stack - the OgnLValueStack instance for direct access ognl - the instance of the OgnlTool action - the action itself exception - optional : the JSP or Servlet exception as per the servlet spec (for JSP Exception pages) struts - instance of the StrutsUtil class


D

deduceLocale() - Method in class org.apache.struts2.views.freemarker.PortletFreemarkerResult
Returns the locale used for the Configuration.getTemplate(String, Locale)call.
DEFAULT_ACTION_FOR_MODE - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Key for the default action name for the portlet, stored in the PortletActionContext.
DEFAULT_ACTION_NAME - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Default action name to use when no default action has been configured in the portlet init parameters.
DEFAULT_DISPATCHER_SERVLET_NAME - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Default name of dispatcher servlet in web.xml
DEFAULT_PARAM - Static variable in class org.apache.struts2.portlet.result.PortletActionRedirectResult
The default parameter
destroy() - Method in class org.apache.struts2.portlet.dispatcher.Jsr168Dispatcher
 
DirectRenderFromEventAction - Class in org.apache.struts2.portlet.dispatcher
When a portlet is targetted for an event, the portlet will receive two portlet requests, one for the event phase, and then followed by a render operation.
DirectRenderFromEventAction() - Constructor for class org.apache.struts2.portlet.dispatcher.DirectRenderFromEventAction
 
DISPATCH_TO - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Key for the dispatch instruction for the DispatcherServlet
DispatcherServlet - Class in org.apache.struts2.portlet.dispatcher
 
DispatcherServlet() - Constructor for class org.apache.struts2.portlet.dispatcher.DispatcherServlet
 
doExecute(String, ActionInvocation) - Method in class org.apache.struts2.portlet.result.PortletResult
Execute the result.
doExecute(String, ActionInvocation) - Method in class org.apache.struts2.portlet.result.PortletVelocityResult
 
doExecute(String, ActionInvocation) - Method in class org.apache.struts2.views.freemarker.PortletFreemarkerResult
Execute this result, using the specified template location.
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.struts2.portlet.dispatcher.DispatcherServlet
 

E

encodeRedirectURL(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
encodeRedirectUrl(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
encodeURL(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
encodeUrl(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
ENCODING - Static variable in class org.apache.struts2.portlet.util.PortletUrlHelper
 
ensureParamsAreStringArrays(Map<String, Object>) - Static method in class org.apache.struts2.portlet.util.PortletUrlHelper
Will ensure that all entries in params are String arrays, as requried by the setParameters on the PortletURL.
entrySet() - Method in class org.apache.struts2.portlet.PortletApplicationMap
Creates a Set of all portlet context attributes as well as context init parameters.
entrySet() - Method in class org.apache.struts2.portlet.PortletRequestMap
Returns a Set of attributes from the portlet request.
entrySet() - Method in class org.apache.struts2.portlet.PortletSessionMap
 
ERROR_ACTION - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Name of the action used as error handler
EVENT_ACTION - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Key used for looking up and storing the action that was invoked in the event phase.
EVENT_PHASE - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Constant used for the event phase ( Portlet.processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse))
execute() - Method in class org.apache.struts2.portlet.dispatcher.DirectRenderFromEventAction
Always return success.
execute(ActionInvocation) - Method in class org.apache.struts2.portlet.result.PortletActionRedirectResult
 
executeActionResult(String, ActionInvocation) - Method in class org.apache.struts2.portlet.result.PortletResult
Executes the action result.
executeRenderResult(String) - Method in class org.apache.struts2.portlet.result.PortletResult
Executes the render result.
executeRenderResult(String, ActionInvocation) - Method in class org.apache.struts2.portlet.result.PortletVelocityResult
Creates a Velocity context from the action, loads a Velocity template and executes the template.

F

flush() - Method in class org.apache.struts2.portlet.servlet.PortletServletOutputStream
 
flushBuffer() - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
forward(ServletRequest, ServletResponse) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequestDispatcher
 
freemarkerManager - Variable in class org.apache.struts2.views.freemarker.PortletFreemarkerResult
 

G

get(Object) - Method in class org.apache.struts2.portlet.PortletApplicationMap
Returns the portlet context attribute or init parameter based on the given key.
get(Object) - Method in class org.apache.struts2.portlet.PortletRequestMap
Returns the request attribute associated with the given key or null if it doesn't exist.
get(Object) - Method in class org.apache.struts2.portlet.PortletSessionMap
Returns the session attribute associated with the given key or null if it doesn't exist.
getActionMapping() - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Gets the action mapping for this context
getActionMapping(PortletRequest, HttpServletRequest) - Method in class org.apache.struts2.portlet.dispatcher.Jsr168Dispatcher
Gets the namespace of the action from the request.
getActionRequest() - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Get the ActionRequest.
getActionResponse() - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Get the ActionRequest.
getApplicationMap() - Method in class org.apache.struts2.portlet.dispatcher.Jsr168Dispatcher
Returns a Map of all application attributes.
getAttribute(String) - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 
getAttribute(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getAttribute(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Gets an attribute value on the PortletRequest.
getAttributeNames() - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 
getAttributeNames() - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getAttributeNames() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getAuthType() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getBufferSize() - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
getCharacterEncoding() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Can only be invoked in the event phase.
getCharacterEncoding() - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
getConfiguration() - Method in class org.apache.struts2.views.freemarker.PortletFreemarkerResult
This method is called from PortletFreemarkerResult.doExecute(String, ActionInvocation) to obtain the FreeMarker configuration object that this result will use for template loading.
getContentLength() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Can only be invoked in the event phase.
getContentType(String) - Method in class org.apache.struts2.portlet.result.PortletVelocityResult
Retrieve the content type for this template.
getContentType() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Can only be invoked in the event phase.
getContentType() - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
getContentType() - Method in class org.apache.struts2.views.freemarker.PortletFreemarkerResult
allow parameterization of the contentType the default being text/html
getContext(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getContextPath() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getCookies() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Not allowed in a portlet.
getCreationTime() - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 
getDateHeader(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Not allowed in a portlet.
getDefaultActionForMode() - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Get the default action mapping for the current mode.
getEncoding(String) - Method in class org.apache.struts2.portlet.result.PortletVelocityResult
Retrieve the encoding for this template.
getHeader(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Gets a property from the PortletRequest.
getHeaderNames() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Gets the property names from the PortletRequest.
getHeaders(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Gets the values for the specified property from the PortletRequest.
getId() - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 
getInitParameter(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletConfig
 
getInitParameter(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getInitParameterNames() - Method in class org.apache.struts2.portlet.servlet.PortletServletConfig
 
getInitParameterNames() - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getInputStream() - Method in class org.apache.struts2.portlet.servlet.PortletServletInputStream
Get the wrapped InputStream instance.
getInputStream() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Can only be invoked in the event phase.
getIntHeader(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Not allowed in a portlet.
getLastAccessedTime() - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 
getLocalAddr() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Not allowed in a portlet.
getLocale() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getLocale() - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
getLocales() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getLocalName() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Not allowed in a portlet.
getLocalPort() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Not allowed in a portlet.
getLocation() - Method in class org.apache.struts2.portlet.dispatcher.DirectRenderFromEventAction
Get the location of the view.
getMajorVersion() - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getMap() - Method in class org.apache.struts2.portlet.interceptor.ServletPortletPreferences
 
getMaxInactiveInterval() - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 
getMethod() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getMimeType(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getMinorVersion() - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getModeNamespaceMap() - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Get the namespace to mode mappings.
getNamedDispatcher(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
Returns a PortletServletRequestDispatcher wrapping the PortletRequestDispatcher as a RequestDispatcher instance.
getNames() - Method in class org.apache.struts2.portlet.interceptor.ServletPortletPreferences
 
getObjectWrapper() - Method in class org.apache.struts2.views.freemarker.PortletFreemarkerResult
This method is called from PortletFreemarkerResult.doExecute(String, ActionInvocation) to obtain the FreeMarker object wrapper object that this result will use for adapting objects into template models.
getOutputStream() - Method in class org.apache.struts2.portlet.servlet.PortletServletOutputStream
Get the wrapped OutputStream instance.
getOutputStream() - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
getParameter(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getParameterMap(PortletRequest) - Method in class org.apache.struts2.portlet.dispatcher.Jsr168Dispatcher
Returns a Map of all request parameters.
getParameterMap() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getParameterNames() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getParameterValues(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getPathInfo() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getPathTranslated() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getPhase() - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Get the phase that the portlet is executing in.
getPortletConfig() - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Get the PortletConfig of the portlet that is executing.
getPortletConfig() - Method in class org.apache.struts2.portlet.servlet.PortletServletConfig
Get the wrapped PortletConfig instance.
getPortletContext() - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Get the portlet context.
getPortletContext() - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
Get the wrapped PortletContext instance.
getPortletNamespace() - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Get the action namespace of the portlet.
getPortletRequest() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Get the wrapped PortletRequest instance.
getPortletResponse() - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
getPortletSession() - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
Get the wrapped portlet session.
getProtocol() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Not allowed in a portlet.
getQueryString() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getReader() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Can only be invoked in the event phase.
getRealPath(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getRealPath(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getRemoteAddr() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Not allowed in a portlet.
getRemoteHost() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Not allowed in a portlet.
getRemotePort() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Not allowed in a portlet.
getRemoteUser() - Method in class org.apache.struts2.portlet.interceptor.PortletPrincipalProxy
Gets the user id
getRemoteUser() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getRenderRequest() - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Get the RenderRequest.
getRenderResponse() - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Get the RenderResponse.
getRequest() - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Get the current PortletRequest.
getRequest() - Method in class org.apache.struts2.portlet.interceptor.PortletPrincipalProxy
Deprecated. To obtain the HttpServletRequest in your action, use servlet.ServletRequestAware, since this method will be dropped in future.
getRequestDispatcher(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
Returns a PortletServletRequestDispatcher wrapping the PortletRequestDispatcher as a RequestDispatcher instance.
getRequestDispatcher(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Get the PortletRequestDispatcher as a PortletServletRequestDispatcher instance.
getRequestedSessionId() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getRequestMap(PortletRequest) - Method in class org.apache.struts2.portlet.dispatcher.Jsr168Dispatcher
Returns a Map of all request attributes.
getRequestURI() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Not allowed in a portlet.
getRequestURL() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Not allowed in a portlet.
getResource(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getResourceAsStream(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getResourcePaths(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getResponse() - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Get the current PortletResponse
getScheme() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getServerInfo() - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getServerName() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getServerPort() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Not allowed in a portlet.
getServlet(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getServletContext() - Static method in class org.apache.struts2.portlet.context.ServletContextHolderListener
Deprecated.  
getServletContext() - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 
getServletContext() - Method in class org.apache.struts2.portlet.servlet.PortletServletConfig
Get the PortletContext as a PortletServletContext instance.
getServletContextName() - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getServletName() - Method in class org.apache.struts2.portlet.servlet.PortletServletConfig
Will return the portlet name.
getServletNames() - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getServletPath() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
A PortletRequest has no servlet path.
getServlets() - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
getSession() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Get the PortletSession as a PortletHttpSession instance.
getSession(boolean) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Get the PortletSession as a PortletHttpSession instance.
getSessionContext() - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 
getSessionMap(PortletRequest) - Method in class org.apache.struts2.portlet.dispatcher.Jsr168Dispatcher
Returns a Map of all session attributes.
getTemplate(ValueStack, VelocityEngine, ActionInvocation, String, String) - Method in class org.apache.struts2.portlet.result.PortletVelocityResult
Given a value stack, a Velocity engine, and an action invocation, this method returns the appropriate Velocity template to render.
getUserPrincipal() - Method in class org.apache.struts2.portlet.interceptor.PortletPrincipalProxy
Gets the user principal
getUserPrincipal() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
getValue(String, String) - Method in class org.apache.struts2.portlet.interceptor.ServletPortletPreferences
 
getValue(String) - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 
getValueNames() - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 
getValues(String, String[]) - Method in class org.apache.struts2.portlet.interceptor.ServletPortletPreferences
 
getWriter() - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
getWriter() - Method in class org.apache.struts2.views.freemarker.PortletFreemarkerResult
The default writer writes directly to the response writer.

H

handle(ReflectionException) - Method in class org.apache.struts2.portlet.result.PortletActionRedirectResult
 

I

include(ServletRequest, ServletResponse) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequestDispatcher
 
init(ServletConfig) - Method in class org.apache.struts2.portlet.context.PreparatorServlet
Deprecated.  
init(PortletConfig) - Method in class org.apache.struts2.portlet.dispatcher.Jsr168Dispatcher
Initialize the portlet with the init parameters from portlet.xml
intercept(ActionInvocation) - Method in class org.apache.struts2.portlet.interceptor.PortletAwareInterceptor
Sets action properties based on the interfaces an action implements.
intercept(ActionInvocation) - Method in class org.apache.struts2.portlet.interceptor.PortletStateInterceptor
 
invalidate() - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 
invocation - Variable in class org.apache.struts2.views.freemarker.PortletFreemarkerResult
 
isCommitted() - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
isEvent() - Static method in class org.apache.struts2.portlet.context.PortletActionContext
 
isNew() - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 
isPortletRequest() - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Check to see if the current request is a portlet request.
isReadOnly(String) - Method in class org.apache.struts2.portlet.interceptor.ServletPortletPreferences
 
isRender() - Static method in class org.apache.struts2.portlet.context.PortletActionContext
 
isRequestedSessionIdFromCookie() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Not allowed in a portlet.
isRequestedSessionIdFromURL() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Not allowed in a portlet.
isRequestedSessionIdFromUrl() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Not allowed in a portlet.
isRequestedSessionIdValid() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
isRequestSecure() - Method in class org.apache.struts2.portlet.interceptor.PortletPrincipalProxy
Is the request using https?
isSecure() - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
isUserInRole(String) - Method in class org.apache.struts2.portlet.interceptor.PortletPrincipalProxy
True if the user is in the given role
isUserInRole(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 

J

Jsr168Dispatcher - Class in org.apache.struts2.portlet.dispatcher
 
Jsr168Dispatcher() - Constructor for class org.apache.struts2.portlet.dispatcher.Jsr168Dispatcher
 

L

location - Variable in class org.apache.struts2.views.freemarker.PortletFreemarkerResult
 
log(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
log(Exception, String) - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
log(String, Throwable) - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 

M

mark(int) - Method in class org.apache.struts2.portlet.servlet.PortletServletInputStream
 
markSupported() - Method in class org.apache.struts2.portlet.servlet.PortletServletInputStream
 
method - Variable in class org.apache.struts2.portlet.result.PortletActionRedirectResult
 
MODE_NAMESPACE_MAP - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Key for the mode-to-namespace map stored in the PortletActionContext.
MODE_PARAM - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Key for parameter holding the last executed portlet mode.

N

namespace - Variable in class org.apache.struts2.portlet.result.PortletActionRedirectResult
 

O

org.apache.struts2.components - package org.apache.struts2.components
 
org.apache.struts2.portlet - package org.apache.struts2.portlet
 
org.apache.struts2.portlet.context - package org.apache.struts2.portlet.context
 
org.apache.struts2.portlet.dispatcher - package org.apache.struts2.portlet.dispatcher
 
org.apache.struts2.portlet.interceptor - package org.apache.struts2.portlet.interceptor
 
org.apache.struts2.portlet.result - package org.apache.struts2.portlet.result
 
org.apache.struts2.portlet.servlet - package org.apache.struts2.portlet.servlet
Portlet wrapper objects for some of the servlet api objects.
org.apache.struts2.portlet.util - package org.apache.struts2.portlet.util
 
org.apache.struts2.views.freemarker - package org.apache.struts2.views.freemarker
 

P

PHASE - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Key used for looking up and storing the portlet phase
PORTLET_CONFIG - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Key used for looking up and storing the PortletConfig
PORTLET_NAMESPACE - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Key for the portlet namespace stored in the PortletActionContext.
PortletActionConstants - Interface in org.apache.struts2.portlet
Interface defining some constants used in the Struts portlet implementation
PortletActionContext - Class in org.apache.struts2.portlet.context
PortletActionContext.
PortletActionContext() - Constructor for class org.apache.struts2.portlet.context.PortletActionContext
 
PortletActionRedirectResult - Class in org.apache.struts2.portlet.result
Portlet modification of the ServletActionRedirectResult.
PortletActionRedirectResult() - Constructor for class org.apache.struts2.portlet.result.PortletActionRedirectResult
 
PortletActionRedirectResult(String) - Constructor for class org.apache.struts2.portlet.result.PortletActionRedirectResult
 
PortletActionRedirectResult(String, String) - Constructor for class org.apache.struts2.portlet.result.PortletActionRedirectResult
 
PortletActionRedirectResult(String, String, String) - Constructor for class org.apache.struts2.portlet.result.PortletActionRedirectResult
 
PortletApplicationMap - Class in org.apache.struts2.portlet
Portlet specific Map implementation representing the PortletContext of a Portlet.
PortletApplicationMap(PortletContext) - Constructor for class org.apache.struts2.portlet.PortletApplicationMap
Creates a new map object given the PortletContext.
PortletAwareInterceptor - Class in org.apache.struts2.portlet.interceptor
 
PortletAwareInterceptor() - Constructor for class org.apache.struts2.portlet.interceptor.PortletAwareInterceptor
 
PortletConfigAware - Interface in org.apache.struts2.portlet.interceptor
Actions that wants a reference to the PortletConfig object can implement this interface.
PortletContextAware - Interface in org.apache.struts2.portlet.interceptor
 
PortletFreemarkerResult - Class in org.apache.struts2.views.freemarker
 
PortletFreemarkerResult() - Constructor for class org.apache.struts2.views.freemarker.PortletFreemarkerResult
 
PortletFreemarkerResult(String) - Constructor for class org.apache.struts2.views.freemarker.PortletFreemarkerResult
 
PortletHttpSession - Class in org.apache.struts2.portlet.servlet
Wrapper object exposing a PortletSession as a HttpSession instance.
PortletHttpSession(PortletSession) - Constructor for class org.apache.struts2.portlet.servlet.PortletHttpSession
 
portletMode - Variable in class org.apache.struts2.portlet.result.PortletResult
 
PortletPreferencesAware - Interface in org.apache.struts2.portlet.interceptor
All Actions that want to have access to the portlet preferences should implement this interface.
PortletPrincipalProxy - Class in org.apache.struts2.portlet.interceptor
PrincipalProxy implementation for using PortletRequest Principal related methods.
PortletPrincipalProxy(PortletRequest) - Constructor for class org.apache.struts2.portlet.interceptor.PortletPrincipalProxy
Constructs a proxy
PortletRequestAware - Interface in org.apache.struts2.portlet.interceptor
 
PortletRequestMap - Class in org.apache.struts2.portlet
A simple implementation of the Map interface to handle a collection of request attributes.
PortletRequestMap(PortletRequest) - Constructor for class org.apache.struts2.portlet.PortletRequestMap
Saves the request to use as the backing for getting and setting values
PortletResponseAware - Interface in org.apache.struts2.portlet.interceptor
 
PortletResult - Class in org.apache.struts2.portlet.result
Result type that includes a JSP to render.
PortletResult() - Constructor for class org.apache.struts2.portlet.result.PortletResult
 
PortletResult(String) - Constructor for class org.apache.struts2.portlet.result.PortletResult
 
PortletServletConfig - Class in org.apache.struts2.portlet.servlet
Wrapper object exposing a PortletConfig as a ServletConfig instance.
PortletServletConfig(PortletConfig) - Constructor for class org.apache.struts2.portlet.servlet.PortletServletConfig
 
PortletServletContext - Class in org.apache.struts2.portlet.servlet
Wrapper object exposing a PortletContext as a ServletContext instance.
PortletServletContext(PortletContext) - Constructor for class org.apache.struts2.portlet.servlet.PortletServletContext
 
PortletServletInputStream - Class in org.apache.struts2.portlet.servlet
Wrapper object exposing a InputStream from a portlet as a ServletInputStream instance.
PortletServletInputStream(InputStream) - Constructor for class org.apache.struts2.portlet.servlet.PortletServletInputStream
 
PortletServletOutputStream - Class in org.apache.struts2.portlet.servlet
Wrapper object exposing a OutputStream from a portlet as a ServletOutputStream instance.
PortletServletOutputStream(OutputStream) - Constructor for class org.apache.struts2.portlet.servlet.PortletServletOutputStream
 
PortletServletRequest - Class in org.apache.struts2.portlet.servlet
Wrapper object exposing a PortletRequest as a HttpServletRequest instance.
PortletServletRequest(PortletRequest, PortletContext) - Constructor for class org.apache.struts2.portlet.servlet.PortletServletRequest
 
PortletServletRequestDispatcher - Class in org.apache.struts2.portlet.servlet
 
PortletServletRequestDispatcher(PortletRequestDispatcher) - Constructor for class org.apache.struts2.portlet.servlet.PortletServletRequestDispatcher
 
PortletServletResponse - Class in org.apache.struts2.portlet.servlet
 
PortletServletResponse(PortletResponse) - Constructor for class org.apache.struts2.portlet.servlet.PortletServletResponse
 
PortletSessionMap - Class in org.apache.struts2.portlet
A simple implementation of the Map interface to handle a collection of portlet session attributes.
PortletSessionMap(PortletRequest) - Constructor for class org.apache.struts2.portlet.PortletSessionMap
Creates a new session map given a portlet request.
PortletStateInterceptor - Class in org.apache.struts2.portlet.interceptor
 
PortletStateInterceptor() - Constructor for class org.apache.struts2.portlet.interceptor.PortletStateInterceptor
 
PortletUrlHelper - Class in org.apache.struts2.portlet.util
Helper class for creating Portlet URLs.
PortletUrlHelper() - Constructor for class org.apache.struts2.portlet.util.PortletUrlHelper
 
PortletUrlRenderer - Class in org.apache.struts2.components
Implementation of the UrlRenderer interface that renders URLs for portlet environments.
PortletUrlRenderer() - Constructor for class org.apache.struts2.components.PortletUrlRenderer
 
PortletVelocityResult - Class in org.apache.struts2.portlet.result
Using the Servlet container's JspFactory, this result mocks a JSP execution environment and then displays a Velocity template that will be streamed directly to the servlet output.
PortletVelocityResult() - Constructor for class org.apache.struts2.portlet.result.PortletVelocityResult
 
PortletVelocityResult(String) - Constructor for class org.apache.struts2.portlet.result.PortletVelocityResult
 
postTemplateProcess(Template, TemplateModel) - Method in class org.apache.struts2.views.freemarker.PortletFreemarkerResult
the default implementation of postTemplateProcess applies the contentType parameter
PreparatorServlet - Class in org.apache.struts2.portlet.context
Deprecated. This servlet has been deprecated. Do not use it (WW-2101)
PreparatorServlet() - Constructor for class org.apache.struts2.portlet.context.PreparatorServlet
Deprecated.  
preTemplateProcess(Template, TemplateModel) - Method in class org.apache.struts2.views.freemarker.PortletFreemarkerResult
Called before the execution is passed to template.process().
processAction(ActionRequest, ActionResponse) - Method in class org.apache.struts2.portlet.dispatcher.Jsr168Dispatcher
Service an action from the event phase.
prohibitedResultParam - Variable in class org.apache.struts2.portlet.result.PortletActionRedirectResult
 
put(Object, Object) - Method in class org.apache.struts2.portlet.PortletApplicationMap
Sets a portlet context attribute given a attribute name and value.
put(Object, Object) - Method in class org.apache.struts2.portlet.PortletRequestMap
Saves an attribute in the request.
put(Object, Object) - Method in class org.apache.struts2.portlet.PortletSessionMap
Saves an attribute in the session.
putValue(String, Object) - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 

R

read() - Method in class org.apache.struts2.portlet.servlet.PortletServletInputStream
 
read(byte[], int, int) - Method in class org.apache.struts2.portlet.servlet.PortletServletInputStream
 
read(byte[]) - Method in class org.apache.struts2.portlet.servlet.PortletServletInputStream
 
remove(Object) - Method in class org.apache.struts2.portlet.PortletApplicationMap
Removes the specified portlet context attribute.
remove(Object) - Method in class org.apache.struts2.portlet.PortletRequestMap
Removes the specified request attribute.
remove(Object) - Method in class org.apache.struts2.portlet.PortletSessionMap
Removes the specified session attribute.
removeAttribute(String) - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 
removeAttribute(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
removeAttribute(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
removeValue(String) - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 
render(RenderRequest, RenderResponse) - Method in class org.apache.struts2.portlet.dispatcher.Jsr168Dispatcher
Service an action from the render phase.
RENDER_DIRECT_LOCATION - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Key for session attribute indicating the location of the render direct action.
RENDER_PHASE - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Constant used for the render phase ( Portlet.render(javax.portlet.RenderRequest, javax.portlet.RenderResponse))
renderFormUrl(Form) - Method in class org.apache.struts2.components.PortletUrlRenderer
renderUrl(Writer, UrlProvider) - Method in class org.apache.struts2.components.PortletUrlRenderer
REQUEST - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Key used for looking up and storing the PortletRequest
reset(String) - Method in class org.apache.struts2.portlet.interceptor.ServletPortletPreferences
 
reset() - Method in class org.apache.struts2.portlet.servlet.PortletServletInputStream
 
reset() - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
resetBuffer() - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
RESPONSE - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Key used for looking up and storing the PortletResponse

S

sendError(int) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
sendError(int, String) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
sendRedirect(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
serviceAction(PortletRequest, PortletResponse, Map<String, Object>, Map<String, String[]>, Map<String, Object>, Map<String, Object>, String, Integer) - Method in class org.apache.struts2.portlet.dispatcher.Jsr168Dispatcher
Loads the action and executes it.
ServletContextHolderListener - Class in org.apache.struts2.portlet.context
Deprecated. This listener has been deprecated. Do not use it. (WW-2101)
ServletContextHolderListener() - Constructor for class org.apache.struts2.portlet.context.ServletContextHolderListener
Deprecated.  
ServletPortletPreferences - Class in org.apache.struts2.portlet.interceptor
Simple portlet preferences implementation that uses a map in the Session as storage.
ServletPortletPreferences(Map) - Constructor for class org.apache.struts2.portlet.interceptor.ServletPortletPreferences
 
setActionMapper(ActionMapper) - Method in class org.apache.struts2.components.PortletUrlRenderer
 
setActionMapper(ActionMapper) - Method in class org.apache.struts2.portlet.dispatcher.Jsr168Dispatcher
 
setActionMapper(ActionMapper) - Method in class org.apache.struts2.portlet.result.PortletActionRedirectResult
 
setActionName(String) - Method in class org.apache.struts2.portlet.result.PortletActionRedirectResult
Sets the action name
setActionProxyFactory(ActionProxyFactory) - Method in class org.apache.struts2.portlet.dispatcher.Jsr168Dispatcher
Convenience method to ease testing.
setAttribute(String, Object) - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 
setAttribute(String, Object) - Method in class org.apache.struts2.portlet.servlet.PortletServletContext
 
setAttribute(String, Object) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
setBufferSize(int) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
setCharacterEncoding(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
Can only be invoked in the event phase.
setCharacterEncoding(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
setContentLength(int) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
setContentType(String) - Method in class org.apache.struts2.portlet.result.PortletResult
Sets the content type.
setContentType(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
setContentType(String) - Method in class org.apache.struts2.views.freemarker.PortletFreemarkerResult
 
setDateHeader(String, long) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
setDefaultEncoding(String) - Method in class org.apache.struts2.portlet.result.PortletVelocityResult
 
setDispatcherServletName(String) - Method in class org.apache.struts2.portlet.result.PortletResult
 
setExtension(String) - Method in class org.apache.struts2.portlet.servlet.PortletServletRequest
 
setFreemarkerManager(FreemarkerManager) - Method in class org.apache.struts2.views.freemarker.PortletFreemarkerResult
 
setHeader(String, String) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
setIntHeader(String, int) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
setLocale(Locale) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
setMaxInactiveInterval(int) - Method in class org.apache.struts2.portlet.servlet.PortletHttpSession
 
setMethod(String) - Method in class org.apache.struts2.portlet.result.PortletActionRedirectResult
Sets the method
setNamespace(String) - Method in class org.apache.struts2.portlet.result.PortletActionRedirectResult
Sets the namespace
setPortletConfig(PortletConfig) - Method in interface org.apache.struts2.portlet.interceptor.PortletConfigAware
 
setPortletContext(PortletContext) - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Convenience setter for the portlet context.
setPortletContext(PortletContext) - Method in interface org.apache.struts2.portlet.interceptor.PortletContextAware
 
setPortletMode(String) - Method in class org.apache.struts2.portlet.result.PortletResult
 
setPortletPreferences(PortletPreferences) - Method in interface org.apache.struts2.portlet.interceptor.PortletPreferencesAware
Sets the HTTP request object in implementing classes.
setPortletRequest(PortletRequest) - Method in interface org.apache.struts2.portlet.interceptor.PortletRequestAware
 
setPortletResponse(PortletResponse) - Method in interface org.apache.struts2.portlet.interceptor.PortletResponseAware
 
setRequest(PortletRequest) - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Convenience setter for the portlet request.
setResponse(PortletResponse) - Static method in class org.apache.struts2.portlet.context.PortletActionContext
Convenience setter for the portlet response.
setServletRenderer(UrlRenderer) - Method in class org.apache.struts2.components.PortletUrlRenderer
 
setSession(Map) - Method in class org.apache.struts2.portlet.dispatcher.DirectRenderFromEventAction
 
setStatus(int) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
setStatus(int, String) - Method in class org.apache.struts2.portlet.servlet.PortletServletResponse
 
setTitle(String) - Method in class org.apache.struts2.portlet.result.PortletResult
Sets the title.
setUseDispatcherServlet(String) - Method in class org.apache.struts2.portlet.result.PortletResult
 
setValue(String, String) - Method in class org.apache.struts2.portlet.interceptor.ServletPortletPreferences
 
setValues(String, String[]) - Method in class org.apache.struts2.portlet.interceptor.ServletPortletPreferences
 
setVelocityManager(VelocityManager) - Method in class org.apache.struts2.portlet.result.PortletVelocityResult
 
skip(long) - Method in class org.apache.struts2.portlet.servlet.PortletServletInputStream
 
STACK_FROM_EVENT_PHASE - Static variable in interface org.apache.struts2.portlet.PortletActionConstants
Session key where the value stack from the event phase is stored.
store() - Method in class org.apache.struts2.portlet.interceptor.ServletPortletPreferences
 

W

wrapper - Variable in class org.apache.struts2.views.freemarker.PortletFreemarkerResult
 
write(int) - Method in class org.apache.struts2.portlet.servlet.PortletServletOutputStream
 
write(byte[]) - Method in class org.apache.struts2.portlet.servlet.PortletServletOutputStream
 
write(byte[], int, int) - Method in class org.apache.struts2.portlet.servlet.PortletServletOutputStream
 

A B C D E F G H I J L M N O P R S W

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.