org.jivesoftware.openfire.http
Class HttpConnection

java.lang.Object
  org.jivesoftware.openfire.http.HttpConnection

public class HttpConnection
extends Object

Represents one HTTP connection with a client using the HTTP Binding service. The client will wait on getResponse() until the server forwards a message to it or the wait time on the session timesout.

Author:

Alexander Wenckus

Constructor Summary

HttpConnection(long requestId, boolean isSecure)
Constructs an HTTP Connection.

Method Summary

void	close() The connection should be closed without delivering a stanza to the requestor.
void	deliverBody(String body) Delivers content to the client.
long	getRequestId() Returns the ID which uniquely identifies this connection.
String	getResponse() A call that will cause a wait, or in the case of Jetty the thread to be freed, if there is no deliverable currently available.
HttpSession	getSession() Returns the session that this connection belongs to.
boolean	isClosed() Returns true if this connection has been closed, either a response was delivered to the client or the server closed the connection aburbtly.
boolean	isDelivered()
boolean	isSecure() Returns true if this connection is using HTTPS.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpConnection

public HttpConnection(long requestId,
                      boolean isSecure)

Constructs an HTTP Connection.

Parameters:

requestId - the ID which uniquely identifies this request.

isSecure - true if this connection is using HTTPS

Method Detail

close

public void close()

The connection should be closed without delivering a stanza to the requestor.

isClosed

public boolean isClosed()

Returns true if this connection has been closed, either a response was delivered to the client or the server closed the connection aburbtly.

Returns:

true if this connection has been closed.

isSecure

public boolean isSecure()

Returns true if this connection is using HTTPS.

Returns:

true if this connection is using HTTPS.

isDelivered

public boolean isDelivered()

deliverBody

public void deliverBody(String body)
                 throws HttpConnectionClosedException

Delivers content to the client. The content should be valid XMPP wrapped inside of a body. A null value for body indicates that the connection should be closed and the client sent an empty body.

Parameters:

body - the XMPP content to be forwarded to the client inside of a body tag.

Throws:

HttpConnectionClosedException - when this connection to the client has already recieved a deliverable to forward to the client

getResponse

public String getResponse()
                   throws org.jivesoftware.openfire.http.HttpBindTimeoutException

A call that will cause a wait, or in the case of Jetty the thread to be freed, if there is no deliverable currently available. Once the response becomes available, it is returned.

Returns:

the deliverable to send to the client

Throws:

HttpBindTimeoutException - to indicate that the maximum wait time requested by the client has been surpassed and an empty response should be returned.

getRequestId

public long getRequestId()

Returns the ID which uniquely identifies this connection.

Returns:

the ID which uniquely identifies this connection.

getSession

public HttpSession getSession()

Returns the session that this connection belongs to.

Returns:

the session that this connection belongs to.