org.apache.portals.bridges.struts
Class StrutsPortlet

java.lang.Object
  javax.portlet.GenericPortlet
      org.apache.portals.bridges.struts.StrutsPortlet

All Implemented Interfaces:

javax.portlet.Portlet, javax.portlet.PortletConfig

public class StrutsPortlet
extends javax.portlet.GenericPortlet

StrutsPortlet

Version:

$Id: StrutsPortlet.java 549654 2007-06-22 00:52:52Z ate $

Author:

Ate Douma

Field Summary

static java.lang.String	ACTION_REQUEST
static java.lang.String	CUSTOM_REQUEST
static java.lang.String	DEFAULT_STRUTS_PORTLET_CONFIG_LOCATION
static java.lang.String	EDIT_REQUEST
static java.lang.String	ERROR_CONTEXT
static java.lang.String	HELP_REQUEST
static java.lang.String	ORIGIN_URL
static java.lang.String	PAGE_URL
static java.lang.String	PARAM_ACTION_PAGE Name of portlet preference for Action page
static java.lang.String	PARAM_CUSTOM_PAGE Name of portlet preference for Custom page
static java.lang.String	PARAM_EDIT_PAGE Name of portlet preference for Edit page
static java.lang.String	PARAM_HELP_PAGE Name of portlet preference for Edit page
static java.lang.String	PARAM_SERVLET_CONTEXT_PROVIDER Name of class implementing ServletContextProvider
static java.lang.String	PARAM_VIEW_PAGE Name of portlet preference for View page
static java.lang.String	PORTLET_NAME
static java.lang.String	PORTLET_SCOPE_STRUTS_SESSION
static java.lang.String	REDIRECT_PAGE_URL
static java.lang.String	REDIRECT_URL
static java.lang.String	RENDER_CONTEXT
static java.lang.String	REQUEST_TYPE
static java.lang.String	SERVLET_PORTLET_APPLICATION_SESSION
static java.lang.String	SERVLET_PORTLET_SESSION_PROXY
static java.lang.String	STRUTS_PORTLET_CONFIG
static java.lang.String	STRUTS_PORTLET_CONFIG_LOCATION Name of portlet preference for Struts Portlet Config Location
static java.lang.String	VIEW_REQUEST

Constructor Summary

StrutsPortlet()

Method Summary

void	doCustom(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
void	doEdit(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
void	doHelp(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
void	doView(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
protected java.lang.String	getActionPageParameter(javax.portlet.PortletConfig config)
javax.servlet.http.HttpSession	getApplicationSession(javax.servlet.http.HttpServletRequest request)
protected java.lang.String	getContextProviderClassNameParameter(javax.portlet.PortletConfig config)
protected java.lang.String	getCustomPageParameter(javax.portlet.PortletConfig config)
protected java.lang.String	getEditPageParameter(javax.portlet.PortletConfig config)
protected java.lang.String	getHelpPageParameter(javax.portlet.PortletConfig config)
protected javax.servlet.http.HttpServletRequest	getHttpServletRequest(javax.portlet.GenericPortlet portlet, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)
protected javax.servlet.http.HttpServletResponse	getHttpServletResponse(javax.portlet.GenericPortlet portlet, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)
protected java.lang.String	getKeepRenderAttributes(javax.portlet.PortletRequest request)
protected java.lang.Boolean	getPortletScopeStrutsSessionParameter(javax.portlet.PortletConfig config)
protected javax.servlet.ServletContext	getServletContext(javax.portlet.GenericPortlet portlet, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)
protected ServletContextProvider	getServletContextProvider()
protected java.lang.String	getStrutsOriginURL(javax.portlet.PortletRequest request)
protected java.lang.String	getStrutsPageURL(javax.portlet.PortletRequest request)
protected java.lang.String	getStrutsPortletConfigLocationParameter(javax.portlet.PortletConfig config)
protected java.lang.String	getViewPageParameter(javax.portlet.PortletConfig config)
void	init(javax.portlet.PortletConfig config)
void	processAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response)
protected void	processRequest(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, java.lang.String defaultPage, java.lang.String requestType)
protected void	renderError(javax.servlet.http.HttpServletResponse response, StrutsPortletErrorContext errorContext)

Methods inherited from class javax.portlet.GenericPortlet

destroy, doDispatch, getInitParameter, getInitParameterNames, getPortletConfig, getPortletContext, getPortletName, getResourceBundle, getTitle, init, render

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARAM_SERVLET_CONTEXT_PROVIDER

public static final java.lang.String PARAM_SERVLET_CONTEXT_PROVIDER

Name of class implementing ServletContextProvider

See Also:

Constant Field Values

STRUTS_PORTLET_CONFIG_LOCATION

public static final java.lang.String STRUTS_PORTLET_CONFIG_LOCATION

Name of portlet preference for Struts Portlet Config Location

See Also:

Constant Field Values

PORTLET_SCOPE_STRUTS_SESSION

public static final java.lang.String PORTLET_SCOPE_STRUTS_SESSION

See Also:

Constant Field Values

PARAM_ACTION_PAGE

public static final java.lang.String PARAM_ACTION_PAGE

Name of portlet preference for Action page

See Also:

Constant Field Values

PARAM_CUSTOM_PAGE

public static final java.lang.String PARAM_CUSTOM_PAGE

Name of portlet preference for Custom page

See Also:

Constant Field Values

PARAM_EDIT_PAGE

public static final java.lang.String PARAM_EDIT_PAGE

Name of portlet preference for Edit page

See Also:

Constant Field Values

PARAM_HELP_PAGE

public static final java.lang.String PARAM_HELP_PAGE

Name of portlet preference for Edit page

See Also:

Constant Field Values

PARAM_VIEW_PAGE

public static final java.lang.String PARAM_VIEW_PAGE

Name of portlet preference for View page

See Also:

Constant Field Values

REQUEST_TYPE

public static final java.lang.String REQUEST_TYPE

See Also:

Constant Field Values

PAGE_URL

public static final java.lang.String PAGE_URL

See Also:

Constant Field Values

ORIGIN_URL

public static final java.lang.String ORIGIN_URL

See Also:

Constant Field Values

REDIRECT_PAGE_URL

public static final java.lang.String REDIRECT_PAGE_URL

See Also:

Constant Field Values

REDIRECT_URL

public static final java.lang.String REDIRECT_URL

See Also:

Constant Field Values

RENDER_CONTEXT

public static final java.lang.String RENDER_CONTEXT

See Also:

Constant Field Values

ERROR_CONTEXT

public static final java.lang.String ERROR_CONTEXT

See Also:

Constant Field Values

PORTLET_NAME

public static final java.lang.String PORTLET_NAME

See Also:

Constant Field Values

STRUTS_PORTLET_CONFIG

public static final java.lang.String STRUTS_PORTLET_CONFIG

See Also:

Constant Field Values

DEFAULT_STRUTS_PORTLET_CONFIG_LOCATION

public static final java.lang.String DEFAULT_STRUTS_PORTLET_CONFIG_LOCATION

See Also:

Constant Field Values

SERVLET_PORTLET_SESSION_PROXY

public static final java.lang.String SERVLET_PORTLET_SESSION_PROXY

See Also:

Constant Field Values

SERVLET_PORTLET_APPLICATION_SESSION

public static final java.lang.String SERVLET_PORTLET_APPLICATION_SESSION

See Also:

Constant Field Values

ACTION_REQUEST

public static final java.lang.String ACTION_REQUEST

See Also:

Constant Field Values

VIEW_REQUEST

public static final java.lang.String VIEW_REQUEST

See Also:

Constant Field Values

CUSTOM_REQUEST

public static final java.lang.String CUSTOM_REQUEST

See Also:

Constant Field Values

EDIT_REQUEST

public static final java.lang.String EDIT_REQUEST

See Also:

Constant Field Values

HELP_REQUEST

public static final java.lang.String HELP_REQUEST

See Also:

Constant Field Values

Constructor Detail

StrutsPortlet

public StrutsPortlet()

Method Detail

init

public void init(javax.portlet.PortletConfig config)
          throws javax.portlet.PortletException

Specified by:

init in interface javax.portlet.Portlet

Overrides:

init in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

getContextProviderClassNameParameter

protected java.lang.String getContextProviderClassNameParameter(javax.portlet.PortletConfig config)

getServletContextProvider

protected ServletContextProvider getServletContextProvider()

getServletContext

protected javax.servlet.ServletContext getServletContext(javax.portlet.GenericPortlet portlet,
                                                         javax.portlet.PortletRequest request,
                                                         javax.portlet.PortletResponse response)

getHttpServletRequest

protected javax.servlet.http.HttpServletRequest getHttpServletRequest(javax.portlet.GenericPortlet portlet,
                                                                      javax.portlet.PortletRequest request,
                                                                      javax.portlet.PortletResponse response)

getHttpServletResponse

protected javax.servlet.http.HttpServletResponse getHttpServletResponse(javax.portlet.GenericPortlet portlet,
                                                                        javax.portlet.PortletRequest request,
                                                                        javax.portlet.PortletResponse response)

getStrutsPageURL

protected java.lang.String getStrutsPageURL(javax.portlet.PortletRequest request)

getStrutsOriginURL

protected java.lang.String getStrutsOriginURL(javax.portlet.PortletRequest request)

getKeepRenderAttributes

protected java.lang.String getKeepRenderAttributes(javax.portlet.PortletRequest request)

getActionPageParameter

protected java.lang.String getActionPageParameter(javax.portlet.PortletConfig config)

getCustomPageParameter

protected java.lang.String getCustomPageParameter(javax.portlet.PortletConfig config)

getEditPageParameter

protected java.lang.String getEditPageParameter(javax.portlet.PortletConfig config)

getViewPageParameter

protected java.lang.String getViewPageParameter(javax.portlet.PortletConfig config)

getHelpPageParameter

protected java.lang.String getHelpPageParameter(javax.portlet.PortletConfig config)

getStrutsPortletConfigLocationParameter

protected java.lang.String getStrutsPortletConfigLocationParameter(javax.portlet.PortletConfig config)

getPortletScopeStrutsSessionParameter

protected java.lang.Boolean getPortletScopeStrutsSessionParameter(javax.portlet.PortletConfig config)

doEdit

public void doEdit(javax.portlet.RenderRequest request,
                   javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   java.io.IOException

Overrides:

doEdit in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

java.io.IOException

doHelp

public void doHelp(javax.portlet.RenderRequest request,
                   javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   java.io.IOException

Overrides:

doHelp in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

java.io.IOException

doCustom

public void doCustom(javax.portlet.RenderRequest request,
                     javax.portlet.RenderResponse response)
              throws javax.portlet.PortletException,
                     java.io.IOException

Throws:

javax.portlet.PortletException

java.io.IOException

doView

public void doView(javax.portlet.RenderRequest request,
                   javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   java.io.IOException

Overrides:

doView in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

java.io.IOException

processAction

public void processAction(javax.portlet.ActionRequest request,
                          javax.portlet.ActionResponse response)
                   throws javax.portlet.PortletException,
                          java.io.IOException

Specified by:

processAction in interface javax.portlet.Portlet

Overrides:

processAction in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

java.io.IOException

processRequest

protected void processRequest(javax.portlet.PortletRequest request,
                              javax.portlet.PortletResponse response,
                              java.lang.String defaultPage,
                              java.lang.String requestType)
                       throws javax.portlet.PortletException,
                              java.io.IOException

Throws:

javax.portlet.PortletException

java.io.IOException

renderError

protected void renderError(javax.servlet.http.HttpServletResponse response,
                           StrutsPortletErrorContext errorContext)
                    throws java.io.IOException

Throws:

java.io.IOException

getApplicationSession

public javax.servlet.http.HttpSession getApplicationSession(javax.servlet.http.HttpServletRequest request)