net.officefloor.plugin.servlet.socket.server.http

Class ServletServerHttpConnection

java.lang.Object

net.officefloor.plugin.servlet.socket.server.http.ServletServerHttpConnection

All Implemented Interfaces:

ServerHttpConnection

public class ServletServerHttpConnection
extends Object
implements ServerHttpConnection

Implementation of ServerHttpConnection backed by Servlet.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
ServletServerHttpConnection(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse) Initiate.

Method Summary

Modifier and Type	Method and Description
Serializable	exportState() Exports the state of the current HttpRequest and HttpResponse.
String	getHttpMethod() Obtains the client sent HTTP method of the ServerHttpConnection.
HttpRequest	getHttpRequest() Obtains the HttpRequest for this ServerHttpConnection.
HttpResponse	getHttpResponse() Obtains the HttpResponse for this ServerHttpConnection.
InetSocketAddress	getLocalAddress() Obtains the local address for this ServerHttpConnection.
InetSocketAddress	getRemoteAddress() Obtains the remote address for this ServerHttpConnection.
void	importState(Serializable momento) Imports and overrides the current HttpRequest and HttpResponse with the input momento.
boolean	isSecure() Indicates if the connection is over a secure channel (e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletServerHttpConnection

public ServletServerHttpConnection(javax.servlet.http.HttpServletRequest servletRequest,
                                   javax.servlet.http.HttpServletResponse servletResponse)

Initiate.

Parameters:

servletRequest - HttpServletRequest.

servletResponse - HttpServletResponse.

Method Detail

isSecure

public boolean isSecure()

Description copied from interface: ServerHttpConnection

Indicates if the connection is over a secure channel (e.g. utilising SSL).

Specified by:

isSecure in interface ServerHttpConnection

Returns:

true if connection is over a secure channel.

getLocalAddress

public InetSocketAddress getLocalAddress()

Description copied from interface: ServerHttpConnection

Obtains the local address for this ServerHttpConnection.

Specified by:

getLocalAddress in interface ServerHttpConnection

Returns:

InetSocketAddress describing the local Socket for this ServerHttpConnection.

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Description copied from interface: ServerHttpConnection

Obtains the remote address for this ServerHttpConnection.

Specified by:

getRemoteAddress in interface ServerHttpConnection

Returns:

InetSocketAddress describing the remote Socket for this ServerHttpConnection.

getHttpRequest

public HttpRequest getHttpRequest()

Description copied from interface: ServerHttpConnection

Obtains the HttpRequest for this ServerHttpConnection.

Specified by:

getHttpRequest in interface ServerHttpConnection

Returns:

HttpRequest for this ServerHttpConnection.

getHttpResponse

public HttpResponse getHttpResponse()

Description copied from interface: ServerHttpConnection

Obtains the HttpResponse for this ServerHttpConnection.

Specified by:

getHttpResponse in interface ServerHttpConnection

Returns:

HttpResponse for this ServerHttpConnection.

getHttpMethod

public String getHttpMethod()

Description copied from interface: ServerHttpConnection

Obtains the client sent HTTP method of the ServerHttpConnection.

As the HttpRequest method is overridden, this method may be used by logic requiring to know the actual client HTTP method. An example of this logic is the POST/redirect/GET pattern that needs to know whether the client sent HttpRequest method is a POST or GET (regardless of imported state).

Specified by:

getHttpMethod in interface ServerHttpConnection

Returns:

Client sent HTTP method.

See Also:

ServerHttpConnection.exportState(), ServerHttpConnection.importState(Serializable)

exportState

public Serializable exportState()
                         throws IOException

Description copied from interface: ServerHttpConnection

Exports the state of the current HttpRequest and HttpResponse.

This enables maintaining the state of the HttpRequest / HttpResponse and later reinstating them (typically after a redirect).

Specified by:

exportState in interface ServerHttpConnection

Returns:

Momento containing the current HttpRequest and HttpResponse state.

Throws:

IOException - Should the state not be able to be exported.

See Also:

ServerHttpConnection.importState(Serializable)

importState

public void importState(Serializable momento)
                 throws IllegalArgumentException,
                        IOException

Description copied from interface: ServerHttpConnection

Imports and overrides the current HttpRequest and HttpResponse with the input momento.

Specified by:

importState in interface ServerHttpConnection

Parameters:

momento - Momento exported from a ServerHttpConnection.

Throws:

IllegalArgumentException - Should the momento be invalid.

IOException - Should the state not be able to be imported.

See Also:

ServerHttpConnection.exportState()