net.officefloor.plugin.web.http.tokenise

Class HttpRequestTokeniserImpl

java.lang.Object

net.officefloor.plugin.web.http.tokenise.HttpRequestTokeniserImpl

All Implemented Interfaces:

HttpRequestTokeniser

public class HttpRequestTokeniserImpl
extends Object
implements HttpRequestTokeniser

HttpRequestTokeniser implementation.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
HttpRequestTokeniserImpl()

Method Summary

Modifier and Type	Method and Description
static Map<String,String>	extractParameters(HttpRequest request) Convenience method for extracting the parameters from the HttpRequest.
void	tokeniseHttpRequest(HttpRequest request, HttpRequestTokenHandler handler) Tokenises the HttpRequest for the path, parameters and fragment providing them to the HttpRequestTokenHandler to handle.
void	tokeniseRequestURI(String requestURI, HttpRequestTokenHandler handler) Tokenises the request URI for the path, parameters and fragment.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRequestTokeniserImpl

public HttpRequestTokeniserImpl()

Method Detail

extractParameters

public static Map<String,String> extractParameters(HttpRequest request)
                                            throws IOException,
                                                   HttpRequestTokeniseException

Convenience method for extracting the parameters from the HttpRequest.

Only the first value for the parameter will be returned.

Parameters:

request - HttpRequest.

Returns:

Parameter name values.

Throws:

IOException - If fails to read data from HttpRequest.

HttpRequestTokeniseException - If fails to extract the parameters.

tokeniseHttpRequest

public void tokeniseHttpRequest(HttpRequest request,
                                HttpRequestTokenHandler handler)
                         throws IOException,
                                HttpRequestTokeniseException

Description copied from interface: HttpRequestTokeniser

Tokenises the HttpRequest for the path, parameters and fragment providing them to the HttpRequestTokenHandler to handle.

This encompasses the whole HttpRequest (e.g. on POST will also tokenise the body for parameters).

Specified by:

tokeniseHttpRequest in interface HttpRequestTokeniser

Parameters:

request - HttpRequest to be tokenised.

handler - HttpRequestTokenHandler to handle the HttpRequest tokens.

Throws:

IOException - If fails to read data from HttpRequest.

HttpRequestTokeniseException - If fails to tokenise the HttpRequest.

tokeniseRequestURI

public void tokeniseRequestURI(String requestURI,
                               HttpRequestTokenHandler handler)
                        throws HttpRequestTokeniseException

Description copied from interface: HttpRequestTokeniser

Tokenises the request URI for the path, parameters and fragment.

Specified by:

tokeniseRequestURI in interface HttpRequestTokeniser

Parameters:

requestURI - Request URI to be tokenised.

handler - HttpRequestTokenHandler to handle the request URI tokens.

Throws:

HttpRequestTokeniseException - If fails to tokenise the request URI.