io.undertow.server.protocol.http

Class HttpServerConnection

java.lang.Object

io.undertow.util.AbstractAttachable

io.undertow.server.AbstractServerConnection

io.undertow.server.protocol.http.HttpServerConnection

All Implemented Interfaces:

ServerConnection, Attachable, Closeable, AutoCloseable, Channel, InterruptibleChannel, org.xnio.channels.BoundChannel, org.xnio.channels.CloseableChannel, org.xnio.channels.Configurable, org.xnio.channels.ConnectedChannel

public final class HttpServerConnection
extends AbstractServerConnection
implements ServerConnection

A server-side HTTP connection.

Note that the lifecycle of the server connection is tied to the underlying TCP connection. Even if the channel is upgraded the connection is not considered closed until the upgraded channel is closed.

Author:

David M. Lloyd

Nested Class Summary

Nested classes/interfaces inherited from class io.undertow.server.AbstractServerConnection

AbstractServerConnection.ConduitState

Nested classes/interfaces inherited from interface io.undertow.server.ServerConnection

ServerConnection.CloseListener

Field Summary

Fields inherited from class io.undertow.server.AbstractServerConnection

bufferPool, channel, closeListeners, closeSetter, extraBytes, originalSinkConduit, originalSourceConduit, rootHandler, undertowOptions

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Constructor Summary

Constructors

Constructor and Description
HttpServerConnection(org.xnio.StreamConnection channel, org.xnio.Pool<ByteBuffer> bufferPool, HttpHandler rootHandler, org.xnio.OptionMap undertowOptions, int bufferSize)

Method Summary

Methods

Modifier and Type	Method and Description
SSLSession	getSslSession()
SSLSessionInfo	getSslSessionInfo() Gets SSL information about the connection.
HttpServerExchange	sendOutOfBandResponse(HttpServerExchange exchange) Sends an out of band response, such as a HTTP 100-continue response.
void	setSslSessionInfo(SSLSessionInfo sessionInfo) Sets the current SSL information.
void	ungetRequestBytes(org.xnio.Pooled<ByteBuffer> unget) Pushes back the given data.
org.xnio.StreamConnection	upgradeChannel() Upgrade the connection, if allowed

Methods inherited from class io.undertow.server.AbstractServerConnection

addCloseListener, close, getBufferPool, getBufferSize, getChannel, getCloseSetter, getExtraBytes, getIoThread, getLocalAddress, getLocalAddress, getOption, getOriginalSinkConduit, getOriginalSourceConduit, getPeerAddress, getPeerAddress, getRootHandler, getSinkChannel, getSourceChannel, getUndertowOptions, getWorker, isOpen, resetChannel, restoreChannel, setExtraBytes, setOption, sink, source, supportsOption

Methods inherited from class io.undertow.util.AbstractAttachable

addToAttachmentList, getAttachment, getAttachmentList, putAttachment, removeAttachment

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.undertow.server.ServerConnection

addCloseListener, close, getBufferPool, getBufferSize, getIoThread, getLocalAddress, getLocalAddress, getOption, getPeerAddress, getPeerAddress, getSinkChannel, getSourceChannel, getUndertowOptions, getWorker, isOpen, setOption, supportsOption

Methods inherited from interface io.undertow.util.Attachable

addToAttachmentList, getAttachment, getAttachmentList, putAttachment, removeAttachment

Methods inherited from interface org.xnio.channels.ConnectedChannel

getCloseSetter

Constructor Detail

HttpServerConnection

public HttpServerConnection(org.xnio.StreamConnection channel,
                    org.xnio.Pool<ByteBuffer> bufferPool,
                    HttpHandler rootHandler,
                    org.xnio.OptionMap undertowOptions,
                    int bufferSize)

Method Detail

sendOutOfBandResponse

public HttpServerExchange sendOutOfBandResponse(HttpServerExchange exchange)

Description copied from interface: ServerConnection

Sends an out of band response, such as a HTTP 100-continue response. WARNING: do not attempt to write to the current exchange until the out of band exchange has been fully written. Doing so may have unexpected results. TODO: this needs more thought.

Specified by:

sendOutOfBandResponse in interface ServerConnection

Parameters:

exchange - The current exchange

Returns:

The out of band exchange.

ungetRequestBytes

public void ungetRequestBytes(org.xnio.Pooled<ByteBuffer> unget)

Pushes back the given data. This should only be used by transfer coding handlers that have read past the end of the request when handling pipelined requests

Parameters:

unget - The buffer to push back

getSslSessionInfo

public SSLSessionInfo getSslSessionInfo()

Description copied from interface: ServerConnection

Gets SSL information about the connection. This could represent the actual client connection, or could be providing SSL information that was provided by a front end proxy.

Specified by:

getSslSessionInfo in interface ServerConnection

Returns:

SSL information about the connection

setSslSessionInfo

public void setSslSessionInfo(SSLSessionInfo sessionInfo)

Description copied from interface: ServerConnection

Sets the current SSL information. This can be used by handlers to setup SSL information that was provided by a front end proxy. If this is being set of a per request basis then you must ensure that it is either cleared by an exchange completion listener at the end of the request, or is always set for every request. Otherwise it is possible to SSL information to 'leak' between requests.

Specified by:

setSslSessionInfo in interface ServerConnection

Parameters:

sessionInfo - The ssl session information

getSslSession

public SSLSession getSslSession()

upgradeChannel

public org.xnio.StreamConnection upgradeChannel()

Description copied from interface: ServerConnection

Upgrade the connection, if allowed

Specified by:

upgradeChannel in interface ServerConnection

Returns:

The StreamConnection that should be passed to the upgrade handler