com.netflix.zuul.util

Class HTTPRequestUtils

java.lang.Object

com.netflix.zuul.util.HTTPRequestUtils

public class HTTPRequestUtils
extends java.lang.Object

Some handy methods for workign with HTTP requests

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	X_FORWARDED_FOR_HEADER

Constructor Summary

Constructors

Constructor and Description
HTTPRequestUtils()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	extractClientIpFromXForwardedFor(java.lang.String xForwardedFor) Extract the client IP address from an x-forwarded-for header.
java.lang.String	getClientIP(javax.servlet.http.HttpServletRequest request) Get the IP address of client making the request.
java.lang.String	getFormValue(java.lang.String sHeaderName) returns a form value from a given sHeaderName
java.lang.String	getHeaderValue(java.lang.String sHeaderName) returns the Header value for the given sHeaderName
static HTTPRequestUtils	getInstance() return singleton HTTPRequestUtils object
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getQueryParams() returns query params as a Map with String keys and Lists of Strings as values
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getRequestHeaderMap() returns headers as a Map with String keys and Lists of Strings as values
java.lang.String	getValueFromRequestElements(java.lang.String sName) Checks headers, query string, and form body for a given parameter
boolean	isGzipped(java.lang.String contentEncoding) return true if the client requested gzip content

Methods inherited from class java.lang.Object

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

Field Detail

X_FORWARDED_FOR_HEADER

public static final java.lang.String X_FORWARDED_FOR_HEADER

See Also:

Constant Field Values

Constructor Detail

HTTPRequestUtils

public HTTPRequestUtils()

Method Detail

getClientIP

public java.lang.String getClientIP(javax.servlet.http.HttpServletRequest request)

Get the IP address of client making the request. Uses the "x-forwarded-for" HTTP header if available, otherwise uses the remote IP of requester.

Parameters:

request - HttpServletRequest

Returns:

String IP address

extractClientIpFromXForwardedFor

public final java.lang.String extractClientIpFromXForwardedFor(java.lang.String xForwardedFor)

Extract the client IP address from an x-forwarded-for header. Returns null if there is no x-forwarded-for header

Parameters:

xForwardedFor - a String value

Returns:

a String value

getInstance

public static HTTPRequestUtils getInstance()

return singleton HTTPRequestUtils object

Returns:

a HTTPRequestUtils value

getHeaderValue

public java.lang.String getHeaderValue(java.lang.String sHeaderName)

returns the Header value for the given sHeaderName

Parameters:

sHeaderName - a String value

Returns:

a String value

getFormValue

public java.lang.String getFormValue(java.lang.String sHeaderName)

returns a form value from a given sHeaderName

Parameters:

sHeaderName - a String value

Returns:

a String value

getRequestHeaderMap

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getRequestHeaderMap()

returns headers as a Map with String keys and Lists of Strings as values

Returns:

getQueryParams

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getQueryParams()

returns query params as a Map with String keys and Lists of Strings as values

Returns:

getValueFromRequestElements

public java.lang.String getValueFromRequestElements(java.lang.String sName)

Checks headers, query string, and form body for a given parameter

Parameters:

sName -

Returns:

isGzipped

public boolean isGzipped(java.lang.String contentEncoding)

return true if the client requested gzip content

Parameters:

contentEncoding - a String value

Returns:

true if the content-encoding param containg gzip