net.officefloor.plugin.web.http.tokenise

Interface HttpRequestTokeniser

All Known Implementing Classes:

HttpRequestTokeniserImpl

public interface HttpRequestTokeniser

Tokenises the HttpRequest for the path, parameters, fragment.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

tokeniseHttpRequest

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

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).

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

void tokeniseRequestURI(String requestURI,
                        HttpRequestTokenHandler handler)
                 throws HttpRequestTokeniseException

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

Parameters:

requestURI - Request URI to be tokenised.

handler - HttpRequestTokenHandler to handle the request URI tokens.

Throws:

HttpRequestTokeniseException - If fails to tokenise the request URI.