ej.hoka.http

Class HTTPSession

java.lang.Object

ej.hoka.http.HTTPSession

Direct Known Subclasses:

DefaultHTTPSession

public abstract class HTTPSession
extends java.lang.Object

Abstract HTTP Session. Subclasses implements the answer(HTTPRequest) method to generate HTTPResponse to a HTTPRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HTTPSession.Factory This factory is used by the HTTPServer to create sessions for jobs.

Constructor Summary

Constructors

Constructor and Description
HTTPSession(HTTPServer server) Creates a new HTTP Session in the given HTTPServer.

Method Summary

Modifier and Type	Method and Description
protected abstract HTTPResponse	answer(HTTPRequest request) Generates HTTPResponse to a HTTPRequest.
protected boolean	checkHTTPError(HTTPResponse response) Returns true if the HTTPResponse contains a "HTTP 200 OK" response code.
protected void	closeConnection() Close the current server connection.
static HTTPResponse	createErrorResponse(java.lang.String status, java.lang.String msg) Create a HTTPResponse to write the msg for the given status.
protected IHTTPEncodingHandler	getAcceptEncodingHandler(java.lang.String encodingParam) Returns the most suitable IHTTPEncodingHandler to match the encodings described in Accept-Encoding header.
BodyParserFactory	getBodyParserFactory() Gets the bodyParserFactory.
protected java.lang.Runnable	getRunnable() Runs the HTTPServer by waiting for incoming connections and build the response.
protected void	sendError(java.lang.String status) Send a HTTP error code with given status.
protected void	sendError(java.lang.String status, java.lang.String msg) Sends a HTTP response with given status and optional message.
protected void	sendResponse(HTTPResponse response, IHTTPEncodingHandler encodingHandler) Sends the given HTTPResponse to the previously initialized Socket.
void	setBodyParserFactory(BodyParserFactory bodyParserFactory) Sets the bodyParserFactory.
protected void	setCurrentConnection(java.net.Socket c) Sets the Socket to be used.
protected void	writeResponse(HTTPResponse response, IHTTPEncodingHandler encodingHandler, java.io.OutputStream output) Send the HTTPResponse to the given OutputStream using the given IHTTPEncodingHandler.

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPSession

public HTTPSession(HTTPServer server)

Creates a new HTTP Session in the given HTTPServer.

Parameters:

server - a HTTPServer

Method Detail

createErrorResponse

public static HTTPResponse createErrorResponse(java.lang.String status,
                                               java.lang.String msg)

Create a HTTPResponse to write the msg for the given status.

Parameters:

status - the error status. One of HTTP_STATUS_* constant of the HTTPConstants interface.

msg - an optional error message to add in response.

Returns:

a HTTPResponse that represent the error.

See Also:

HTTPConstants.HTTP_STATUS_BADREQUEST, HTTPConstants.HTTP_STATUS_FORBIDDEN, HTTPConstants.HTTP_STATUS_INTERNALERROR, HTTPConstants.HTTP_STATUS_MEDIA_TYPE, HTTPConstants.HTTP_STATUS_METHOD, HTTPConstants.HTTP_STATUS_NOTACCEPTABLE, HTTPConstants.HTTP_STATUS_NOTFOUND, HTTPConstants.HTTP_STATUS_NOTIMPLEMENTED, HTTPConstants.HTTP_STATUS_NOTMODIFIED, HTTPConstants.HTTP_STATUS_OK, HTTPConstants.HTTP_STATUS_REDIRECT

answer

protected abstract HTTPResponse answer(HTTPRequest request)

Generates HTTPResponse to a HTTPRequest. Subclasses implements this method to add functionality to the HTTP Server.

Parameters:

request - the request

Returns:

a HTTPResponse

checkHTTPError

protected boolean checkHTTPError(HTTPResponse response)

Returns true if the HTTPResponse contains a "HTTP 200 OK" response code.

Parameters:

response - the HTTPResponse

Returns:

true if the HTTPResponse contains a "HTTP 200 OK" response code.

closeConnection

protected void closeConnection()

Close the current server connection.

getAcceptEncodingHandler

protected IHTTPEncodingHandler getAcceptEncodingHandler(java.lang.String encodingParam)

Returns the most suitable IHTTPEncodingHandler to match the encodings described in Accept-Encoding header.

Parameters:

encodingParam - is on the form gzip, identity or gzip; q=0.8, identity; q=0.2

Returns:

the IHTTPEncodingHandler, or null if no suitable handler can be found

getRunnable

protected java.lang.Runnable getRunnable()

Runs the HTTPServer by waiting for incoming connections and build the response.

Returns:

the Runnable interface for core HTTP Session functionality.

sendError

protected void sendError(java.lang.String status)

Send a HTTP error code with given status.

Parameters:

status - the HTTP status

See Also:

sendError(String, String)

sendError

protected void sendError(java.lang.String status,
                         java.lang.String msg)

Sends a HTTP response with given status and optional message. The information is also logged.

Parameters:

msg - the message, could be null

status - the error status

See Also:

sendResponse(HTTPResponse, IHTTPEncodingHandler)

sendResponse

protected void sendResponse(HTTPResponse response,
                            IHTTPEncodingHandler encodingHandler)

Sends the given HTTPResponse to the previously initialized Socket.

Parameters:

response - the HTTPResponse to be sent

encodingHandler - the encoding handler to be used to encode the response. If null the IdentityEncodingHandler is used to encode the response.

setCurrentConnection

protected void setCurrentConnection(java.net.Socket c)

Sets the Socket to be used.

Parameters:

c - the Socket to be used.

writeResponse

protected void writeResponse(HTTPResponse response,
                             IHTTPEncodingHandler encodingHandler,
                             java.io.OutputStream output)
                      throws java.io.IOException

Send the HTTPResponse to the given OutputStream using the given IHTTPEncodingHandler.

Parameters:

response - the HTTPResponse

encodingHandler - the IHTTPEncodingHandler to encode the response. If null, the IHTTPTransferCodingHandler is used.

output - OutputStream used to write the response to

Throws:

java.io.IOException - if the connection has been lost

getBodyParserFactory

public BodyParserFactory getBodyParserFactory()

Gets the bodyParserFactory.

Returns:

the bodyParserFactory.

setBodyParserFactory

public void setBodyParserFactory(BodyParserFactory bodyParserFactory)

Sets the bodyParserFactory.

Parameters:

bodyParserFactory - the bodyParserFactory to set.