|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortalURL
PortalURL defines the interface for manipulating Jetspeed Portal URLs. These URLs are used internally by the portal and are not available to Portlet Applications.
Field Summary | |
---|---|
static java.lang.String |
HTTP
HTTP protocol. |
static java.lang.String |
HTTPS
HTTPS protocol. |
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. |
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 |
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)
|
void |
setRequest(javax.servlet.http.HttpServletRequest request)
Sets the @link{javax.servlet.http.HttpServletRequest} that will be used to generate urls. |
Field Detail |
---|
static final java.lang.String HTTP
static final java.lang.String HTTPS
Method Detail |
---|
boolean isRelativeOnly()
java.lang.String getBaseURL()
java.lang.String getBaseURL(boolean secure)
java.lang.String getPath()
java.lang.String getBasePath()
java.lang.String getPageBasePath()
boolean isSecure()
NavigationalState getNavigationalState()
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)
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
java.lang.String createPortletURL(org.apache.pluto.om.window.PortletWindow window, javax.portlet.PortletMode mode, javax.portlet.WindowState state, boolean secure)
window
- the PortalWindowmode
- the new PortletMode for the PortalWindowstate
- the new WindowState for the PortalWindowsecure
- secure
- indicates if a secure url is required
void setRequest(javax.servlet.http.HttpServletRequest request)
request
- void setCharacterEncoding(java.lang.String characterEncoding)
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)
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
java.lang.String createNavigationalEncoding(org.apache.pluto.om.window.PortletWindow window, javax.portlet.PortletMode mode, javax.portlet.WindowState state)
window
- the PortalWindowmode
- the new PortletMode for the PortalWindowstate
- the new WindowState for the PortalWindowsecure
- secure
- indicates if a secure url is required
java.lang.String getPortalURL()
boolean hasEncodedNavState()
boolean isPathInfoEncodingNavState()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |