com.helger.servlet.request

Class RequestHelper

java.lang.Object

com.helger.servlet.request.RequestHelper

@Immutable
public final class RequestHelper
extends Object

Misc. helper method on HttpServletRequest objects.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTACHMENT Content-disposition value for file attachment.
static String	DEFAULT_CHECKBOX_HIDDEN_FIELD_PREFIX The prefix to appended to the field name of the checkbox to create the hidden field.
static String	FORM_DATA Content-disposition value for form data.
static String	MULTIPART Part of HTTP content type header.
static String	MULTIPART_FORM_DATA HTTP content type header for multipart forms.
static String	MULTIPART_MIXED HTTP content type header for multiple uploads.
static String	SERVLET_ATTR_CLIENT_CERTIFICATE
static String	SERVLET_ATTR_SSL_CIPHER_SUITE
static String	SERVLET_ATTR_SSL_KEY_SIZE

Method Summary

Modifier and Type	Method and Description
static com.helger.http.AcceptCharsetList	getAcceptCharsets(javax.servlet.http.HttpServletRequest aHttpRequest)
static com.helger.http.AcceptEncodingList	getAcceptEncodings(javax.servlet.http.HttpServletRequest aHttpRequest)
static com.helger.http.AcceptLanguageList	getAcceptLanguages(javax.servlet.http.HttpServletRequest aHttpRequest)
static com.helger.http.AcceptMimeTypeList	getAcceptMimeTypes(javax.servlet.http.HttpServletRequest aHttpRequest)
static com.helger.http.basicauth.BasicAuthClientCredentials	getBasicAuthClientCredentials(javax.servlet.http.HttpServletRequest aHttpRequest) Get the Basic authentication credentials from the passed HTTP servlet request from the HTTP header CHttpHeader.AUTHORIZATION.
static String	getCheckBoxHiddenFieldName(String sFieldName) Get the name of the automatic hidden field associated with a check-box.
static long	getContentLength(javax.servlet.http.HttpServletRequest aHttpRequest) Get the content length of the passed request.
static int	getDefaultServerPort(String sScheme)
static com.helger.http.digestauth.DigestAuthClientCredentials	getDigestAuthClientCredentials(javax.servlet.http.HttpServletRequest aHttpRequest) Get the Digest authentication credentials from the passed HTTP servlet request from the HTTP header CHttpHeader.AUTHORIZATION.
static StringBuilder	getFullServerName(javax.servlet.http.HttpServletRequest aHttpRequest)
static StringBuilder	getFullServerName(String sScheme, String sServerName, int nServerPort)
static String	getFullServerNameAndPath(String sScheme, String sServerName, int nServerPort, String sPath, String sQueryString)
static com.helger.commons.http.EHttpMethod	getHttpMethod(javax.servlet.http.HttpServletRequest aHttpRequest) Get the HTTP method associated with the given HTTP request
static String	getHttpReferer(javax.servlet.http.HttpServletRequest aHttpRequest)
static String	getHttpUserAgentStringFromRequest(javax.servlet.http.HttpServletRequest aHttpRequest) Get the user agent from the given request.
static com.helger.http.EHttpVersion	getHttpVersion(javax.servlet.http.HttpServletRequest aHttpRequest) Get the HTTP version associated with the given HTTP request
static String	getPathInfo(javax.servlet.http.HttpServletRequest aHttpRequest) Get the request path info without an eventually appended session (";jsessionid=...")
static String	getPathWithinServlet(javax.servlet.http.HttpServletRequest aHttpRequest) Return the path within the servlet mapping for the given request, i.e. the part of the request's URL beyond the part that called the servlet, or "" if the whole URL has been used to identify the servlet.
static String	getPathWithinServletContext(javax.servlet.http.HttpServletRequest aHttpRequest) Return the URI of the request within the servlet context.
static X509Certificate[]	getRequestClientCertificates(javax.servlet.http.HttpServletRequest aHttpRequest) Get the client certificates provided by a HTTP servlet request.
static com.helger.commons.http.HttpHeaderMap	getRequestHeaderMap(javax.servlet.http.HttpServletRequest aHttpRequest) Get a complete request header map as a copy.
static IRequestParamMap	getRequestParamMap(javax.servlet.http.HttpServletRequest aHttpRequest)
static String	getRequestSSLCipherSuite(javax.servlet.http.HttpServletRequest aHttpRequest)
static Integer	getRequestSSLKeySize(javax.servlet.http.HttpServletRequest aHttpRequest)
static String	getRequestURI(javax.servlet.http.HttpServletRequest aHttpRequest) Get the request URI without an eventually appended session (";jsessionid=...").
static StringBuilder	getRequestURL(javax.servlet.http.HttpServletRequest aHttpRequest) Reconstructs the URL the client used to make the request.
static int	getServerPortToUse(String sScheme, int nServerPort)
static String	getSessionID(com.helger.commons.url.ISimpleURL aURL) Get the session ID of the passed string (like in "test.html;JSESSIONID=1234").
static String	getSessionID(String sValue) Get the session ID of the passed string (like in "test.html;JSESSIONID=1234").
static com.helger.useragent.uaprofile.UAProfile	getUAProfile(javax.servlet.http.HttpServletRequest aHttpRequest) Get the user agent object from the given HTTP request.
static String	getURI(javax.servlet.http.HttpServletRequest aHttpRequest) Get the full URI (excl. protocol) and parameters of the passed request.
static String	getURL(javax.servlet.http.HttpServletRequest aHttpRequest) Get the full URL (incl. protocol) and parameters of the passed request.
static com.helger.useragent.IUserAgent	getUserAgent(javax.servlet.http.HttpServletRequest aHttpRequest) Get the user agent object from the given HTTP request.
static com.helger.commons.url.SimpleURL	getWithoutSessionID(com.helger.commons.url.ISimpleURL aURL) Get the passed string without an eventually contained session ID like in "test.html;JSESSIONID=1234?
static String	getWithoutSessionID(String sValue) Get the passed string without an eventually contained session ID like in "test.html;JSESSIONID=1234".
static boolean	isMultipartContent(javax.servlet.http.HttpServletRequest aHttpRequest) Utility method that determines whether the request contains multipart content.
static boolean	isMultipartContent(String sContentType) Utility method that determines whether the request contains multipart content.
static boolean	isMultipartFormDataContent(javax.servlet.http.HttpServletRequest aHttpRequest) Utility method that determines whether the request contains multipart content.
static boolean	isMultipartFormDataContent(String sContentType) Utility method that determines whether the request contains multipart/form-data content.

Methods inherited from class java.lang.Object

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

Field Detail

SERVLET_ATTR_SSL_CIPHER_SUITE

public static final String SERVLET_ATTR_SSL_CIPHER_SUITE

See Also:

Constant Field Values

SERVLET_ATTR_SSL_KEY_SIZE

public static final String SERVLET_ATTR_SSL_KEY_SIZE

See Also:

Constant Field Values

SERVLET_ATTR_CLIENT_CERTIFICATE

public static final String SERVLET_ATTR_CLIENT_CERTIFICATE

See Also:

Constant Field Values

FORM_DATA

public static final String FORM_DATA

Content-disposition value for form data.

See Also:

Constant Field Values

ATTACHMENT

public static final String ATTACHMENT

Content-disposition value for file attachment.

See Also:

Constant Field Values

MULTIPART

public static final String MULTIPART

Part of HTTP content type header. Must be all lower case!

See Also:

Constant Field Values

MULTIPART_FORM_DATA

public static final String MULTIPART_FORM_DATA

HTTP content type header for multipart forms. Must be all lower case!

See Also:

Constant Field Values

MULTIPART_MIXED

public static final String MULTIPART_MIXED

HTTP content type header for multiple uploads. Must be all lower case!

See Also:

Constant Field Values

DEFAULT_CHECKBOX_HIDDEN_FIELD_PREFIX

public static final String DEFAULT_CHECKBOX_HIDDEN_FIELD_PREFIX

The prefix to appended to the field name of the checkbox to create the hidden field.

See Also:

Constant Field Values

Method Detail

getWithoutSessionID

@Nonnull
public static String getWithoutSessionID(@Nonnull
                                                   String sValue)

Get the passed string without an eventually contained session ID like in "test.html;JSESSIONID=1234".
Attention: this methods does not consider eventually present request parameters. If parameters are present, they are most likely be stripped away!

Parameters:

sValue - The value to strip the session ID from. May not be null.

Returns:

The value without a session ID or the original string.

getWithoutSessionID

@Nonnull
public static com.helger.commons.url.SimpleURL getWithoutSessionID(@Nonnull
                                                                             com.helger.commons.url.ISimpleURL aURL)

Get the passed string without an eventually contained session ID like in "test.html;JSESSIONID=1234?param=value".

Parameters:

aURL - The value to strip the session ID from the path

Returns:

The value without a session ID or the original string.

getSessionID

@Nullable
public static String getSessionID(@Nonnull
                                             String sValue)

Get the session ID of the passed string (like in "test.html;JSESSIONID=1234").
Attention: this methods does not consider eventually present request parameters. If parameters are present, they must be stripped away explicitly!

Parameters:

sValue - The value to get the session ID from. May not be null.

Returns:

The session ID of the value or null if no session ID is present.

getSessionID

@Nullable
public static String getSessionID(@Nonnull
                                             com.helger.commons.url.ISimpleURL aURL)

Get the session ID of the passed string (like in "test.html;JSESSIONID=1234").
Attention: this methods does not consider eventually present request parameters. If parameters are present, they must be stripped away explicitly!

Parameters:

aURL - The URL to get the session ID from. May not be null.

Returns:

The session ID of the value or null if no session ID is present.

getRequestURI

@Nullable
public static String getRequestURI(@Nonnull
                                              javax.servlet.http.HttpServletRequest aHttpRequest)

Get the request URI without an eventually appended session (";jsessionid=..."). This method considers the GlobalWebScope custom context path.

First line of HTTP request	Returned Value
POST /some/path.html;JSESSIONID=4711	/some/path.html
GET http://foo.bar/a.html;JSESSIONID=4711	/a.html
HEAD /xyz;JSESSIONID=4711?a=b	/xyz

Parameters:

aHttpRequest - The HTTP request

Returns:

The request URI without the optional session ID

getPathInfo

@Nullable
public static String getPathInfo(@Nonnull
                                            javax.servlet.http.HttpServletRequest aHttpRequest)

Get the request path info without an eventually appended session (";jsessionid=...")

Parameters:

aHttpRequest - The HTTP request

Returns:

Returns any extra path information associated with the URL the client sent when it made this request. The extra path information follows the servlet path but precedes the query string and will start with a "/" character. The optional session ID is stripped.

getPathWithinServletContext

@Nonnull
public static String getPathWithinServletContext(@Nonnull
                                                           javax.servlet.http.HttpServletRequest aHttpRequest)

Return the URI of the request within the servlet context.

Parameters:

aHttpRequest - The HTTP request. May not be null.

Returns:

the path within the web application and never null. By default "/" is returned is an empty request URI is determined.

getPathWithinServlet

@Nonnull
public static String getPathWithinServlet(@Nonnull
                                                    javax.servlet.http.HttpServletRequest aHttpRequest)

Return the path within the servlet mapping for the given request, i.e. the part of the request's URL beyond the part that called the servlet, or "" if the whole URL has been used to identify the servlet.
Detects include request URL if called within a RequestDispatcher include.
E.g.: servlet mapping = "/test/*"; request URI = "/test/a" -> "/a".
E.g.: servlet mapping = "/test"; request URI = "/test" -> "".
E.g.: servlet mapping = "/*.test"; request URI = "/a.test" -> "".

Parameters:

aHttpRequest - current HTTP request

Returns:

the path within the servlet mapping, or ""

getRequestURL

@Nonnull
 @Nonempty
public static StringBuilder getRequestURL(@Nonnull
                                                                javax.servlet.http.HttpServletRequest aHttpRequest)

Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and server path, but it does not include query string parameters.

If this request has been forwarded using RequestDispatcher.forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse), the server path in the reconstructed URL must reflect the path used to obtain the RequestDispatcher, and not the server path specified by the client.

Because this method returns a StringBuilder, not a string, you can modify the URL easily, for example, to append query parameters.

This method is useful for creating redirect messages and for reporting errors.

Parameters:

aHttpRequest - The HTTP request to get the request URL from. May not be null.

Returns:

a StringBuilder object containing the reconstructed URL

getURL

@Nonnull
 @Nonempty
public static String getURL(@Nonnull
                                                  javax.servlet.http.HttpServletRequest aHttpRequest)

Get the full URL (incl. protocol) and parameters of the passed request.

 http://hostname.com/mywebapp/servlet/dir/a/b.xml=123?d=789
 

Parameters:

aHttpRequest - The request to use. May not be null.

Returns:

The full URL.

See Also:

getURI to retrieve the URL without the server scheme and name.

getURI

@Nonnull
 @Nonempty
public static String getURI(@Nonnull
                                                  javax.servlet.http.HttpServletRequest aHttpRequest)

Get the full URI (excl. protocol) and parameters of the passed request.
Example:

 /mywebapp/servlet/dir/a/b.xml=123?d=789
 

Parameters:

aHttpRequest - The request to use. May not be null.

Returns:

The full URI.

See Also:

getURL to retrieve the absolute URL

getDefaultServerPort

@CheckForSigned
public static int getDefaultServerPort(@Nullable
                                                        String sScheme)

getServerPortToUse

@CheckForSigned
public static int getServerPortToUse(@Nonnull
                                                      String sScheme,
                                                      @CheckForSigned
                                                      int nServerPort)

getFullServerName

@Nonnull
 @Nonempty
public static StringBuilder getFullServerName(@Nonnull
                                                                    javax.servlet.http.HttpServletRequest aHttpRequest)

getFullServerName

@Nonnull
 @Nonempty
public static StringBuilder getFullServerName(@Nullable
                                                                    String sScheme,
                                                                    @Nullable
                                                                    String sServerName,
                                                                    int nServerPort)

getFullServerNameAndPath

@Nonnull
 @Nonempty
public static String getFullServerNameAndPath(@Nonnull
                                                                    String sScheme,
                                                                    @Nonnull
                                                                    String sServerName,
                                                                    int nServerPort,
                                                                    @Nullable
                                                                    String sPath,
                                                                    @Nullable
                                                                    String sQueryString)

getHttpReferer

@Nullable
public static String getHttpReferer(@Nonnull
                                               javax.servlet.http.HttpServletRequest aHttpRequest)

getHttpVersion

@Nullable
public static com.helger.http.EHttpVersion getHttpVersion(@Nonnull
                                                                     javax.servlet.http.HttpServletRequest aHttpRequest)

Get the HTTP version associated with the given HTTP request

Parameters:

aHttpRequest - The http request to query. May not be null.

Returns:

null if no supported HTTP version is contained

getHttpMethod

@Nullable
public static com.helger.commons.http.EHttpMethod getHttpMethod(@Nonnull
                                                                           javax.servlet.http.HttpServletRequest aHttpRequest)

Get the HTTP method associated with the given HTTP request

Parameters:

aHttpRequest - The http request to query. May not be null.

Returns:

null if no supported HTTP method is contained

getRequestHeaderMap

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.http.HttpHeaderMap getRequestHeaderMap(@Nonnull
                                                                                                        javax.servlet.http.HttpServletRequest aHttpRequest)

Get a complete request header map as a copy.

Parameters:

aHttpRequest - The source HTTP request. May not be null.

Returns:

Never null.

getRequestParamMap

@Nonnull
public static IRequestParamMap getRequestParamMap(@Nonnull
                                                            javax.servlet.http.HttpServletRequest aHttpRequest)

getContentLength

@CheckForSigned
public static long getContentLength(@Nonnull
                                                     javax.servlet.http.HttpServletRequest aHttpRequest)

Get the content length of the passed request. This is not done using request.getContentLength() but instead parsing the HTTP header field CHttpHeader.CONTENT_LENGTH manually!

Parameters:

aHttpRequest - Source HTTP request. May not be null.

Returns:

-1 if no or an invalid content length is set in the header

getRequestSSLCipherSuite

@Nullable
public static String getRequestSSLCipherSuite(@Nonnull
                                                         javax.servlet.http.HttpServletRequest aHttpRequest)

Parameters:

aHttpRequest - he HTTP servlet request to extract the information from. May not be null.

Returns:

SSL cipher suite or null if no such attribute is present

getRequestSSLKeySize

@Nullable
public static Integer getRequestSSLKeySize(@Nonnull
                                                      javax.servlet.http.HttpServletRequest aHttpRequest)

Parameters:

aHttpRequest - he HTTP servlet request to extract the information from. May not be null.

Returns:

Bit size of the algorithm or null if no such attribute is present

getRequestClientCertificates

@Nullable
public static X509Certificate[] getRequestClientCertificates(@Nonnull
                                                                        javax.servlet.http.HttpServletRequest aHttpRequest)

Get the client certificates provided by a HTTP servlet request.

Parameters:

aHttpRequest - The HTTP servlet request to extract the information from. May not be null.

Returns:

null if the passed request does not contain any client certificate

isMultipartContent

public static boolean isMultipartContent(@Nullable
                                         String sContentType)

Utility method that determines whether the request contains multipart content.

Parameters:

sContentType - The content type to be checked. May be null.

Returns:

true if the request is multipart; false otherwise.

isMultipartContent

public static boolean isMultipartContent(@Nonnull
                                         javax.servlet.http.HttpServletRequest aHttpRequest)

Utility method that determines whether the request contains multipart content.

Parameters:

aHttpRequest - The servlet request to be evaluated. Must be non-null.

Returns:

true if the request is multipart; false otherwise.

isMultipartFormDataContent

public static boolean isMultipartFormDataContent(@Nullable
                                                 String sContentType)

Utility method that determines whether the request contains multipart/form-data content.

Parameters:

sContentType - The content type to be checked. May be null.

Returns:

true if the passed, lowercased content type starts with multipart/form-data; false otherwise.

isMultipartFormDataContent

public static boolean isMultipartFormDataContent(@Nonnull
                                                 javax.servlet.http.HttpServletRequest aHttpRequest)

Utility method that determines whether the request contains multipart content.

Parameters:

aHttpRequest - The servlet request to be evaluated. Must be non-null.

Returns:

true if the request is multipart; false otherwise.

getAcceptCharsets

@Nonnull
public static com.helger.http.AcceptCharsetList getAcceptCharsets(@Nonnull
                                                                            javax.servlet.http.HttpServletRequest aHttpRequest)

getAcceptEncodings

@Nonnull
public static com.helger.http.AcceptEncodingList getAcceptEncodings(@Nonnull
                                                                              javax.servlet.http.HttpServletRequest aHttpRequest)

getAcceptLanguages

@Nonnull
public static com.helger.http.AcceptLanguageList getAcceptLanguages(@Nonnull
                                                                              javax.servlet.http.HttpServletRequest aHttpRequest)

getAcceptMimeTypes

@Nonnull
public static com.helger.http.AcceptMimeTypeList getAcceptMimeTypes(@Nonnull
                                                                              javax.servlet.http.HttpServletRequest aHttpRequest)

getBasicAuthClientCredentials

@Nullable
public static com.helger.http.basicauth.BasicAuthClientCredentials getBasicAuthClientCredentials(@Nonnull
                                                                                                            javax.servlet.http.HttpServletRequest aHttpRequest)

Get the Basic authentication credentials from the passed HTTP servlet request from the HTTP header CHttpHeader.AUTHORIZATION.

Parameters:

aHttpRequest - The HTTP request to be interpreted. May be null.

Returns:

null if the passed request does not contain a valid HTTP Basic Authentication header value.

getDigestAuthClientCredentials

@Nullable
public static com.helger.http.digestauth.DigestAuthClientCredentials getDigestAuthClientCredentials(@Nonnull
                                                                                                               javax.servlet.http.HttpServletRequest aHttpRequest)

Get the Digest authentication credentials from the passed HTTP servlet request from the HTTP header CHttpHeader.AUTHORIZATION.

Parameters:

aHttpRequest - The HTTP request to be interpreted. May be null.

Returns:

null if the passed request does not contain a valid HTTP Digest Authentication header value.

getHttpUserAgentStringFromRequest

@Nullable
public static String getHttpUserAgentStringFromRequest(@Nonnull
                                                                  javax.servlet.http.HttpServletRequest aHttpRequest)

Get the user agent from the given request.

Parameters:

aHttpRequest - The HTTP request to get the UA from.

Returns:

null if no user agent string is present

getUserAgent

@Nonnull
public static com.helger.useragent.IUserAgent getUserAgent(@Nonnull
                                                                     javax.servlet.http.HttpServletRequest aHttpRequest)

Get the user agent object from the given HTTP request.

Parameters:

aHttpRequest - The HTTP request to extract the information from.

Returns:

A non-null user agent object.

getUAProfile

@Nonnull
public static com.helger.useragent.uaprofile.UAProfile getUAProfile(@Nonnull
                                                                              javax.servlet.http.HttpServletRequest aHttpRequest)

Get the user agent object from the given HTTP request.

Parameters:

aHttpRequest - The HTTP request to extract the information from.

Returns:

A non-null user agent object.

getCheckBoxHiddenFieldName

@Nonnull
 @Nonempty
public static String getCheckBoxHiddenFieldName(@Nonnull @Nonempty
                                                                      String sFieldName)

Get the name of the automatic hidden field associated with a check-box.

Parameters:

sFieldName - The name of the check-box.

Returns:

The name of the hidden field associated with the given check-box name.