org.hippoecm.hst.container
Class HstContainerPortlet

java.lang.Object
  javax.portlet.GenericPortlet
      org.hippoecm.hst.container.HstContainerPortlet

All Implemented Interfaces:

javax.portlet.EventPortlet, javax.portlet.Portlet, javax.portlet.PortletConfig, javax.portlet.ResourceServingPortlet

public class HstContainerPortlet
extends javax.portlet.GenericPortlet

Field Summary

protected boolean	allowPreferences Allow preferences to be set by preferences.
protected String	defaultFallbackHstPathInfo
protected String	defaultHeaderPage
protected String	defaultHelpPage
protected String	defaultHstComponentTargetPath
protected String	defaultHstMountPath
protected String	defaultHstPathInfo
protected String	defaultHstPathInfoEditMode
protected boolean	defaultPortalContentPathBased
protected String	defaultPortletTitle
static String	HST_HEADER_PAGE_PARAM_NAME Name of portlet preference for Header page
static String	HST_HELP_PAGE_PARAM_NAME Name of portlet preference for Edit page
static String	HST_MOUNT_PATH_PARAM Name of portlet preference for the Mount path of HST URL
static String	HST_PATH_INFO_EDIT_MODE_PARAM Name of portlet preference for the path info for edit mode of HST URL
static String	HST_PATH_INFO_PARAM Name of portlet preference for the path info of HST URL
static String	HST_PATH_PARAM_NAME
static String	HST_PORTAL_CONTENT_PATH_BASED Name of portlet preference for the path info of HST URL
static String	HST_PORTLET_TITLE_PARAM_NAME Name of portlet preference for the portlet title
static String	HST_TARGET_COMPONENT_PATH_PARAM Name of portlet preference for the target component path
static String	PARAM_ALLOW_PREFERENCES Name of portlet preference to allow the use of preferences to set pages
protected javax.portlet.PortletContext	portletContext

Constructor Summary

HstContainerPortlet()

Method Summary

protected HstMutablePortletRequestContext	createHstRequestContext(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)
void	destroy()
protected void	dispatch(javax.portlet.PortletRequestDispatcher dispatcher, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, boolean include)
void	doEdit(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
void	doHeaders(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 String	getDispatchPage(javax.portlet.PortletRequest request, String pageName, String defaultPage)
protected String	getHstDispatchUrl(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, String hstMountPath, String hstPathInfo, boolean readDispPathParam)
protected HstPortalContextProvider	getPortalContextProvider(javax.portlet.PortletRequest request)
void	init(javax.portlet.PortletConfig config)
void	processAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response)
protected void	processActionResponseState(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response, String hstDispUrl, HstPortletResponseState portletResponseState)
protected void	processMimeResponseRequest(javax.portlet.PortletRequest request, javax.portlet.MimeResponse response, String hstDispUrl, HstPortletResponseState portletResponseState)
protected void	processRequest(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)
void	serveResource(javax.portlet.ResourceRequest request, javax.portlet.ResourceResponse response)

Methods inherited from class javax.portlet.GenericPortlet

doDispatch, getContainerRuntimeOptions, getDefaultNamespace, getInitParameter, getInitParameterNames, getNextPossiblePortletModes, getPortletConfig, getPortletContext, getPortletName, getProcessingEventQNames, getPublicRenderParameterNames, getPublishingEventQNames, getResourceBundle, getSupportedLocales, getTitle, init, processEvent, render

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_ALLOW_PREFERENCES

public static final String PARAM_ALLOW_PREFERENCES

Name of portlet preference to allow the use of preferences to set pages

See Also:

Constant Field Values

HST_MOUNT_PATH_PARAM

public static final String HST_MOUNT_PATH_PARAM

Name of portlet preference for the Mount path of HST URL

See Also:

Constant Field Values

HST_PATH_INFO_PARAM

public static final String HST_PATH_INFO_PARAM

Name of portlet preference for the path info of HST URL

See Also:

Constant Field Values

HST_PORTAL_CONTENT_PATH_BASED

public static final String HST_PORTAL_CONTENT_PATH_BASED

Name of portlet preference for the path info of HST URL

See Also:

Constant Field Values

HST_PATH_INFO_EDIT_MODE_PARAM

public static final String HST_PATH_INFO_EDIT_MODE_PARAM

Name of portlet preference for the path info for edit mode of HST URL

See Also:

Constant Field Values

HST_TARGET_COMPONENT_PATH_PARAM

public static final String HST_TARGET_COMPONENT_PATH_PARAM

Name of portlet preference for the target component path

See Also:

Constant Field Values

HST_PORTLET_TITLE_PARAM_NAME

public static final String HST_PORTLET_TITLE_PARAM_NAME

Name of portlet preference for the portlet title

See Also:

Constant Field Values

HST_HEADER_PAGE_PARAM_NAME

public static final String HST_HEADER_PAGE_PARAM_NAME

Name of portlet preference for Header page

See Also:

Constant Field Values

HST_HELP_PAGE_PARAM_NAME

public static final String HST_HELP_PAGE_PARAM_NAME

Name of portlet preference for Edit page

See Also:

Constant Field Values

HST_PATH_PARAM_NAME

public static final String HST_PATH_PARAM_NAME

See Also:

Constant Field Values

portletContext

protected javax.portlet.PortletContext portletContext

defaultHstMountPath

protected String defaultHstMountPath

defaultHstPathInfo

protected String defaultHstPathInfo

defaultFallbackHstPathInfo

protected String defaultFallbackHstPathInfo

defaultHstPathInfoEditMode

protected String defaultHstPathInfoEditMode

defaultHstComponentTargetPath

protected String defaultHstComponentTargetPath

defaultPortletTitle

protected String defaultPortletTitle

defaultHeaderPage

protected String defaultHeaderPage

defaultHelpPage

protected String defaultHelpPage

defaultPortalContentPathBased

protected boolean defaultPortalContentPathBased

allowPreferences

protected boolean allowPreferences

Allow preferences to be set by preferences.

Constructor Detail

HstContainerPortlet

public HstContainerPortlet()

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

destroy

public void destroy()

Specified by:

destroy in interface javax.portlet.Portlet

Overrides:

destroy in class javax.portlet.GenericPortlet

doHeaders

public void doHeaders(javax.portlet.RenderRequest request,
                      javax.portlet.RenderResponse response)

Overrides:

doHeaders in class javax.portlet.GenericPortlet

doHelp

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

Overrides:

doHelp in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

serveResource

public void serveResource(javax.portlet.ResourceRequest request,
                          javax.portlet.ResourceResponse response)
                   throws javax.portlet.PortletException,
                          IOException

Specified by:

serveResource in interface javax.portlet.ResourceServingPortlet

Overrides:

serveResource in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

doView

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

Overrides:

doView in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

doEdit

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

Overrides:

doEdit in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

processAction

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

Specified by:

processAction in interface javax.portlet.Portlet

Overrides:

processAction in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

getDispatchPage

protected String getDispatchPage(javax.portlet.PortletRequest request,
                                 String pageName,
                                 String defaultPage)

processRequest

protected void processRequest(javax.portlet.PortletRequest request,
                              javax.portlet.PortletResponse response)
                       throws javax.portlet.PortletException,
                              IOException

Throws:

javax.portlet.PortletException

IOException

processMimeResponseRequest

protected void processMimeResponseRequest(javax.portlet.PortletRequest request,
                                          javax.portlet.MimeResponse response,
                                          String hstDispUrl,
                                          HstPortletResponseState portletResponseState)
                                   throws javax.portlet.PortletException,
                                          IOException

Throws:

javax.portlet.PortletException

IOException

processActionResponseState

protected void processActionResponseState(javax.portlet.ActionRequest request,
                                          javax.portlet.ActionResponse response,
                                          String hstDispUrl,
                                          HstPortletResponseState portletResponseState)
                                   throws javax.portlet.PortletException,
                                          IOException

Throws:

javax.portlet.PortletException

IOException

getPortalContextProvider

protected HstPortalContextProvider getPortalContextProvider(javax.portlet.PortletRequest request)

createHstRequestContext

protected HstMutablePortletRequestContext createHstRequestContext(javax.portlet.PortletRequest request,
                                                                  javax.portlet.PortletResponse response)

getHstDispatchUrl

protected String getHstDispatchUrl(javax.portlet.PortletRequest request,
                                   javax.portlet.PortletResponse response,
                                   String hstMountPath,
                                   String hstPathInfo,
                                   boolean readDispPathParam)

dispatch

protected void dispatch(javax.portlet.PortletRequestDispatcher dispatcher,
                        javax.portlet.PortletRequest request,
                        javax.portlet.PortletResponse response,
                        boolean include)
                 throws IOException,
                        javax.portlet.PortletException

Throws:

IOException

javax.portlet.PortletException