Package com.amalgamasimulation.studies.headlessapp.http

Class LocalHttpHandler

java.lang.Object

com.amalgamasimulation.studies.headlessapp.http.LocalHttpHandler

All Implemented Interfaces:

HttpHandler

public abstract class LocalHttpHandler
extends Object
implements HttpHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected final HeadlessHTTPServer	server

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LocalHttpHandler(HeadlessHTTPServer server)

Method Summary

Modifier and Type	Method	Description
protected boolean	beforeHandle(HttpExchange t)	Performs a set of checks that should be run before handling a HTTP request.
protected abstract HttpMethod	expectedMethod()	Returns the HTTP method that must be used in requests processed by this HTTP handler.
protected static String	getCorrIDLogMessagePrefix(HttpExchange exchange)
final void	handle(HttpExchange exchange)
protected void	logRequest(HttpExchange t)
protected abstract HttpResponse	prepareResponse(HttpExchange exchange)	This method should process the request and then prepare and return (but not send!) the response.
protected static void	writeResponse(HttpExchange t, int httpResultCode, String response)
protected static void	writeResponseJSON(HttpExchange t, int httpResultCode, String responseJSON)
protected static void	writeResponseJSON(HttpExchange exchange, HttpResponse response)
protected static void	writeResponseMessage(HttpExchange t, int httpResultCode, String response)	Writes a HTTP response as a single-field JSON object.

Methods inherited from class java.lang.Object

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

Field Details

server

protected final HeadlessHTTPServer server

Constructor Details

LocalHttpHandler

protected LocalHttpHandler(HeadlessHTTPServer server)

Method Details

expectedMethod

protected abstract HttpMethod expectedMethod()

Returns the HTTP method that must be used in requests processed by this HTTP handler.

prepareResponse

protected abstract HttpResponse prepareResponse(HttpExchange exchange)

This method should process the request and then prepare and return (but not send!) the response.

handle

public final void handle(HttpExchange exchange)
                  throws IOException

Specified by:

handle in interface HttpHandler

Throws:

IOException

getCorrIDLogMessagePrefix

protected static String getCorrIDLogMessagePrefix(HttpExchange exchange)

logRequest

protected void logRequest(HttpExchange t)

beforeHandle

protected boolean beforeHandle(HttpExchange t)
                        throws IOException

Performs a set of checks that should be run before handling a HTTP request. Returns true if checks were successful.

This method must be called in the beginning of the 'handle()' method in each subclass. If this method returns false, the rest of the 'handle()' method should not be run.

Throws:

IOException

writeResponseMessage

protected static void writeResponseMessage(HttpExchange t,
 int httpResultCode,
 String response)
                                    throws IOException

Writes a HTTP response as a single-field JSON object. The field's name is "message" and its value is the 'response' method parameter.

Throws:

IOException

writeResponseJSON

protected static void writeResponseJSON(HttpExchange t,
 int httpResultCode,
 String responseJSON)
                                 throws IOException

Throws:

IOException

writeResponse

protected static void writeResponse(HttpExchange t,
 int httpResultCode,
 String response)
                             throws IOException

Throws:

IOException

writeResponseJSON

protected static void writeResponseJSON(HttpExchange exchange,
 HttpResponse response)
                                 throws IOException

Throws:

IOException