org.ofbiz.base.util
Class UtilHttp

java.lang.Object
  org.ofbiz.base.util.UtilHttp

public class UtilHttp
extends java.lang.Object

HttpUtil - Misc HTTP Utility Functions

Field Summary

static java.lang.String	COMPOSITE_DELIMITER
static int	COMPOSITE_DELIMITER_LENGTH
static java.lang.String	module
static java.lang.String	MULTI_ROW_DELIMITER
static int	MULTI_ROW_DELIMITER_LENGTH
static java.lang.String	ROW_SUBMIT_PREFIX
static int	ROW_SUBMIT_PREFIX_LENGTH

Constructor Summary

UtilHttp()

Method Summary

static java.lang.String	canonicalizeParameter(java.lang.String paramValue)
static java.util.Map<java.lang.String,java.lang.Object>	canonicalizeParameterMap(java.util.Map<java.lang.String,java.lang.Object> paramMap)
static boolean	checkURLforSpiders(HttpServletRequest request) checks, if the current request comes from a searchbot
static java.lang.String	encodeAmpersands(java.lang.String htmlString)
static java.lang.String	encodeBlanks(java.lang.String htmlString)
static java.lang.String	getApplicationName(HttpServletRequest request) Given a request, returns the application name or "root" if deployed on root
static java.util.Map<java.lang.String,java.lang.Object>	getAttributeMap(HttpServletRequest request) Create a map from a HttpRequest (attributes) object
static java.util.Map<java.lang.String,java.lang.Object>	getAttributeMap(HttpServletRequest request, java.util.Set<? extends java.lang.String> namesToSkip) Create a map from a HttpRequest (attributes) object
static java.util.Map<java.lang.String,java.lang.Object>	getCombinedMap(HttpServletRequest request) Create a combined map from servlet context, session, attributes and parameters
static java.util.Map<java.lang.String,java.lang.Object>	getCombinedMap(HttpServletRequest request, java.util.Set<? extends java.lang.String> namesToSkip) Create a combined map from servlet context, session, attributes and parameters -- this method will only use the skip names for session and servlet context attributes
static java.lang.String	getContentTypeByFileName(java.lang.String fileName)
static java.lang.String	getCurrencyUom(HttpServletRequest request) Get the currency string from the session.
static java.lang.String	getCurrencyUom(HttpSession session, java.lang.String appDefaultCurrencyUom) Get the currency string from the session.
static java.lang.StringBuffer	getFullRequestUrl(HttpServletRequest request)
static java.util.Map<java.lang.String,java.lang.Object>	getJSONAttributeMap(HttpServletRequest request) Create a map from a HttpRequest (attributes) object used in JSON requests
static java.util.Locale	getLocale(HttpServletRequest request) Get the Locale object from a session variable; if not found use the browser's default
static java.util.Locale	getLocale(HttpServletRequest request, HttpSession session, java.lang.Object appDefaultLocale)
static java.util.Locale	getLocale(HttpSession session) Get the Locale object from a session variable; if not found use the system's default.
static int	getMultiFormRowCount(HttpServletRequest request) Returns the number or rows submitted by a multi form.
static java.util.Map<java.lang.String,java.lang.Object>	getParameterMap(HttpServletRequest request) Create a map from a HttpServletRequest (parameters) object
static java.util.Map<java.lang.String,java.lang.Object>	getParameterMap(HttpServletRequest request, java.util.Set<? extends java.lang.String> nameSet)
static java.util.Map<java.lang.String,java.lang.Object>	getParameterMap(HttpServletRequest request, java.util.Set<? extends java.lang.String> nameSet, java.lang.Boolean onlyIncludeOrSkip) Create a map from a HttpServletRequest (parameters) object
static java.util.Map<java.lang.String,java.lang.Object>	getPathInfoOnlyParameterMap(HttpServletRequest request, java.util.Set<? extends java.lang.String> nameSet, java.lang.Boolean onlyIncludeOrSkip)
static java.lang.String	getQueryStringFromTarget(java.lang.String target) Returns the query string contained in a request target - basically everything after and including the ? character.
static java.util.Map<java.lang.String,java.lang.Object>	getQueryStringOnlyParameterMap(HttpServletRequest request)
static java.lang.String	getRequestUriFromTarget(java.lang.String target)
static java.lang.StringBuffer	getServerRootUrl(HttpServletRequest request)
static java.util.Map<java.lang.String,java.lang.Object>	getServletContextMap(HttpServletRequest request) Create a map from a ServletContext object
static java.util.Map<java.lang.String,java.lang.Object>	getServletContextMap(HttpServletRequest request, java.util.Set<? extends java.lang.String> namesToSkip) Create a map from a ServletContext object
static java.lang.String	getSessionId(HttpServletRequest request) Obtains the session ID from the request, or "unknown" if no session pressent.
static java.util.Map<java.lang.String,java.lang.Object>	getSessionMap(HttpServletRequest request) Create a map from a HttpSession object
static java.util.Map<java.lang.String,java.lang.Object>	getSessionMap(HttpServletRequest request, java.util.Set<? extends java.lang.String> namesToSkip) Create a map from a HttpSession object
static java.util.TimeZone	getTimeZone(HttpServletRequest request)
static java.util.Map<java.lang.String,java.lang.Object>	getUrlOnlyParameterMap(HttpServletRequest request)
static java.lang.String	getWebappMountPointFromTarget(java.lang.String target)
static boolean	isJavaScriptEnabled(HttpServletRequest request) Returns true if the user has JavaScript enabled.
static java.lang.String	makeCompositeParam(java.lang.String prefix, java.lang.String suffix) Utility to make a composite parameter from the given prefix and suffix.
static java.util.List<java.lang.Object>	makeParamListWithSuffix(HttpServletRequest request, java.util.Map<java.lang.String,? extends java.lang.Object> additionalFields, java.lang.String suffix, java.lang.String prefix)
static java.util.List<java.lang.Object>	makeParamListWithSuffix(HttpServletRequest request, java.lang.String suffix, java.lang.String prefix)
static java.util.Map<java.lang.String,java.lang.Object>	makeParamMapWithPrefix(HttpServletRequest request, java.util.Map<java.lang.String,? extends java.lang.Object> additionalFields, java.lang.String prefix, java.lang.String suffix)
static java.util.Map<java.lang.String,java.lang.Object>	makeParamMapWithPrefix(HttpServletRequest request, java.lang.String prefix, java.lang.String suffix)
static java.lang.String	makeParamValueFromComposite(HttpServletRequest request, java.lang.String prefix, java.util.Locale locale) Given the prefix of a composite parameter, recomposes a single Object from the composite according to compositeType.
static void	parametersToAttributes(HttpServletRequest request) Put request parameters in request object as attributes.
static java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>>	parseMultiFormData(java.util.Map<java.lang.String,java.lang.Object> parameters) Given multi form data with the ${param}_o_N notation, creates a Collection of Maps for the submitted rows.
static <V> java.util.Map<java.lang.String,V>	removeMultiFormParameters(java.util.Map<java.lang.String,V> parameters) Returns a new map containing all the parameters from the input map except for the multi form parameters (usually named according to the ${param}_o_N notation).
static java.lang.String	removeQueryStringFromTarget(java.lang.String target) Removes the query string from a request target - basically everything after and including the ? character.
static void	restoreStashedParameterMap(HttpServletRequest request, java.lang.String paramMapId)
static void	setCurrencyUom(HttpSession session, java.lang.String currencyUom) Simple event to set the users per-session currency uom value
static void	setCurrencyUomIfNone(HttpSession session, java.lang.String currencyUom)
static void	setInitialRequestInfo(HttpServletRequest request)
static void	setLocale(HttpServletRequest request, java.lang.String localeString)
static void	setLocale(HttpSession session, java.util.Locale locale)
static void	setLocaleIfNone(HttpSession session, java.lang.String localeString)
static java.lang.String	setResponseBrowserProxyNoCache(HttpServletRequest request, HttpServletResponse response)
static void	setResponseBrowserProxyNoCache(HttpServletResponse response)
static void	setTimeZone(HttpServletRequest request, java.lang.String tzId)
static void	setTimeZone(HttpSession session, java.util.TimeZone timeZone)
static java.lang.String	stashParameterMap(HttpServletRequest request)
static void	streamContent(java.io.OutputStream out, java.io.InputStream in, int length) Stream binary content from InputStream to OutputStream This method does not close the streams passed
static void	streamContentToBrowser(HttpServletResponse response, byte[] bytes, java.lang.String contentType)
static void	streamContentToBrowser(HttpServletResponse response, byte[] bytes, java.lang.String contentType, java.lang.String fileName) Stream an array of bytes to the browser This method will close the ServletOutputStream when finished
static void	streamContentToBrowser(HttpServletResponse response, java.io.InputStream in, int length, java.lang.String contentType)
static void	streamContentToBrowser(HttpServletResponse response, java.io.InputStream in, int length, java.lang.String contentType, java.lang.String fileName) Streams content from InputStream to the ServletOutputStream This method will close the ServletOutputStream when finished This method does not close the InputSteam passed
static java.lang.String	stripNamedParamsFromQueryString(java.lang.String queryString, java.util.Collection<java.lang.String> paramNames)
static java.lang.String	stripViewParamsFromQueryString(java.lang.String queryString)
static java.lang.String	stripViewParamsFromQueryString(java.lang.String queryString, java.lang.String paginatorNumber)
static java.lang.String	urlEncodeArgs(java.util.Map<java.lang.String,? extends java.lang.Object> args) URL Encodes a Map of arguements
static java.lang.String	urlEncodeArgs(java.util.Map<java.lang.String,? extends java.lang.Object> args, boolean useExpandedEntites) URL Encodes a Map of arguements

Methods inherited from class java.lang.Object

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

Field Detail

module

public static final java.lang.String module

MULTI_ROW_DELIMITER

public static final java.lang.String MULTI_ROW_DELIMITER

See Also:

Constant Field Values

ROW_SUBMIT_PREFIX

public static final java.lang.String ROW_SUBMIT_PREFIX

See Also:

Constant Field Values

COMPOSITE_DELIMITER

public static final java.lang.String COMPOSITE_DELIMITER

See Also:

Constant Field Values

MULTI_ROW_DELIMITER_LENGTH

public static final int MULTI_ROW_DELIMITER_LENGTH

ROW_SUBMIT_PREFIX_LENGTH

public static final int ROW_SUBMIT_PREFIX_LENGTH

COMPOSITE_DELIMITER_LENGTH

public static final int COMPOSITE_DELIMITER_LENGTH

Constructor Detail

UtilHttp

public UtilHttp()

Method Detail

getCombinedMap

public static java.util.Map<java.lang.String,java.lang.Object> getCombinedMap(HttpServletRequest request)

Create a combined map from servlet context, session, attributes and parameters

Returns:

The resulting Map

getCombinedMap

public static java.util.Map<java.lang.String,java.lang.Object> getCombinedMap(HttpServletRequest request,
                                                                              java.util.Set<? extends java.lang.String> namesToSkip)

Create a combined map from servlet context, session, attributes and parameters -- this method will only use the skip names for session and servlet context attributes

Returns:

The resulting Map

getParameterMap

public static java.util.Map<java.lang.String,java.lang.Object> getParameterMap(HttpServletRequest request)

Create a map from a HttpServletRequest (parameters) object

Returns:

The resulting Map

getParameterMap

public static java.util.Map<java.lang.String,java.lang.Object> getParameterMap(HttpServletRequest request,
                                                                               java.util.Set<? extends java.lang.String> nameSet)

getParameterMap

public static java.util.Map<java.lang.String,java.lang.Object> getParameterMap(HttpServletRequest request,
                                                                               java.util.Set<? extends java.lang.String> nameSet,
                                                                               java.lang.Boolean onlyIncludeOrSkip)

Create a map from a HttpServletRequest (parameters) object

Parameters:

onlyIncludeOrSkip - If true only include, if false skip, the named parameters in the nameSet. If this is null and nameSet is not null, default to skip.

Returns:

The resulting Map

getQueryStringOnlyParameterMap

public static java.util.Map<java.lang.String,java.lang.Object> getQueryStringOnlyParameterMap(HttpServletRequest request)

getPathInfoOnlyParameterMap

public static java.util.Map<java.lang.String,java.lang.Object> getPathInfoOnlyParameterMap(HttpServletRequest request,
                                                                                           java.util.Set<? extends java.lang.String> nameSet,
                                                                                           java.lang.Boolean onlyIncludeOrSkip)

getUrlOnlyParameterMap

public static java.util.Map<java.lang.String,java.lang.Object> getUrlOnlyParameterMap(HttpServletRequest request)

canonicalizeParameterMap

public static java.util.Map<java.lang.String,java.lang.Object> canonicalizeParameterMap(java.util.Map<java.lang.String,java.lang.Object> paramMap)

canonicalizeParameter

public static java.lang.String canonicalizeParameter(java.lang.String paramValue)

getJSONAttributeMap

public static java.util.Map<java.lang.String,java.lang.Object> getJSONAttributeMap(HttpServletRequest request)

Create a map from a HttpRequest (attributes) object used in JSON requests

Returns:

The resulting Map

getAttributeMap

public static java.util.Map<java.lang.String,java.lang.Object> getAttributeMap(HttpServletRequest request)

Create a map from a HttpRequest (attributes) object

Returns:

The resulting Map

getAttributeMap

public static java.util.Map<java.lang.String,java.lang.Object> getAttributeMap(HttpServletRequest request,
                                                                               java.util.Set<? extends java.lang.String> namesToSkip)

Create a map from a HttpRequest (attributes) object

Returns:

The resulting Map

getSessionMap

public static java.util.Map<java.lang.String,java.lang.Object> getSessionMap(HttpServletRequest request)

Create a map from a HttpSession object

Returns:

The resulting Map

getSessionMap

public static java.util.Map<java.lang.String,java.lang.Object> getSessionMap(HttpServletRequest request,
                                                                             java.util.Set<? extends java.lang.String> namesToSkip)

Create a map from a HttpSession object

Returns:

The resulting Map

getServletContextMap

public static java.util.Map<java.lang.String,java.lang.Object> getServletContextMap(HttpServletRequest request)

Create a map from a ServletContext object

Returns:

The resulting Map

getServletContextMap

public static java.util.Map<java.lang.String,java.lang.Object> getServletContextMap(HttpServletRequest request,
                                                                                    java.util.Set<? extends java.lang.String> namesToSkip)

Create a map from a ServletContext object

Returns:

The resulting Map

makeParamMapWithPrefix

public static java.util.Map<java.lang.String,java.lang.Object> makeParamMapWithPrefix(HttpServletRequest request,
                                                                                      java.lang.String prefix,
                                                                                      java.lang.String suffix)

makeParamMapWithPrefix

public static java.util.Map<java.lang.String,java.lang.Object> makeParamMapWithPrefix(HttpServletRequest request,
                                                                                      java.util.Map<java.lang.String,? extends java.lang.Object> additionalFields,
                                                                                      java.lang.String prefix,
                                                                                      java.lang.String suffix)

makeParamListWithSuffix

public static java.util.List<java.lang.Object> makeParamListWithSuffix(HttpServletRequest request,
                                                                       java.lang.String suffix,
                                                                       java.lang.String prefix)

makeParamListWithSuffix

public static java.util.List<java.lang.Object> makeParamListWithSuffix(HttpServletRequest request,
                                                                       java.util.Map<java.lang.String,? extends java.lang.Object> additionalFields,
                                                                       java.lang.String suffix,
                                                                       java.lang.String prefix)

getApplicationName

public static java.lang.String getApplicationName(HttpServletRequest request)

Given a request, returns the application name or "root" if deployed on root

Parameters:

request - An HttpServletRequest to get the name info from

Returns:

String

setInitialRequestInfo

public static void setInitialRequestInfo(HttpServletRequest request)

parametersToAttributes

public static void parametersToAttributes(HttpServletRequest request)

Put request parameters in request object as attributes.

Parameters:

request -

getServerRootUrl

public static java.lang.StringBuffer getServerRootUrl(HttpServletRequest request)

getFullRequestUrl

public static java.lang.StringBuffer getFullRequestUrl(HttpServletRequest request)

getLocale

public static java.util.Locale getLocale(HttpServletRequest request,
                                         HttpSession session,
                                         java.lang.Object appDefaultLocale)

getLocale

public static java.util.Locale getLocale(HttpServletRequest request)

Get the Locale object from a session variable; if not found use the browser's default

Parameters:

request - HttpServletRequest object to use for lookup

Returns:

Locale The current Locale to use

getLocale

public static java.util.Locale getLocale(HttpSession session)

Get the Locale object from a session variable; if not found use the system's default. NOTE: This method is not recommended because it ignores the Locale from the browser not having the request object.

Parameters:

session - HttpSession object to use for lookup

Returns:

Locale The current Locale to use

setLocale

public static void setLocale(HttpServletRequest request,
                             java.lang.String localeString)

setLocale

public static void setLocale(HttpSession session,
                             java.util.Locale locale)

setLocaleIfNone

public static void setLocaleIfNone(HttpSession session,
                                   java.lang.String localeString)

setTimeZone

public static void setTimeZone(HttpServletRequest request,
                               java.lang.String tzId)

setTimeZone

public static void setTimeZone(HttpSession session,
                               java.util.TimeZone timeZone)

getTimeZone

public static java.util.TimeZone getTimeZone(HttpServletRequest request)

getCurrencyUom

public static java.lang.String getCurrencyUom(HttpSession session,
                                              java.lang.String appDefaultCurrencyUom)

Get the currency string from the session.

Parameters:

session - HttpSession object to use for lookup

Returns:

String The ISO currency code

getCurrencyUom

public static java.lang.String getCurrencyUom(HttpServletRequest request)

Get the currency string from the session.

Parameters:

request - HttpServletRequest object to use for lookup

Returns:

String The ISO currency code

setCurrencyUom

public static void setCurrencyUom(HttpSession session,
                                  java.lang.String currencyUom)

Simple event to set the users per-session currency uom value

setCurrencyUomIfNone

public static void setCurrencyUomIfNone(HttpSession session,
                                        java.lang.String currencyUom)

urlEncodeArgs

public static java.lang.String urlEncodeArgs(java.util.Map<java.lang.String,? extends java.lang.Object> args)

URL Encodes a Map of arguements

urlEncodeArgs

public static java.lang.String urlEncodeArgs(java.util.Map<java.lang.String,? extends java.lang.Object> args,
                                             boolean useExpandedEntites)

URL Encodes a Map of arguements

getRequestUriFromTarget

public static java.lang.String getRequestUriFromTarget(java.lang.String target)

getQueryStringFromTarget

public static java.lang.String getQueryStringFromTarget(java.lang.String target)

Returns the query string contained in a request target - basically everything after and including the ? character.

Parameters:

target - The request target

Returns:

The query string

removeQueryStringFromTarget

public static java.lang.String removeQueryStringFromTarget(java.lang.String target)

Removes the query string from a request target - basically everything after and including the ? character.

Parameters:

target - The request target

Returns:

The request target string

getWebappMountPointFromTarget

public static java.lang.String getWebappMountPointFromTarget(java.lang.String target)

encodeAmpersands

public static java.lang.String encodeAmpersands(java.lang.String htmlString)

encodeBlanks

public static java.lang.String encodeBlanks(java.lang.String htmlString)

setResponseBrowserProxyNoCache

public static java.lang.String setResponseBrowserProxyNoCache(HttpServletRequest request,
                                                              HttpServletResponse response)

setResponseBrowserProxyNoCache

public static void setResponseBrowserProxyNoCache(HttpServletResponse response)

getContentTypeByFileName

public static java.lang.String getContentTypeByFileName(java.lang.String fileName)

streamContentToBrowser

public static void streamContentToBrowser(HttpServletResponse response,
                                          byte[] bytes,
                                          java.lang.String contentType,
                                          java.lang.String fileName)
                                   throws java.io.IOException

Stream an array of bytes to the browser This method will close the ServletOutputStream when finished

Parameters:

response - HttpServletResponse object to get OutputStream from

bytes - Byte array of content to stream

contentType - The content type to pass to the browser

fileName - the fileName to tell the browser we are downloading

Throws:

java.io.IOException

streamContentToBrowser

public static void streamContentToBrowser(HttpServletResponse response,
                                          byte[] bytes,
                                          java.lang.String contentType)
                                   throws java.io.IOException

Throws:

java.io.IOException

streamContentToBrowser

public static void streamContentToBrowser(HttpServletResponse response,
                                          java.io.InputStream in,
                                          int length,
                                          java.lang.String contentType,
                                          java.lang.String fileName)
                                   throws java.io.IOException

Streams content from InputStream to the ServletOutputStream This method will close the ServletOutputStream when finished This method does not close the InputSteam passed

Parameters:

response - HttpServletResponse object to get OutputStream from

in - InputStream of the actual content

length - Size (in bytes) of the content

contentType - The content type to pass to the browser

Throws:

java.io.IOException

streamContentToBrowser

public static void streamContentToBrowser(HttpServletResponse response,
                                          java.io.InputStream in,
                                          int length,
                                          java.lang.String contentType)
                                   throws java.io.IOException

Throws:

java.io.IOException

streamContent

public static void streamContent(java.io.OutputStream out,
                                 java.io.InputStream in,
                                 int length)
                          throws java.io.IOException

Stream binary content from InputStream to OutputStream This method does not close the streams passed

Parameters:

out - OutputStream content should go to

in - InputStream of the actual content

length - Size (in bytes) of the content

Throws:

java.io.IOException

stripViewParamsFromQueryString

public static java.lang.String stripViewParamsFromQueryString(java.lang.String queryString)

stripViewParamsFromQueryString

public static java.lang.String stripViewParamsFromQueryString(java.lang.String queryString,
                                                              java.lang.String paginatorNumber)

stripNamedParamsFromQueryString

public static java.lang.String stripNamedParamsFromQueryString(java.lang.String queryString,
                                                               java.util.Collection<java.lang.String> paramNames)

parseMultiFormData

public static java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> parseMultiFormData(java.util.Map<java.lang.String,java.lang.Object> parameters)

Given multi form data with the ${param}_o_N notation, creates a Collection of Maps for the submitted rows. Each Map contains the key/value pairs of a particular row. The keys will be stripped of the _o_N suffix. There is an additionaly key "row" for each Map that holds the index of the row.

removeMultiFormParameters

public static <V> java.util.Map<java.lang.String,V> removeMultiFormParameters(java.util.Map<java.lang.String,V> parameters)

Returns a new map containing all the parameters from the input map except for the multi form parameters (usually named according to the ${param}_o_N notation).

makeCompositeParam

public static java.lang.String makeCompositeParam(java.lang.String prefix,
                                                  java.lang.String suffix)

Utility to make a composite parameter from the given prefix and suffix. The prefix should be a regular paramter name such as meetingDate. The suffix is the composite field, such as the hour of the meeting. The result would be meetingDate_${COMPOSITE_DELIMITER}_hour.

Parameters:

prefix -

suffix -

Returns:

the composite parameter

makeParamValueFromComposite

public static java.lang.String makeParamValueFromComposite(HttpServletRequest request,
                                                           java.lang.String prefix,
                                                           java.util.Locale locale)

Given the prefix of a composite parameter, recomposes a single Object from the composite according to compositeType. For example, consider the following form widget field, The result in HTML is three input boxes to input the date, hour and minutes separately. The parameter names are named meetingDate_c_date, meetingDate_c_hour, meetingDate_c_minutes. Additionally, there will be a field named meetingDate_c_compositeType with a value of "Timestamp". where _c_ is the COMPOSITE_DELIMITER. These parameters will then be recomposed into a Timestamp object from the composite fields.

Parameters:

request -

prefix -

Returns:

Composite object from data or nulll if not supported or a parsing error occured.

getSessionId

public static java.lang.String getSessionId(HttpServletRequest request)

Obtains the session ID from the request, or "unknown" if no session pressent.

checkURLforSpiders

public static boolean checkURLforSpiders(HttpServletRequest request)

checks, if the current request comes from a searchbot

Parameters:

request -

Returns:

whether the request is from a web searchbot

isJavaScriptEnabled

public static boolean isJavaScriptEnabled(HttpServletRequest request)

Returns true if the user has JavaScript enabled.

Parameters:

request -

Returns:

whether javascript is enabled

getMultiFormRowCount

public static int getMultiFormRowCount(HttpServletRequest request)

Returns the number or rows submitted by a multi form.

stashParameterMap

public static java.lang.String stashParameterMap(HttpServletRequest request)

restoreStashedParameterMap

public static void restoreStashedParameterMap(HttpServletRequest request,
                                              java.lang.String paramMapId)