me.geso.webscrew

Class HttpServletRequestUtils

java.lang.Object

me.geso.webscrew.HttpServletRequestUtils

public class HttpServletRequestUtils
extends Object

[EXPERIMENTAL] This class contains utility functions for HttpServletRequest.

Constructor Summary

Constructors

Constructor and Description
HttpServletRequestUtils()

Method Summary

Modifier and Type	Method and Description
static URL	getCurrentURL(javax.servlet.http.HttpServletRequest httpServletRequest) [EXPERIMENTAL] Get the URL for current HTTP request.
static URI	uriFor(javax.servlet.http.HttpServletRequest httpServletRequest, String path, Map<String,String> parameters) [EXPERIMENTAL] Constructs an absolute URI object based on the application root, the provided path, and the additional arguments and query parameters provided.
static URI	uriWith(javax.servlet.http.HttpServletRequest httpServletRequest, Map<String,String> parameters) [EXPERIMENTAL] Returns a rewritten URI object for the current request.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpServletRequestUtils

public HttpServletRequestUtils()

Method Detail

getCurrentURL

public static URL getCurrentURL(@NonNull
                                javax.servlet.http.HttpServletRequest httpServletRequest)
                         throws MalformedURLException

[EXPERIMENTAL] Get the URL for current HTTP request. Return value includes query string.

Returns:

Reconstructed URL

Throws:

MalformedURLException

uriFor

public static URI uriFor(@NonNull
                         javax.servlet.http.HttpServletRequest httpServletRequest,
                         @NonNull
                         String path,
                         @NonNull
                         Map<String,String> parameters)
                  throws URISyntaxException,
                         MalformedURLException

[EXPERIMENTAL] Constructs an absolute URI object based on the application root, the provided path, and the additional arguments and query parameters provided. This method cares context path. You can use relative path from context root. For example, if your context path is http://example.com/xxx/, uriFor("/x") returns http://example.com/xxx/x

Parameters:

httpServletRequest - instance of HttpServletRequest.

path - Path from the current URL. You can use root relative URL from context root.

parameters - Query parameters.

Returns:

Constructed URI.

Throws:

URISyntaxException

MalformedURLException

uriWith

public static URI uriWith(@NonNull
                          javax.servlet.http.HttpServletRequest httpServletRequest,
                          Map<String,String> parameters)
                   throws URISyntaxException,
                          MalformedURLException

[EXPERIMENTAL] Returns a rewritten URI object for the current request. Key/value pairs passed in will override existing parameters. You can remove an existing parameter by passing in an undef value. Unmodified pairs will be preserved.

Parameters:

httpServletRequest - instance of HttpServletRequest.

parameters - Query parameters.

Returns:

Constructed URI.

Throws:

URISyntaxException

MalformedURLException