com.xatkit.core.server

Class HttpUtils

java.lang.Object

com.xatkit.core.server.HttpUtils

public class HttpUtils
extends Object

Provides utility methods to manipulate Http-related objects.

Constructor Summary

Constructors

Constructor and Description
HttpUtils()

Method Summary

Modifier and Type	Method and Description
static List<org.apache.http.NameValuePair>	getParameters(org.apache.http.HttpRequest httpRequest) Returns a List containing the parameters associated to the provided httpRequest.
static String	getParameterValue(String parameterName, List<org.apache.http.NameValuePair> parameters) Returns the value associated to the provided parameterName from the given parameters list.
static String	getPath(org.apache.http.HttpRequest httpRequest) Returns the path associated to the provided httpRequest.
static org.apache.http.client.utils.URIBuilder	getURIBuilderFrom(org.apache.http.HttpRequest httpRequest) Returns a URIBuilder from the provided httpRequest.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpUtils

public HttpUtils()

Method Detail

getURIBuilderFrom

public static org.apache.http.client.utils.URIBuilder getURIBuilderFrom(@Nonnull
                                                                        org.apache.http.HttpRequest httpRequest)
                                                                 throws URISyntaxException

Returns a URIBuilder from the provided httpRequest.

Parameters:

httpRequest - the HttpRequest to get an URIBuilder from

Returns:

the created URIBuilder

Throws:

URISyntaxException - if the provided httpRequest's URI is invalid

getPath

public static String getPath(@Nonnull
                             org.apache.http.HttpRequest httpRequest)
                      throws URISyntaxException

Returns the path associated to the provided httpRequest.

The returned path corresponds to the target of the provided httpRequest without the requests parameters. For example, calling this method on a request with the URI /target?param=value will return /target.

Parameters:

httpRequest - the HttpRequest to get the path from

Returns:

the path associated to the provided httpRequest

Throws:

URISyntaxException - if the provided httpRequest's URI is invalid

getParameters

public static List<org.apache.http.NameValuePair> getParameters(@Nonnull
                                                                org.apache.http.HttpRequest httpRequest)
                                                         throws URISyntaxException

Returns a List containing the parameters associated to the provided httpRequest.

Calling this method on a httpRequest instance that does not define any parameter in its request URI returns an empty List.

Parameters:

httpRequest - the HttpRequest to get the parameters from

Returns:

a List containing the parameters associated to the provided httpRequest

Throws:

URISyntaxException - if the provided httpRequest's URI is invalid

getParameterValue

@Nullable
public static String getParameterValue(@Nonnull
                                                 String parameterName,
                                                 @Nonnull
                                                 List<org.apache.http.NameValuePair> parameters)

Returns the value associated to the provided parameterName from the given parameters list.

Parameters:

parameterName - the name of the parameter to retrieve the value of

parameters - the list of parameters to search in

Returns:

the value associated to the provided parameterName from the given parameters list