org.jasig.portal.url
Interface IPortalUrlProvider

All Known Implementing Classes:

PortalUrlProviderImpl

public interface IPortalUrlProvider

Provides source for portal and portlet URL objects.

Version:

$Revision: 19776 $

Author:

Eric Dalquist

Method Summary

IBasePortalUrl	getDefaultUrl(HttpServletRequest request) Gets the default portal URL, this is equivalent to the first URL rendered by the portal when a user logs in.
IBasePortalUrl	getFolderUrlByNodeId(HttpServletRequest request, String folderNodeId)
IPortalRequestInfo	getPortalRequestInfo(HttpServletRequest request) Get the portal request information for the specified request.
IPortalPortletUrl	getPortletUrl(HttpServletRequest request, IPortletWindowId portletWindowId)
IPortalPortletUrl	getPortletUrlByFName(HttpServletRequest request, String portletFName)
IPortalPortletUrl	getPortletUrlByNodeId(HttpServletRequest request, String portletNodeId)

Method Detail

getPortalRequestInfo

IPortalRequestInfo getPortalRequestInfo(HttpServletRequest request)
                                        throws InvalidPortalRequestException

Get the portal request information for the specified request.

Parameters:

request - The current portal request

Returns:

Information about the current request

Throws:

InvalidPortalRequestException

getDefaultUrl

IBasePortalUrl getDefaultUrl(HttpServletRequest request)

Gets the default portal URL, this is equivalent to the first URL rendered by the portal when a user logs in.

Parameters:

request - The current portal request

Returns:

Default IBasePortalUrl

getFolderUrlByNodeId

IBasePortalUrl getFolderUrlByNodeId(HttpServletRequest request,
                                    String folderNodeId)

Parameters:

request - The current portal request

folderNodeId - ID of the folder in the user's layout that should be targeted by the URL.

Returns:

Folder targeted IBasePortalUrl

Throws:

IllegalArgumentException - If the specified ID doesn't exist for a folder in the users layout.

getPortletUrl

IPortalPortletUrl getPortletUrl(HttpServletRequest request,
                                IPortletWindowId portletWindowId)

Parameters:

request - The current portal request

portletWindowId - ID of the portlet window that should be targeted by the URL.

Returns:

Portlet targeted IBasePortalUrl

Throws:

IllegalArgumentException - If the specified ID doesn't exist for a channel in the users layout.

getPortletUrlByNodeId

IPortalPortletUrl getPortletUrlByNodeId(HttpServletRequest request,
                                        String portletNodeId)

Parameters:

request - The current portal request

portletNodeId - ID of the channel in the user's layout that should be targeted by the URL.

Returns:

Portlet targeted IBasePortalUrl

Throws:

IllegalArgumentException - If the specified ID doesn't exist for a channel in the users layout.

getPortletUrlByFName

IPortalPortletUrl getPortletUrlByFName(HttpServletRequest request,
                                       String portletFName)

Parameters:

request - The current portal request

portletFName - The fname of the portlet that should be targeted by the URL

Returns:

Portlet targeted IBasePortalUrl

Throws:

IllegalArgumentException - If the specified fname does not exist.