org.jboss.seam.security.external.api
Interface ResponseHolder

All Known Implementing Classes:

ResponseHolderImpl

public interface ResponseHolder

This class is used in the SPI to pass the HTTP response on to the application. It also contains methods that make it easier for the application to propagate the dialogue over redirects or postbacks.

Author:

Marcel Kolsteren

Method Summary

String	addDialogueIdToUrl(String url) Adds the id of the current dialogue to the URL.
HttpServletResponse	getResponse() Gets the HTTP servlet response
void	redirectWithDialoguePropagation(String url) Results in a redirect to the specified URL.

Method Detail

getResponse

HttpServletResponse getResponse()

Gets the HTTP servlet response

Returns:

the response

redirectWithDialoguePropagation

void redirectWithDialoguePropagation(String url)

Results in a redirect to the specified URL. If a dialogue is active, the id of that dialogue will be appended to the URL as a query parameter, so that the dialogue will be restored when the browser gets the redirect URL.

Parameters:

url - URL

addDialogueIdToUrl

String addDialogueIdToUrl(String url)

Adds the id of the current dialogue to the URL. If no dialogue is active, it just returns the URL unmodified.

Parameters:

url - URL

Returns:

URL