| org.apache.jetspeed.container.url.PortalURL
All known Subclasses: org.apache.jetspeed.container.url.impl.AbstractPortalURL,
| PortalURL | | public interface PortalURL (Code) | |
PortalURL defines the interface for manipulating Jetspeed Portal URLs.
These URLs are used internally by the portal and are not available to
Portlet Applications.
author:
Scott T. Weaver
author:
David Sean Taylor
version:
$Id: PortalURL.java 605989 2007-12-20 18:26:54Z ate $ |
| Field Summary | |
| final public static String | HTTP
HTTP protocol. | | final public static String | HTTPS
HTTPS protocol. |
| Method Summary | |
| String | createNavigationalEncoding(PortletWindow window, Map parameters, PortletMode mode, WindowState state, boolean action)
| | String | createNavigationalEncoding(PortletWindow window, PortletMode mode, WindowState state)
| | String | createPortletURL(PortletWindow window, Map parameters, PortletMode mode, WindowState state, boolean action, boolean secure)
Create a new PortletURL for a PortletWindow including request or action parameters. | | String | createPortletURL(PortletWindow window, PortletMode mode, WindowState state, boolean secure)
Create a new PortletURL for a PortletWindow retaining its (request) parameters. | | String | getBasePath()
Returns the current Portal base path. | | String | getBaseURL()
Gets the Base URL for this portal. | | String | getBaseURL(boolean secure)
Gets a secure version of the Base URL for this portal. | | NavigationalState | getNavigationalState()
| | String | getPageBasePath()
Returns the current Portal Page base path without possible encoded
NavigationalState parameter. | | String | getPath()
Gets the global navigational path of the current request. | | String | getPortalURL()
| | boolean | hasEncodedNavState()
| | boolean | isPathInfoEncodingNavState()
| | boolean | isRelativeOnly()
| | boolean | isSecure()
| | void | setCharacterEncoding(String characterEncoding)
| | void | setRequest(HttpServletRequest request)
Sets the @link{javax.servlet.http.HttpServletRequest} that will be used
to generate urls. |
| createNavigationalEncoding | | String createNavigationalEncoding(PortletWindow window, Map parameters, PortletMode mode, WindowState state, boolean action)(Code) | | Creates the navigational encoding for a given window
Similiar to createPortletURL above
Parameters:
window - the PortalWindow
Parameters:
parameters - the new request or action parameters for the PortalWindow
Parameters:
mode - the new PortletMode for the PortalWindow
Parameters:
state - the new WindowState for the PortalWindow
Parameters:
action - indicates if an actionURL or renderURL is created
Parameters:
secure - indicates if a secure url is required a new navigational state as String |
| createNavigationalEncoding | | String createNavigationalEncoding(PortletWindow window, PortletMode mode, WindowState state)(Code) | | Creates the navigational encoding for a given window
Similiar to createPortletURL above
Parameters:
window - the PortalWindow
Parameters:
mode - the new PortletMode for the PortalWindow
Parameters:
state - the new WindowState for the PortalWindow
Parameters:
secure -
Parameters:
secure - indicates if a secure url is required a new renderURL as String |
| createPortletURL | | String createPortletURL(PortletWindow window, Map parameters, PortletMode mode, WindowState state, boolean action, boolean secure)(Code) | | Create a new PortletURL for a PortletWindow including request or action parameters.
The Portal Navigational State is encoded within the URL
Parameters:
window - the PortalWindow
Parameters:
parameters - the new request or action parameters for the PortalWindow
Parameters:
mode - the new PortletMode for the PortalWindow
Parameters:
state - the new WindowState for the PortalWindow
Parameters:
action - indicates if an actionURL or renderURL is created
Parameters:
secure - indicates if a secure url is required a new actionURL or renderURL as String |
| createPortletURL | | String createPortletURL(PortletWindow window, PortletMode mode, WindowState state, boolean secure)(Code) | | Create a new PortletURL for a PortletWindow retaining its (request) parameters.
The Portal Navigational State is encoded within the URL
Parameters:
window - the PortalWindow
Parameters:
mode - the new PortletMode for the PortalWindow
Parameters:
state - the new WindowState for the PortalWindow
Parameters:
secure -
Parameters:
secure - indicates if a secure url is required a new renderURL as String |
| getBasePath | | String getBasePath()(Code) | | Returns the current Portal base path.
This path can be used as base for root relative pages and resources which don't need
the NavigationalState.
the current Portal base path without NavigationalState |
| getBaseURL | | String getBaseURL()(Code) | | Gets the Base URL for this portal.
The Base URL of the portal. |
| getBaseURL | | String getBaseURL(boolean secure)(Code) | | Gets a secure version of the Base URL for this portal.
The secure Base URL of the portal. |
| getNavigationalState | | NavigationalState getNavigationalState()(Code) | | Gets the NavigationalState for access to the current request portal control parameters
the NavigationalState of the PortalURL |
| getPageBasePath | | String getPageBasePath()(Code) | | Returns the current Portal Page base path without possible encoded
NavigationalState parameter.
This path can be used as base for page relative resources which don't need
the NavigationalState.
the current Portal Page base path without NavigationalState |
| getPath | | String getPath()(Code) | | Gets the global navigational path of the current request.
The path does not contain the NavigationalState parameter
The the global navigational path of the current request. |
| getPortalURL | | String getPortalURL()(Code) | | a Portal URL with encoded current navigational state |
| hasEncodedNavState | | boolean hasEncodedNavState()(Code) | | true if navigational state was provided on the url |
| isPathInfoEncodingNavState | | boolean isPathInfoEncodingNavState()(Code) | | true if navigational state is encoded as pathInfo |
| isRelativeOnly | | boolean isRelativeOnly()(Code) | | true if only relative urls should be generated (without scheme, servername, port) |
| isSecure | | boolean isSecure()(Code) | | true if the current request is secure |
| setCharacterEncoding | | void setCharacterEncoding(String characterEncoding)(Code) | | |
| setRequest | | void setRequest(HttpServletRequest request)(Code) | | Sets the @link{javax.servlet.http.HttpServletRequest} that will be used
to generate urls.
Parameters:
request - |
|
|