org.jasig.portal.portlet.url
Interface IPortletUrlSyntaxProvider

All Known Implementing Classes:

PortletUrlSyntaxProviderImpl

public interface IPortletUrlSyntaxProvider

Encapsulates the logic for writing to and reading from URLs for portlets. This should hide the actual paramter namespacing, encoding and related logic for both URL generation and parsing.

Version:

$Revision$

Author:

Eric Dalquist

Method Summary

String	generatePortletUrl(HttpServletRequest request, IPortletWindow portletWindow, PortletUrl portletUrl) Generates a full portlet URL for the current request, passed portlet window & portlet URL data object.
PortletUrl	parsePortletUrl(HttpServletRequest request) Parses out PortletUrl data from the request.

Method Detail

generatePortletUrl

String generatePortletUrl(HttpServletRequest request,
                          IPortletWindow portletWindow,
                          PortletUrl portletUrl)

Generates a full portlet URL for the current request, passed portlet window & portlet URL data object. The generated URL will be complete and ready for rendering.

Parameters:

request - The current request

portletWindow - The portlet window the parameters are for

portletUrl - The Portlet URL data to be written.

Returns:

A fully generated portlet URL ready to be rendered

Throws:

IllegalArgumentException - if request, portletWindowId, or portletUrl are null

parsePortletUrl

PortletUrl parsePortletUrl(HttpServletRequest request)

Parses out PortletUrl data from the request.

Parameters:

request - The request to parse parameters from

Returns:

The PortletUrl data for the request, null if no portlet is targeted by this request

Throws:

IllegalArgumentException - if request is null.