org.jolokia.http

Class HttpRequestHandler

java.lang.Object

org.jolokia.http.HttpRequestHandler

public class HttpRequestHandler
extends Object

Request handler with no dependency on the servlet API so that it can be used in several different environments (like for the Sun JDK 6 com.sun.net.httpserver.HttpServer.

Since:

Mar 3, 2010

Author:

roland

Constructor Summary

Constructors

Constructor and Description
HttpRequestHandler(Configuration pConfig, BackendManager pBackendManager, LogHandler pLogHandler) Request handler for parsing HTTP request and dispatching to the appropriate request handler (with help of the backend manager)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkAccess(String pHost, String pAddress, String pOrigin) Check whether the given host and/or address is allowed to access this agent.
String	extractCorsOrigin(String pOrigin) Check whether for the given host is a cross-browser request allowed.
org.json.simple.JSONObject	getErrorJSON(int pErrorCode, Throwable pExp, JmxRequest pJmxReq) Get the JSON representation for a an exception
Map<String,String>	handleCorsPreflightRequest(String pOrigin, String pRequestHeaders) Handling an option request which is used for preflight checks before a CORS based browser request is sent (for certain circumstances).
org.json.simple.JSONAware	handleGetRequest(String pUri, String pPathInfo, Map<String,String[]> pParameterMap) Handle a GET request
org.json.simple.JSONAware	handlePostRequest(String pUri, InputStream pInputStream, String pEncoding, Map<String,String[]> pParameterMap) Handle the input stream as given by a POST request
org.json.simple.JSONObject	handleThrowable(Throwable pThrowable) Utility method for handling single runtime exceptions and errors.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRequestHandler

public HttpRequestHandler(Configuration pConfig,
                  BackendManager pBackendManager,
                  LogHandler pLogHandler)

Request handler for parsing HTTP request and dispatching to the appropriate request handler (with help of the backend manager)

Parameters:

pBackendManager - backend manager to user

pLogHandler - log handler to where to put out logging

Method Detail

handleGetRequest

public org.json.simple.JSONAware handleGetRequest(String pUri,
                                         String pPathInfo,
                                         Map<String,String[]> pParameterMap)

Handle a GET request

Parameters:

pUri - URI leading to this request

pPathInfo - path of the request

pParameterMap - parameters of the GET request @return the response

handlePostRequest

public org.json.simple.JSONAware handlePostRequest(String pUri,
                                          InputStream pInputStream,
                                          String pEncoding,
                                          Map<String,String[]> pParameterMap)
                                            throws IOException

Handle the input stream as given by a POST request

Parameters:

pUri - URI leading to this request

pInputStream - input stream of the post request

pEncoding - optional encoding for the stream. If null, the default encoding is used

pParameterMap - additional processing parameters

Returns:

the JSON object containing the json results for one or more JmxRequest contained within the answer.

Throws:

IOException - if reading from the input stream fails

handleCorsPreflightRequest

public Map<String,String> handleCorsPreflightRequest(String pOrigin,
                                            String pRequestHeaders)

Handling an option request which is used for preflight checks before a CORS based browser request is sent (for certain circumstances). See the CORS specification (section 'preflight checks') for more details.

Parameters:

pOrigin - the origin to check. If null, no headers are returned

pRequestHeaders - extra headers to check against

Returns:

headers to set

handleThrowable

public org.json.simple.JSONObject handleThrowable(Throwable pThrowable)

Utility method for handling single runtime exceptions and errors. This method is called in addition to and after executeRequest(JmxRequest) to catch additional errors. They are two different methods because of bulk requests, where each individual request can lead to an error. So, each individual request is wrapped with the error handling of executeRequest(JmxRequest) whereas the overall handling is wrapped with this method. It is hence more coarse grained, leading typically to an status code of 500. Summary: This method should be used as last security belt is some exception should escape from a single request processing in executeRequest(JmxRequest).

Parameters:

pThrowable - exception to handle

Returns:

its JSON representation

getErrorJSON

public org.json.simple.JSONObject getErrorJSON(int pErrorCode,
                                      Throwable pExp,
                                      JmxRequest pJmxReq)

Get the JSON representation for a an exception

Parameters:

pErrorCode - the HTTP error code to return

pExp - the exception or error occured

pJmxReq - request from where to get processing options

Returns:

the json representation

checkAccess

public void checkAccess(String pHost,
               String pAddress,
               String pOrigin)

Check whether the given host and/or address is allowed to access this agent.

Parameters:

pHost - host to check

pAddress - address to check

pOrigin - (optional) origin header to check also.

extractCorsOrigin

public String extractCorsOrigin(String pOrigin)

Check whether for the given host is a cross-browser request allowed. This check is delegated to the backendmanager which is responsible for the security configuration. Also, some sanity checks are applied.

Parameters:

pOrigin - the origin URL to check against

Returns:

the origin to put in the response header or null if none is to be set