nextapp.echoservlet
Class Connection

java.lang.Object
  nextapp.echoservlet.Connection

Direct Known Subclasses:

MockConnection, ThreadSafeConnection

public class Connection
extends java.lang.Object

A wrapper that holds information about an HTTP request, provides facilities to generate a response, and provides access to the application instance that is to process it.

Field Summary

static java.lang.String	INSTANCE_PEER_SESSION_KEY_PREFIX The prefix that will be used to determine the key name under which the application will be stored in HttpSession.
static java.util.Date	serverStartUpDate

Constructor Summary

Connection()

Connection(EchoServer server, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Creates a connection object that will handle the given request and response.

Method Summary

java.lang.String	correctUri(java.lang.String uri) Corrects relative-path URIs to include the application name, such that they can properly retrieve the desired resource.
java.lang.String	getApplicationUri() Returns the URI of the application.
java.lang.String	getCacheIdPrefix() Returns a prefix to prepend to cache ids in order to ensure that incorrect cached resources are used by client in the event either the server or the users session has restarted.
Id	getIdParameter(java.lang.String name) Returns the specified request parameter as an Id value.
InstancePeer	getInstancePeer() Returns the InstancePeer associated with this connection.
java.io.OutputStream	getOutputStream() Returns the OutputStream object that may be used to generate a response.
java.lang.String	getParameter(java.lang.String name) Returns the value of the HTTP parameter associated with the given name.
java.util.Enumeration	getParameterNames() Returns an enumeration of all parameter names passed in the request.
javax.servlet.http.HttpServletRequest	getRequest() Returns the HttpServletRequest wrapped by this Connection.
javax.servlet.http.HttpServletResponse	getResponse() Returns the HttpServletResponse wrapped by this Connection.
EchoServer	getServer() Returns the EchoServer wrapped by this Connection.
VariableData	getVariableData() Returns the VariableData associated with this Connection.
java.io.PrintWriter	getWriter() Returns the PrintWriter object that may be used to generate a response.
Service	retrieveService(Id id) Returns the service that corresponds to the specified Id.
void	setContentType(ContentType contentType) Sets the content type of the response.
void	setReponse(javax.servlet.http.HttpServletResponse response)

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE_PEER_SESSION_KEY_PREFIX

public static final java.lang.String INSTANCE_PEER_SESSION_KEY_PREFIX

The prefix that will be used to determine the key name under which the application will be stored in HttpSession. The application's URI will be appended to the session prefix to form a unique value.

See Also:

Constant Field Values

serverStartUpDate

public static java.util.Date serverStartUpDate

Constructor Detail

Connection

public Connection()

Connection

public Connection(EchoServer server,
                  javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws java.io.IOException,
                  javax.servlet.ServletException

Creates a connection object that will handle the given request and response. The InstancePeer will be pulled from the session if one exists. A session will NOT be created if one does not exist.

Parameters:

server - The EchoServer generating the connection.

request - The HTTP request object that was passed to the servlet.

response - The HTTP response object that was passed to the servlet.

Throws:

java.io.IOException

javax.servlet.ServletException

Method Detail

getApplicationUri

public java.lang.String getApplicationUri()

Returns the URI of the application.

Returns:

The URI of the application.

getCacheIdPrefix

public java.lang.String getCacheIdPrefix()

Returns a prefix to prepend to cache ids in order to ensure that incorrect cached resources are used by client in the event either the server or the users session has restarted. Returns an empty string if no InstancePeer has been created, otherwise defers responsibility to the InstancePeer.

Returns:

A prefix to prepend to cache ids to make them unique across server and session restarts.

getIdParameter

public Id getIdParameter(java.lang.String name)

Returns the specified request parameter as an Id value. If the parameter is was not provided in the request, or if the parameter is not a valid Id value, null is returned.

Parameters:

name - The parameter name.

Returns:

The parameter as an Id.

getInstancePeer

public InstancePeer getInstancePeer()

Returns the InstancePeer associated with this connection. If the session has not been initialized, null is returned.

Returns:

The InstancePeer associated with this connection.

getOutputStream

public java.io.OutputStream getOutputStream()

Returns the OutputStream object that may be used to generate a response. This method may be called once. If it is called, the getWriter() method may not be called. This method wraps a call to HttpServletResponse.getOutputStream(). The OutputStream will be closed by the servlet container.

Returns:

the OutputStream object that may be used to generate a response to the client.

getParameter

public java.lang.String getParameter(java.lang.String name)

Returns the value of the HTTP parameter associated with the given name.

Parameters:

name - The name of the parameter to return.

Returns:

The value of the HTTP parameter associated with the given name.

getParameterNames

public java.util.Enumeration getParameterNames()

Returns an enumeration of all parameter names passed in the request.

Returns:

An enumeration of all parameter names passed in the request.

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Returns the HttpServletRequest wrapped by this Connection.

Returns:

The HttpServletRequest wrapped by this Connection.

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

Returns the HttpServletResponse wrapped by this Connection.

Returns:

The HttpServletResponse wrapped by this Connection.

getServer

public EchoServer getServer()

Returns the EchoServer wrapped by this Connection.

Returns:

The EchoServer wrapped by this Connection.

getVariableData

public VariableData getVariableData()

Returns the VariableData associated with this Connection. If an InstancePeer exists, its VariableData is returned, otherwise, a temporary VariableData object is returned that contains defaults used for initialization.

Returns:

The VariableData object associated with this Connection.

getWriter

public java.io.PrintWriter getWriter()

Returns the PrintWriter object that may be used to generate a response. This method may be called once. If it is called, the getOuputStream() method may not be called. This method wraps a call to HttpServletResponse.getWriter(). The PrintWriter will be closed by the servlet container.

Returns:

the PrintWriter object that may be used to generate a response to the client.

correctUri

public java.lang.String correctUri(java.lang.String uri)

Corrects relative-path URIs to include the application name, such that they can properly retrieve the desired resource.

Parameters:

uri - The URI to correct.

Returns:

The corrected URI.

retrieveService

public Service retrieveService(Id id)

Returns the service that corresponds to the specified Id.

Parameters:

id - The id of the service to return.

Returns:

The service corresponding to the specified Id.

setContentType

public void setContentType(ContentType contentType)

Sets the content type of the response. This method will automatically append a character encoding to non-binary content types.

Parameters:

contentType - The content type of the response.

setReponse

public void setReponse(javax.servlet.http.HttpServletResponse response)