org.springframework.extensions.surf.util
Class OverlayUtil

java.lang.Object
  org.springframework.extensions.surf.util.OverlayUtil

public class OverlayUtil
extends Object

Convenience functions for managing overlay state

Author:

muzquiano

Constructor Summary

OverlayUtil()

Method Summary

static StringBuilder	getCachedResource(javax.servlet.http.HttpServletRequest request, String key) Gets a cached resource from the user session
static String	getOriginalContextPath(javax.servlet.http.HttpServletRequest request) Returns the context path of the original web application
static String	getOriginalURL(javax.servlet.http.HttpServletRequest request, String relativePath) Constructs a browser-friendly path to the original webapp relative path
static String	getWebStudioHostPort(javax.servlet.http.HttpServletRequest request) Returns the host port for the web studio application
static String	getWebStudioURL(javax.servlet.http.HttpServletRequest request, String relativePath) Constructs a browser-friendly path to the web studio relative path
static void	include(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse realResponse, StringBuilder buffer, String path) Performs a wrapped include of a resource and writes results to a buffer
static void	removeCachedResource(javax.servlet.http.HttpServletRequest request, String key) Removes a cached resource from the user session
static void	removeCachedResources(javax.servlet.http.HttpServletRequest request, String key) Removes cached resources that whose start with the given string
static void	setCachedResource(javax.servlet.http.HttpServletRequest request, String key, StringBuilder buffer) Caches a resource into the user session

Methods inherited from class java.lang.Object

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

Constructor Detail

OverlayUtil

public OverlayUtil()

Method Detail

include

public static void include(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse realResponse,
                           StringBuilder buffer,
                           String path)

Performs a wrapped include of a resource and writes results to a buffer

Parameters:

request -

realResponse -

buffer -

path -

getCachedResource

public static StringBuilder getCachedResource(javax.servlet.http.HttpServletRequest request,
                                              String key)

Gets a cached resource from the user session

Parameters:

request -

key -

Returns:

setCachedResource

public static void setCachedResource(javax.servlet.http.HttpServletRequest request,
                                     String key,
                                     StringBuilder buffer)

Caches a resource into the user session

Parameters:

request -

key -

buffer -

removeCachedResource

public static void removeCachedResource(javax.servlet.http.HttpServletRequest request,
                                        String key)

Removes a cached resource from the user session

Parameters:

request - the request

key - the key

removeCachedResources

public static void removeCachedResources(javax.servlet.http.HttpServletRequest request,
                                         String key)

Removes cached resources that whose start with the given string

Parameters:

request -

car -

getWebStudioHostPort

public static String getWebStudioHostPort(javax.servlet.http.HttpServletRequest request)

Returns the host port for the web studio application

Returns:

getWebStudioURL

public static String getWebStudioURL(javax.servlet.http.HttpServletRequest request,
                                     String relativePath)

Constructs a browser-friendly path to the web studio relative path

Parameters:

request -

relativePath -

Returns:

getOriginalContextPath

public static String getOriginalContextPath(javax.servlet.http.HttpServletRequest request)

Returns the context path of the original web application

Parameters:

request -

Returns:

getOriginalURL

public static String getOriginalURL(javax.servlet.http.HttpServletRequest request,
                                    String relativePath)

Constructs a browser-friendly path to the original webapp relative path

Parameters:

request -

relativePath -

Returns: