io.undertow.server

Interface ServerConnection

All Superinterfaces:

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

All Known Implementing Classes:

AbstractServerConnection, AjpServerConnection, HttpServerConnection

public interface ServerConnection
extends Attachable, org.xnio.channels.ConnectedChannel

A server connection.

Author:

Stuart Douglas

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ServerConnection.CloseListener

Field Summary

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Method Summary

Methods

Modifier and Type	Method and Description
void	addCloseListener(ServerConnection.CloseListener listener) Adds a close listener, than will be invoked with the connection is closed
void	close()
org.xnio.Pool<ByteBuffer>	getBufferPool()
int	getBufferSize()
org.xnio.XnioIoThread	getIoThread()
SocketAddress	getLocalAddress()
<A extends SocketAddress> A	getLocalAddress(Class<A> type)
<T> T	getOption(org.xnio.Option<T> option)
SocketAddress	getPeerAddress() Returns the actual address of the remote connection.
<A extends SocketAddress> A	getPeerAddress(Class<A> type) Returns the actual address of the remote connection.
org.xnio.conduits.ConduitStreamSinkChannel	getSinkChannel()
org.xnio.conduits.ConduitStreamSourceChannel	getSourceChannel()
SSLSessionInfo	getSslSessionInfo() Gets SSL information about the connection.
org.xnio.OptionMap	getUndertowOptions()
org.xnio.XnioWorker	getWorker()
boolean	isOpen()
HttpServerExchange	sendOutOfBandResponse(HttpServerExchange exchange) Sends an out of band response, such as a HTTP 100-continue response.
<T> T	setOption(org.xnio.Option<T> option, T value)
void	setSslSessionInfo(SSLSessionInfo sessionInfo) Sets the current SSL information.
boolean	supportsOption(org.xnio.Option<?> option)
org.xnio.StreamConnection	upgradeChannel() Upgrade the connection, if allowed

Methods inherited from interface io.undertow.util.Attachable

addToAttachmentList, getAttachment, getAttachmentList, putAttachment, removeAttachment

Methods inherited from interface org.xnio.channels.ConnectedChannel

getCloseSetter

Method Detail

getBufferPool

org.xnio.Pool<ByteBuffer> getBufferPool()

Returns:

The connections buffer pool

getWorker

org.xnio.XnioWorker getWorker()

Specified by:

getWorker in interface org.xnio.channels.CloseableChannel

Returns:

The connections worker

getIoThread

org.xnio.XnioIoThread getIoThread()

Specified by:

getIoThread in interface org.xnio.channels.CloseableChannel

Returns:

The IO thread associated with the connection

sendOutOfBandResponse

HttpServerExchange sendOutOfBandResponse(HttpServerExchange exchange)

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.

Parameters:

exchange - The current exchange

Returns:

The out of band exchange.

isOpen

boolean isOpen()

Specified by:

isOpen in interface Channel

Returns:

true if the connection is open

supportsOption

boolean supportsOption(org.xnio.Option<?> option)

Specified by:

supportsOption in interface org.xnio.channels.Configurable

getOption

<T> T getOption(org.xnio.Option<T> option)
            throws IOException

Specified by:

getOption in interface org.xnio.channels.Configurable

Throws:

IOException

setOption

<T> T setOption(org.xnio.Option<T> option,
              T value)
            throws IllegalArgumentException,
                   IOException

Specified by:

setOption in interface org.xnio.channels.Configurable

Throws:

IllegalArgumentException

IOException

close

void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Specified by:

close in interface org.xnio.channels.CloseableChannel

Specified by:

close in interface InterruptibleChannel

Throws:

IOException

getPeerAddress

SocketAddress getPeerAddress()

Returns the actual address of the remote connection. This will not take things like X-Forwarded-for into account.

Specified by:

getPeerAddress in interface org.xnio.channels.ConnectedChannel

Returns:

The address of the remote peer

getPeerAddress

<A extends SocketAddress> A getPeerAddress(Class<A> type)

Returns the actual address of the remote connection. This will not take things like X-Forwarded-for into account.

Specified by:

getPeerAddress in interface org.xnio.channels.ConnectedChannel

Type Parameters:

A - The address type

Parameters:

type - The type of address to return

Returns:

The remote endpoint address

getLocalAddress

SocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface org.xnio.channels.BoundChannel

getLocalAddress

<A extends SocketAddress> A getLocalAddress(Class<A> type)

Specified by:

getLocalAddress in interface org.xnio.channels.BoundChannel

getUndertowOptions

org.xnio.OptionMap getUndertowOptions()

getBufferSize

int getBufferSize()

getSslSessionInfo

SSLSessionInfo getSslSessionInfo()

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.

Returns:

SSL information about the connection

setSslSessionInfo

void setSslSessionInfo(SSLSessionInfo sessionInfo)

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.

Parameters:

sessionInfo - The ssl session information

addCloseListener

void addCloseListener(ServerConnection.CloseListener listener)

Adds a close listener, than will be invoked with the connection is closed

Parameters:

listener - The close listener

upgradeChannel

org.xnio.StreamConnection upgradeChannel()

Upgrade the connection, if allowed

Returns:

The StreamConnection that should be passed to the upgrade handler

getSinkChannel

org.xnio.conduits.ConduitStreamSinkChannel getSinkChannel()

getSourceChannel

org.xnio.conduits.ConduitStreamSourceChannel getSourceChannel()