org.hippoecm.hst.util

Class HstResponseUtils

java.lang.Object

org.hippoecm.hst.util.HstResponseUtils

public class HstResponseUtils
extends Object

HST Response Utils

Version:

$Id: HstResponseUtils.java 40048 2013-07-24 09:56:12Z aschrijvers $

Method Summary

Methods

Modifier and Type	Method and Description
static void	sendPermanentRedirect(HstRequest request, HstResponse response, String path) Facility method for sending a permanent 301 redirect to a sitemap path.
static void	sendPermanentRedirect(HstRequest request, HstResponse response, String path, Map<String,String[]> queryParams) Facility method for sending a permanent 301 redirect to a sitemap path.
static void	sendPermanentRedirect(HstRequest request, HstResponse response, String path, Map<String,String[]> queryParams, String characterEncoding) Facility method for sending a permanent 301 redirect to a sitemap path.
static void	sendRedirect(HstRequest request, HstResponse response, String path) Facility method for sending a temporary 302 redirect to a sitemap path.
static void	sendRedirect(HstRequest request, HstResponse response, String path, Map<String,String[]> queryParams) Facility method for sending a temporary 302 redirect to a sitemap path.
static void	sendRedirect(HstRequest request, HstResponse response, String path, Map<String,String[]> queryParams, String characterEncoding) Facility method for sending a temporary 302 redirect to a sitemap path.
static void	sendRedirectOrForward(HstRequest request, HstResponse response, String path) Deprecated. use sendRedirect(HstRequest, HstResponse, String) if not within a portletContext; portlet support will be removed after 2.26.xx
static void	sendRedirectOrForward(HstRequest request, HstResponse response, String path, Map<String,String[]> queryParams) Deprecated. use sendRedirect(HstRequest, HstResponse, String,Map) if not within a portletContext; portlet support will be removed after 2.26.xx
static void	sendRedirectOrForward(HstRequest request, HstResponse response, String path, Map<String,String[]> queryParams, String characterEncoding) Deprecated. use sendRedirect(HstRequest,HstResponse,String,Map,String) if not within a portletContext; portlet support will be removed after 2.26.xx

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

sendRedirect

public static void sendRedirect(HstRequest request,
                HstResponse response,
                String path)

Facility method for sending a temporary 302 redirect to a sitemap path.

Parameters:

request - the HstRequest

response - the HstResponse

path - the sitemap path you want to redirect to

sendPermanentRedirect

public static void sendPermanentRedirect(HstRequest request,
                         HstResponse response,
                         String path)

Facility method for sending a permanent 301 redirect to a sitemap path.

Parameters:

request - the HstRequest

response - the HstResponse

path - the sitemap path you want to redirect to

sendRedirect

public static void sendRedirect(HstRequest request,
                HstResponse response,
                String path,
                Map<String,String[]> queryParams)

Facility method for sending a temporary 302 redirect to a sitemap path.

Parameters:

request - the HstRequest

response - the HstResponse

path - the sitemap path you want to redirect to

queryParams - query parameters to append to the redirection url

sendPermanentRedirect

public static void sendPermanentRedirect(HstRequest request,
                         HstResponse response,
                         String path,
                         Map<String,String[]> queryParams)

Facility method for sending a permanent 301 redirect to a sitemap path.

Parameters:

request - the HstRequest

response - the HstResponse

path - the sitemap path you want to redirect to

queryParams - query parameters to append to the redirection url

sendRedirect

public static void sendRedirect(HstRequest request,
                HstResponse response,
                String path,
                Map<String,String[]> queryParams,
                String characterEncoding)

Facility method for sending a temporary 302 redirect to a sitemap path.

Parameters:

request - the HstRequest

response - the HstResponse

path - the sitemap path you want to redirect to

queryParams - query parameters to append to the redirection url

characterEncoding - character encoding for query parameters

sendPermanentRedirect

public static void sendPermanentRedirect(HstRequest request,
                         HstResponse response,
                         String path,
                         Map<String,String[]> queryParams,
                         String characterEncoding)

Facility method for sending a permanent 301 redirect to a sitemap path.

Parameters:

request - the HstRequest

response - the HstResponse

path - the sitemap path you want to redirect to

queryParams - query parameters to append to the redirection url

characterEncoding - character encoding for query parameters

sendRedirectOrForward

@Deprecated
public static void sendRedirectOrForward(HstRequest request,
                                    HstResponse response,
                                    String path)

Deprecated. use sendRedirect(HstRequest, HstResponse, String) if not within a portletContext; portlet support will be removed after 2.26.xx

Facility method for sending a redirect if available or forwarding otherwise to a SiteMapItemId.

Note: When the component is deployed on a normal servlet application, then this method tries to send a redirect if this method is invoked during doAction() or doBeforeRender() methods.
Meanwhile when the component is deployed on a portlet application for a portal, then this method tries to send a redirect if this method is invoked during doAction(), but it tries to forward during doBeforeRender() methods because it is allowed only in the action phase to send a redirect in a portlet.

Parameters:

request - the HstRequest

response - the HstResponse

path - the sitemap path you want to redirect to

sendRedirectOrForward

@Deprecated
public static void sendRedirectOrForward(HstRequest request,
                                    HstResponse response,
                                    String path,
                                    Map<String,String[]> queryParams)

Deprecated. use sendRedirect(HstRequest, HstResponse, String,Map) if not within a portletContext; portlet support will be removed after 2.26.xx

Facility method for sending a redirect if available or forwarding otherwise to a SiteMapItemId.

Note: When the component is deployed on a normal servlet application, then this method tries to send a redirect if this method is invoked during doAction() or doBeforeRender() methods.
Meanwhile when the component is deployed on a portlet application for a portal, then this method tries to send a redirect if this method is invoked during doAction(), but it tries to forward during doBeforeRender() methods because it is allowed only in the action phase to send a redirect in a portlet.

Parameters:

request - the HstRequest

response - the HstResponse

path - the sitemap path you want to redirect to

queryParams - query parameters to append to the redirection url

sendRedirectOrForward

@Deprecated
public static void sendRedirectOrForward(HstRequest request,
                                    HstResponse response,
                                    String path,
                                    Map<String,String[]> queryParams,
                                    String characterEncoding)

Deprecated. use sendRedirect(HstRequest,HstResponse,String,Map,String) if not within a portletContext; portlet support will be removed after 2.26.xx

Facility method for sending a redirect if available or forwarding otherwise to a SiteMapItemId.

Note: When the component is deployed on a normal servlet application, then this method tries to send a redirect if this method is invoked during doAction() or doBeforeRender() methods.
Meanwhile when the component is deployed on a portlet application for a portal, then this method tries to send a redirect if this method is invoked during doAction(), but it tries to forward during doBeforeRender() methods because it is allowed only in the action phase to send a redirect in a portlet.

Parameters:

request - the HstRequest

response - the HstResponse

path - the sitemap path you want to redirect to

queryParams - query parameters to append to the redirection url

characterEncoding - character encoding for query parameters