|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.container.url.impl.AbstractPortalURL
public abstract class AbstractPortalURL
AbstractPortalURL delivers the base implemention for parsing Jetspeed Portal URLs and creating new Portlet URLs. Not implemented is the encoding and decoding of the NavigationState parameter in the URL, allowing concrete implementations to supply different algorithms for it like encoding it as pathInfo or as query string parameter.
Field Summary | |
---|---|
protected BasePortalURL |
base
|
protected java.lang.String |
basePath
|
protected java.lang.String |
characterEncoding
|
protected java.lang.String |
contextPath
|
static java.lang.String |
DEFAULT_NAV_STATE_PARAMETER
|
protected java.lang.String |
encodedNavState
|
protected NavigationalState |
navState
|
protected static java.lang.String |
navStateParameter
|
protected java.lang.String |
nonSecureBaseURL
|
protected java.lang.String |
path
|
protected static java.lang.Boolean |
relativeOnly
|
protected java.lang.String |
secureBaseURL
|
Fields inherited from interface org.apache.jetspeed.container.url.PortalURL |
---|
HTTP, HTTPS |
Constructor Summary | |
---|---|
AbstractPortalURL(javax.servlet.http.HttpServletRequest request,
java.lang.String characterEncoding,
NavigationalState navState,
PortalContext portalContext)
|
|
AbstractPortalURL(NavigationalState navState,
PortalContext portalContext)
|
|
AbstractPortalURL(NavigationalState navState,
PortalContext portalContext,
BasePortalURL base)
|
|
AbstractPortalURL(java.lang.String characterEncoding,
NavigationalState navState,
PortalContext portalContext)
|
Method Summary | |
---|---|
java.lang.String |
createNavigationalEncoding(org.apache.pluto.om.window.PortletWindow window,
java.util.Map parameters,
javax.portlet.PortletMode mode,
javax.portlet.WindowState state,
boolean action)
Creates the navigational encoding for a given window Similiar to createPortletURL above |
java.lang.String |
createNavigationalEncoding(org.apache.pluto.om.window.PortletWindow window,
javax.portlet.PortletMode mode,
javax.portlet.WindowState state)
Creates the navigational encoding for a given window Similiar to createPortletURL above |
java.lang.String |
createPortletURL(org.apache.pluto.om.window.PortletWindow window,
java.util.Map parameters,
javax.portlet.PortletMode mode,
javax.portlet.WindowState state,
boolean action,
boolean secure)
Create a new PortletURL for a PortletWindow including request or action parameters. |
java.lang.String |
createPortletURL(org.apache.pluto.om.window.PortletWindow window,
javax.portlet.PortletMode mode,
javax.portlet.WindowState state,
boolean secure)
Create a new PortletURL for a PortletWindow retaining its (request) parameters. |
protected abstract java.lang.String |
createPortletURL(java.lang.String encodedNavState,
boolean secure)
|
protected void |
decodeBasePath(javax.servlet.http.HttpServletRequest request)
|
protected void |
decodeBaseURL(javax.servlet.http.HttpServletRequest request)
|
protected abstract void |
decodePathAndNavigationalState(javax.servlet.http.HttpServletRequest request)
|
java.lang.String |
getBasePath()
Returns the current Portal base path. |
java.lang.String |
getBaseURL()
Gets the Base URL for this portal. |
java.lang.String |
getBaseURL(boolean secure)
Gets a secure version of the Base URL for this portal. |
NavigationalState |
getNavigationalState()
Gets the NavigationalState for access to the current request portal control parameters |
static java.lang.String |
getNavigationalStateParameterName()
|
java.lang.String |
getPageBasePath()
Returns the current Portal Page base path without possible encoded NavigationalState parameter. |
java.lang.String |
getPath()
Gets the global navigational path of the current request. |
java.lang.String |
getPortalURL()
|
boolean |
hasEncodedNavState()
|
boolean |
isPathInfoEncodingNavState()
|
boolean |
isRelativeOnly()
|
boolean |
isSecure()
|
void |
setCharacterEncoding(java.lang.String characterEncoding)
|
protected void |
setEncodedNavigationalState(java.lang.String encodedNavigationalState)
|
protected void |
setPath(java.lang.String path)
|
void |
setRequest(javax.servlet.http.HttpServletRequest request)
Sets the @link{javax.servlet.http.HttpServletRequest} that will be used to generate urls. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_NAV_STATE_PARAMETER
protected static java.lang.String navStateParameter
protected NavigationalState navState
protected BasePortalURL base
protected static java.lang.Boolean relativeOnly
protected java.lang.String contextPath
protected java.lang.String basePath
protected java.lang.String path
protected java.lang.String encodedNavState
protected java.lang.String secureBaseURL
protected java.lang.String nonSecureBaseURL
protected java.lang.String characterEncoding
Constructor Detail |
---|
public AbstractPortalURL(NavigationalState navState, PortalContext portalContext, BasePortalURL base)
public AbstractPortalURL(NavigationalState navState, PortalContext portalContext)
public AbstractPortalURL(java.lang.String characterEncoding, NavigationalState navState, PortalContext portalContext)
public AbstractPortalURL(javax.servlet.http.HttpServletRequest request, java.lang.String characterEncoding, NavigationalState navState, PortalContext portalContext)
Method Detail |
---|
public boolean isRelativeOnly()
isRelativeOnly
in interface PortalURL
public static java.lang.String getNavigationalStateParameterName()
public java.lang.String createNavigationalEncoding(org.apache.pluto.om.window.PortletWindow window, java.util.Map parameters, javax.portlet.PortletMode mode, javax.portlet.WindowState state, boolean action)
PortalURL
createNavigationalEncoding
in interface PortalURL
window
- the PortalWindowparameters
- the new request or action parameters for the PortalWindowmode
- the new PortletMode for the PortalWindowstate
- the new WindowState for the PortalWindowaction
- indicates if an actionURL or renderURL is created
public java.lang.String createNavigationalEncoding(org.apache.pluto.om.window.PortletWindow window, javax.portlet.PortletMode mode, javax.portlet.WindowState state)
PortalURL
createNavigationalEncoding
in interface PortalURL
window
- the PortalWindowmode
- the new PortletMode for the PortalWindowstate
- the new WindowState for the PortalWindow
protected void decodeBaseURL(javax.servlet.http.HttpServletRequest request)
protected void decodeBasePath(javax.servlet.http.HttpServletRequest request)
protected void setEncodedNavigationalState(java.lang.String encodedNavigationalState)
protected void setPath(java.lang.String path)
public java.lang.String getBaseURL()
PortalURL
getBaseURL
in interface PortalURL
public java.lang.String getBaseURL(boolean secure)
PortalURL
getBaseURL
in interface PortalURL
public java.lang.String getBasePath()
PortalURL
getBasePath
in interface PortalURL
public java.lang.String getPath()
PortalURL
getPath
in interface PortalURL
public java.lang.String getPageBasePath()
PortalURL
getPageBasePath
in interface PortalURL
public boolean isSecure()
isSecure
in interface PortalURL
public NavigationalState getNavigationalState()
PortalURL
getNavigationalState
in interface PortalURL
public java.lang.String createPortletURL(org.apache.pluto.om.window.PortletWindow window, java.util.Map parameters, javax.portlet.PortletMode mode, javax.portlet.WindowState state, boolean action, boolean secure)
PortalURL
createPortletURL
in interface PortalURL
window
- the PortalWindowparameters
- the new request or action parameters for the PortalWindowmode
- the new PortletMode for the PortalWindowstate
- the new WindowState for the PortalWindowaction
- indicates if an actionURL or renderURL is createdsecure
- indicates if a secure url is required
public java.lang.String createPortletURL(org.apache.pluto.om.window.PortletWindow window, javax.portlet.PortletMode mode, javax.portlet.WindowState state, boolean secure)
PortalURL
createPortletURL
in interface PortalURL
window
- the PortalWindowmode
- the new PortletMode for the PortalWindowstate
- the new WindowState for the PortalWindow
protected abstract void decodePathAndNavigationalState(javax.servlet.http.HttpServletRequest request)
protected abstract java.lang.String createPortletURL(java.lang.String encodedNavState, boolean secure)
public void setRequest(javax.servlet.http.HttpServletRequest request)
PortalURL
setRequest
in interface PortalURL
public void setCharacterEncoding(java.lang.String characterEncoding)
setCharacterEncoding
in interface PortalURL
public java.lang.String getPortalURL()
getPortalURL
in interface PortalURL
public boolean hasEncodedNavState()
hasEncodedNavState
in interface PortalURL
public boolean isPathInfoEncodingNavState()
isPathInfoEncodingNavState
in interface PortalURL
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |