com.liferay.faces.bridge.context.internal
Class BridgeContextImpl

java.lang.Object
  com.liferay.faces.bridge.context.BridgeContext
      com.liferay.faces.bridge.context.internal.BridgeContextCompatImpl
          com.liferay.faces.bridge.context.internal.BridgeContextImpl

Direct Known Subclasses:

BridgeContextLiferayImpl

public class BridgeContextImpl
extends BridgeContextCompatImpl

Author:

Neil Griffin

Nested Class Summary

protected class

BridgeContextImpl.StringWrapper

Constructor Summary

BridgeContextImpl(BridgeConfig bridgeConfig, BridgeRequestScope bridgeRequestScope, javax.portlet.PortletConfig portletConfig, javax.portlet.PortletContext portletContext, javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse, Bridge.PortletPhase portletPhase, IncongruityContext incongruityContext)

Method Summary

BridgeURL	encodeActionURL(String url)
BridgeURL	encodeBookmarkableURL(String baseURL, Map<String,List<String>> parameters)
BridgeURL	encodePartialActionURL(String url)
BridgeURL	encodeRedirectURL(String baseUrl, Map<String,List<String>> parameters)
BridgeResourceURL	encodeResourceURL(String url)
Map<String,Object>	getAttributes()
BridgeConfig	getBridgeConfig()
BridgeRequestScope	getBridgeRequestScope()
String	getDefaultRenderKitId()
Map<String,String>	getDefaultViewIdMap()
protected FacesView	getFacesView() Returns an instance of FacesView that represents the target view (and optional query string) as described in section 5.2.3 of the Bridge Spec titled "Determining the Target View".
String	getFacesViewId()
protected String	getFacesViewIdAndQueryString() This method returns the target view (and optional query string) as described in section 5.2.3 of the Bridge Spec titled "Determining the Target View".
String	getFacesViewIdFromPath(String viewPath)
String	getFacesViewIdFromPath(String viewPath, boolean mustExist)
protected String	getFacesViewIdRequestAttribute(String name)
protected String	getFacesViewIdRequestParameter(String name)
String	getFacesViewQueryString()
IncongruityContext	getIncongruityContext()
String	getInitParameter(String name)
javax.portlet.PortletConfig	getPortletConfig()
javax.portlet.PortletContext	getPortletContext()
javax.portlet.PortletRequest	getPortletRequest()
Bridge.PortletPhase	getPortletRequestPhase()
javax.portlet.PortletResponse	getPortletResponse()
List<String>	getPreFacesRequestAttrNames()
Map<String,String[]>	getPreservedActionParams()
BridgeURL	getRenderRedirectURL()
Map<String,String>	getRequestHeaderMap()
Map<String,String[]>	getRequestHeaderValuesMap()
Map<String,String>	getRequestParameterMap()
Map<String,String[]>	getRequestParameterValuesMap()
String	getRequestPathInfo()
protected String	getRequestQueryString(javax.portlet.PortletRequest portletRequest)
String	getRequestServletPath()
protected String	getRequestURL()
Writer	getResponseOutputWriter()
String	getSavedViewState()
boolean	isPreserveActionParams()
boolean	isProcessingAfterViewContent()
boolean	isRenderRedirect()
boolean	isRenderRedirectAfterDispatch()
void	redirect(String url)
void	release()
void	setPortletRequest(javax.portlet.PortletRequest portletRequest)
void	setPortletResponse(javax.portlet.PortletResponse portletResponse)
void	setPreFacesRequestAttrNames(List<String> preFacesRequestAttrNames)
void	setPreservedActionParams(Map<String,String[]> preservedActionParams)
void	setProcessingAfterViewContent(boolean processingAfterViewContent)
void	setRenderRedirectAfterDispatch(boolean renderRedirectAfterDispatch)
void	setRenderRedirectURL(BridgeURL renderRedirectURL)
void	setSavedViewState(String savedViewState)

Methods inherited from class com.liferay.faces.bridge.context.internal.BridgeContextCompatImpl

isJSF2PartialRequest, partialViewContextRenderAll, redirectJSF2PartialResponse

Methods inherited from class com.liferay.faces.bridge.context.BridgeContext

getCurrentInstance, setCurrentInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

BridgeContextImpl

public BridgeContextImpl(BridgeConfig bridgeConfig,
                         BridgeRequestScope bridgeRequestScope,
                         javax.portlet.PortletConfig portletConfig,
                         javax.portlet.PortletContext portletContext,
                         javax.portlet.PortletRequest portletRequest,
                         javax.portlet.PortletResponse portletResponse,
                         Bridge.PortletPhase portletPhase,
                         IncongruityContext incongruityContext)

Method Detail

encodeActionURL

public BridgeURL encodeActionURL(String url)

Specified by:

encodeActionURL in class BridgeContext

encodeBookmarkableURL

public BridgeURL encodeBookmarkableURL(String baseURL,
                                       Map<String,List<String>> parameters)

Specified by:

encodeBookmarkableURL in class BridgeContext

encodePartialActionURL

public BridgeURL encodePartialActionURL(String url)

Specified by:

encodePartialActionURL in class BridgeContext

encodeRedirectURL

public BridgeURL encodeRedirectURL(String baseUrl,
                                   Map<String,List<String>> parameters)

Specified by:

encodeRedirectURL in class BridgeContext

encodeResourceURL

public BridgeResourceURL encodeResourceURL(String url)

Specified by:

encodeResourceURL in class BridgeContext

redirect

public void redirect(String url)
              throws IOException

Specified by:

redirect in class BridgeContext

Throws:

IOException

release

public void release()

Specified by:

release in class BridgeContext

getAttributes

public Map<String,Object> getAttributes()

Specified by:

getAttributes in class BridgeContext

getBridgeConfig

public BridgeConfig getBridgeConfig()

Specified by:

getBridgeConfig in class BridgeContext

getBridgeRequestScope

public BridgeRequestScope getBridgeRequestScope()

Specified by:

getBridgeRequestScope in class BridgeContext

getDefaultRenderKitId

public String getDefaultRenderKitId()

Specified by:

getDefaultRenderKitId in class BridgeContext

getDefaultViewIdMap

public Map<String,String> getDefaultViewIdMap()

Specified by:

getDefaultViewIdMap in class BridgeContext

getFacesView

protected FacesView getFacesView()
                          throws BridgeDefaultViewNotSpecifiedException,
                                 BridgeInvalidViewPathException

Returns an instance of FacesView that represents the target view (and optional query string) as described in section 5.2.3 of the Bridge Spec titled "Determining the Target View".

Throws:

{@link - BridgeDefaultViewNotSpecifiedException} when the default view is not specified in the WEB-INF/portlet.xml descriptor.

{@link - BridgeInvalidViewPathException} when the Bridge.VIEW_PATH request attribute contains an invalid path such that the target view cannot be determined.

BridgeDefaultViewNotSpecifiedException

BridgeInvalidViewPathException

getFacesViewId

public String getFacesViewId()
                      throws BridgeDefaultViewNotSpecifiedException,
                             BridgeInvalidViewPathException

Specified by:

getFacesViewId in class BridgeContext

Throws:

BridgeDefaultViewNotSpecifiedException

BridgeInvalidViewPathException

getFacesViewIdAndQueryString

protected String getFacesViewIdAndQueryString()
                                       throws BridgeDefaultViewNotSpecifiedException,
                                              BridgeInvalidViewPathException

This method returns the target view (and optional query string) as described in section 5.2.3 of the Bridge Spec titled "Determining the Target View".

Try#1: Get the viewId from the Bridge.VIEW_ID (javax.portlet.faces.viewId) request attribute. As described in sections 3.4 and 4.2.5 of the bridge spec, this attribute is set by the GenericFacesPortlet when it encounters the Bridge.FACES_VIEW_ID_PARAMETER request parameter.

Try#2: Get the viewId from the Bridge.VIEW_PATH (javax.portlet.faces.viewPath) request attribute. As described in sections 3.4 and 4.2.5 of the bridge spec, this attribute is set by the GenericFacesPortlet when it encounters the Bridge.FACES_VIEW_PATH_PARAMETER request parameter. If the viewId cannot be determined, then BridgeInvalidViewPathException is thrown.

Try#3: Get the viewId from a prior render-redirect (if one has occurred).

Try#4: Get the viewId from a request parameter, the name of which is dynamic depending on the Bridge.PortletPhase.

Try#5:Get the viewId from the init-param value in the portlet.xml descriptor according the current PortletMode.

Throws:

{@link - BridgeDefaultViewNotSpecifiedException} when the default view is not specified in the WEB-INF/portlet.xml descriptor.

{@link - BridgeInvalidViewPathException} when the Bridge.VIEW_PATH request attribute contains an invalid path such that the target view cannot be determined.

BridgeDefaultViewNotSpecifiedException

BridgeInvalidViewPathException

getFacesViewIdFromPath

public String getFacesViewIdFromPath(String viewPath)

Specified by:

getFacesViewIdFromPath in class BridgeContext

getFacesViewIdFromPath

public String getFacesViewIdFromPath(String viewPath,
                                     boolean mustExist)

Specified by:

getFacesViewIdFromPath in class BridgeContext

getFacesViewIdRequestAttribute

protected String getFacesViewIdRequestAttribute(String name)

getFacesViewIdRequestParameter

protected String getFacesViewIdRequestParameter(String name)

getFacesViewQueryString

public String getFacesViewQueryString()

Specified by:

getFacesViewQueryString in class BridgeContext

isRenderRedirectAfterDispatch

public boolean isRenderRedirectAfterDispatch()

Specified by:

isRenderRedirectAfterDispatch in class BridgeContext

getIncongruityContext

public IncongruityContext getIncongruityContext()

Specified by:

getIncongruityContext in class BridgeContext

getInitParameter

public String getInitParameter(String name)

Specified by:

getInitParameter in class BridgeContext

getPortletConfig

public javax.portlet.PortletConfig getPortletConfig()

Specified by:

getPortletConfig in class BridgeContext

getPortletContext

public javax.portlet.PortletContext getPortletContext()

Specified by:

getPortletContext in class BridgeContext

getPortletRequest

public javax.portlet.PortletRequest getPortletRequest()

Specified by:

getPortletRequest in class BridgeContext

setPortletRequest

public void setPortletRequest(javax.portlet.PortletRequest portletRequest)

Specified by:

setPortletRequest in class BridgeContext

getPortletRequestPhase

public Bridge.PortletPhase getPortletRequestPhase()

Specified by:

getPortletRequestPhase in class BridgeContext

getPortletResponse

public javax.portlet.PortletResponse getPortletResponse()

Specified by:

getPortletResponse in class BridgeContext

setPortletResponse

public void setPortletResponse(javax.portlet.PortletResponse portletResponse)

Specified by:

setPortletResponse in class BridgeContext

getPreFacesRequestAttrNames

public List<String> getPreFacesRequestAttrNames()

Specified by:

getPreFacesRequestAttrNames in class BridgeContext

setPreFacesRequestAttrNames

public void setPreFacesRequestAttrNames(List<String> preFacesRequestAttrNames)

getPreservedActionParams

public Map<String,String[]> getPreservedActionParams()

Specified by:

getPreservedActionParams in class BridgeContext

setPreservedActionParams

public void setPreservedActionParams(Map<String,String[]> preservedActionParams)

setProcessingAfterViewContent

public void setProcessingAfterViewContent(boolean processingAfterViewContent)

Specified by:

setProcessingAfterViewContent in class BridgeContext

setRenderRedirectAfterDispatch

public void setRenderRedirectAfterDispatch(boolean renderRedirectAfterDispatch)

Specified by:

setRenderRedirectAfterDispatch in class BridgeContext

getRenderRedirectURL

public BridgeURL getRenderRedirectURL()

Specified by:

getRenderRedirectURL in class BridgeContext

setRenderRedirectURL

public void setRenderRedirectURL(BridgeURL renderRedirectURL)

Specified by:

setRenderRedirectURL in class BridgeContext

getRequestHeaderMap

public Map<String,String> getRequestHeaderMap()

Specified by:

getRequestHeaderMap in class BridgeContext

getRequestHeaderValuesMap

public Map<String,String[]> getRequestHeaderValuesMap()

Specified by:

getRequestHeaderValuesMap in class BridgeContext

getRequestParameterMap

public Map<String,String> getRequestParameterMap()

Specified by:

getRequestParameterMap in class BridgeContext

getRequestParameterValuesMap

public Map<String,String[]> getRequestParameterValuesMap()

Specified by:

getRequestParameterValuesMap in class BridgeContext

getRequestPathInfo

public String getRequestPathInfo()

Specified by:

getRequestPathInfo in class BridgeContext

getRequestQueryString

protected String getRequestQueryString(javax.portlet.PortletRequest portletRequest)

getRequestServletPath

public String getRequestServletPath()

Specified by:

getRequestServletPath in class BridgeContext

getRequestURL

protected String getRequestURL()

getResponseOutputWriter

public Writer getResponseOutputWriter()
                               throws IOException

Specified by:

getResponseOutputWriter in class BridgeContext

Throws:

IOException

isPreserveActionParams

public boolean isPreserveActionParams()

Specified by:

isPreserveActionParams in class BridgeContext

getSavedViewState

public String getSavedViewState()

Specified by:

getSavedViewState in class BridgeContext

setSavedViewState

public void setSavedViewState(String savedViewState)

Specified by:

setSavedViewState in class BridgeContext

isProcessingAfterViewContent

public boolean isProcessingAfterViewContent()

Specified by:

isProcessingAfterViewContent in class BridgeContext

isRenderRedirect

public boolean isRenderRedirect()

Specified by:

isRenderRedirect in class BridgeContext