org.apache.ambari.server.utils

Class RequestUtils

java.lang.Object

org.apache.ambari.server.utils.RequestUtils

public class RequestUtils
extends Object

The purpose of this helper is to get remote address from an HTTP request

Constructor Summary

Constructors

Constructor and Description
RequestUtils()

Method Summary

Modifier and Type	Method and Description
static org.springframework.util.MultiValueMap<String,String>	getQueryStringParameters(javax.servlet.http.HttpServletRequest request) Returns a MultiValueMap of the parameters parsed from the request's query string.
static String	getQueryStringParameterValue(javax.servlet.http.HttpServletRequest request, String parameterName) Returns the value parsed from the request's query string for the given parameter name.
static List<String>	getQueryStringParameterValues(javax.servlet.http.HttpServletRequest request, String parameterName) Returns a List of values parsed from the request's query string for the given parameter name.
static String	getRemoteAddress() Returns remote address by using HttpServletRequest from RequestContextHolder
static String	getRemoteAddress(javax.servlet.http.HttpServletRequest request) Returns remote address
static void	logRequestHeadersAndQueryParams(javax.servlet.http.HttpServletRequest request, org.slf4j.Logger logger) Posts an informational message the the supplied Logger showing the request headers and query parameters

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestUtils

public RequestUtils()

Method Detail

getRemoteAddress

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

Returns remote address

Parameters:

request - contains the details of http request

Returns:

getRemoteAddress

public static String getRemoteAddress()

Returns remote address by using HttpServletRequest from RequestContextHolder

Returns:

logRequestHeadersAndQueryParams

public static void logRequestHeadersAndQueryParams(javax.servlet.http.HttpServletRequest request,
                                                   org.slf4j.Logger logger)

Posts an informational message the the supplied Logger showing the request headers and query parameters

For example:

 ##### HEADERS ########
 X-Requested-By = ambari
 ...
 Accept-Encoding = gzip, deflate
 Accept-Language = en-US,en;q=0.9
 ######################
 ##### PARAMETERS #####
 _ = 1543700737939
 ######################
 

Parameters:

request - the HttpServletRequest to log

logger - the Logger

getQueryStringParameters

public static org.springframework.util.MultiValueMap<String,String> getQueryStringParameters(javax.servlet.http.HttpServletRequest request)

Returns a MultiValueMap of the parameters parsed from the request's query string. The returned map will not contain any parameters that may be in the body of the request as form data.

This implementation manually parses the query string rather than use ServletRequest.getParameterValues(String) so that the message body remains intact and available. Calling ServletRequest.getParameterValues(String) could interfere with processing the body of this request later since the body is parsed to find any form parameters.

Parameters:

request - the HttpServletRequest

Returns:

a Map of query parameters to values

getQueryStringParameterValues

public static List<String> getQueryStringParameterValues(javax.servlet.http.HttpServletRequest request,
                                                         String parameterName)

Returns a List of values parsed from the request's query string for the given parameter name.

Parameters:

request - the HttpServletRequest

Returns:

a List of values for the specified query parameter; or null if the requested parameter is not present

See Also:

getQueryStringParameters(HttpServletRequest)

getQueryStringParameterValue

public static String getQueryStringParameterValue(javax.servlet.http.HttpServletRequest request,
                                                  String parameterName)

Returns the value parsed from the request's query string for the given parameter name.

If more than one value for the given parameter name is found, the first value will be retured.

Parameters:

request - the HttpServletRequest

Returns:

the value for the specified query parameter; or null if the requested parameter is not present

See Also:

getQueryStringParameters(HttpServletRequest)