io.undertow.server

Class AbstractServerConnection

java.lang.Object

io.undertow.util.AbstractAttachable

io.undertow.server.AbstractServerConnection

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

Direct Known Subclasses:

AjpServerConnection, HttpServerConnection

public abstract class AbstractServerConnection
extends AbstractAttachable
implements ServerConnection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractServerConnection.ConduitState

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

ServerConnection.CloseListener

Field Summary

Fields

Modifier and Type	Field and Description
protected org.xnio.Pool<ByteBuffer>	bufferPool
protected org.xnio.StreamConnection	channel
protected List<ServerConnection.CloseListener>	closeListeners
protected io.undertow.server.AbstractServerConnection.CloseSetter	closeSetter
protected org.xnio.Pooled<ByteBuffer>	extraBytes Any extra bytes that were read from the channel.
protected org.xnio.conduits.StreamSinkConduit	originalSinkConduit
protected org.xnio.conduits.StreamSourceConduit	originalSourceConduit
protected HttpHandler	rootHandler
protected org.xnio.OptionMap	undertowOptions

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Constructor Summary

Constructors

Constructor and Description
AbstractServerConnection(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
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() Get the buffer pool for this connection.
int	getBufferSize()
org.xnio.StreamConnection	getChannel() Get the underlying channel.
org.xnio.ChannelListener.Setter<ServerConnection>	getCloseSetter()
org.xnio.Pooled<ByteBuffer>	getExtraBytes()
org.xnio.XnioIoThread	getIoThread()
SocketAddress	getLocalAddress()
<A extends SocketAddress> A	getLocalAddress(Class<A> type)
<T> T	getOption(org.xnio.Option<T> option)
org.xnio.conduits.StreamSinkConduit	getOriginalSinkConduit()
org.xnio.conduits.StreamSourceConduit	getOriginalSourceConduit()
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.
HttpHandler	getRootHandler() Get the root HTTP handler for this connection.
org.xnio.conduits.ConduitStreamSinkChannel	getSinkChannel()
org.xnio.conduits.ConduitStreamSourceChannel	getSourceChannel()
org.xnio.OptionMap	getUndertowOptions()
org.xnio.XnioWorker	getWorker()
boolean	isOpen()
AbstractServerConnection.ConduitState	resetChannel() Resets the channel to its original state, effectively disabling all current conduit wrappers.
void	restoreChannel(AbstractServerConnection.ConduitState state) Resores the channel conduits to a previous state.
void	setExtraBytes(org.xnio.Pooled<ByteBuffer> extraBytes)
<T> T	setOption(org.xnio.Option<T> option, T value)
protected static org.xnio.conduits.StreamSinkConduit	sink(AbstractServerConnection.ConduitState state)
protected static org.xnio.conduits.StreamSourceConduit	source(AbstractServerConnection.ConduitState state)
boolean	supportsOption(org.xnio.Option<?> option)

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

getSslSessionInfo, sendOutOfBandResponse, setSslSessionInfo, upgradeChannel

Methods inherited from interface io.undertow.util.Attachable

addToAttachmentList, getAttachment, getAttachmentList, putAttachment, removeAttachment

Field Detail

channel

protected final org.xnio.StreamConnection channel

closeSetter

protected final io.undertow.server.AbstractServerConnection.CloseSetter closeSetter

bufferPool

protected final org.xnio.Pool<ByteBuffer> bufferPool

rootHandler

protected final HttpHandler rootHandler

undertowOptions

protected final org.xnio.OptionMap undertowOptions

originalSourceConduit

protected final org.xnio.conduits.StreamSourceConduit originalSourceConduit

originalSinkConduit

protected final org.xnio.conduits.StreamSinkConduit originalSinkConduit

closeListeners

protected final List<ServerConnection.CloseListener> closeListeners

extraBytes

protected org.xnio.Pooled<ByteBuffer> extraBytes

Any extra bytes that were read from the channel. This could be data for this requests, or the next response.

Constructor Detail

AbstractServerConnection

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

Method Detail

getRootHandler

public HttpHandler getRootHandler()

Get the root HTTP handler for this connection.

Returns:

the root HTTP handler for this connection

getBufferPool

public org.xnio.Pool<ByteBuffer> getBufferPool()

Get the buffer pool for this connection.

Specified by:

getBufferPool in interface ServerConnection

Returns:

the buffer pool for this connection

getChannel

public org.xnio.StreamConnection getChannel()

Get the underlying channel.

Returns:

the underlying channel

getCloseSetter

public org.xnio.ChannelListener.Setter<ServerConnection> getCloseSetter()

Specified by:

getCloseSetter in interface org.xnio.channels.BoundChannel

Specified by:

getCloseSetter in interface org.xnio.channels.CloseableChannel

Specified by:

getCloseSetter in interface org.xnio.channels.ConnectedChannel

getWorker

public org.xnio.XnioWorker getWorker()

Specified by:

getWorker in interface ServerConnection

Specified by:

getWorker in interface org.xnio.channels.CloseableChannel

Returns:

The connections worker

getIoThread

public org.xnio.XnioIoThread getIoThread()

Specified by:

getIoThread in interface ServerConnection

Specified by:

getIoThread in interface org.xnio.channels.CloseableChannel

Returns:

The IO thread associated with the connection

isOpen

public boolean isOpen()

Specified by:

isOpen in interface ServerConnection

Specified by:

isOpen in interface Channel

Returns:

true if the connection is open

supportsOption

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

Specified by:

supportsOption in interface ServerConnection

Specified by:

supportsOption in interface org.xnio.channels.Configurable

getOption

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

Specified by:

getOption in interface ServerConnection

Specified by:

getOption in interface org.xnio.channels.Configurable

Throws:

IOException

setOption

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

Specified by:

setOption in interface ServerConnection

Specified by:

setOption in interface org.xnio.channels.Configurable

Throws:

IllegalArgumentException

IOException

close

public void close()
           throws IOException

Specified by:

close in interface ServerConnection

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface InterruptibleChannel

Specified by:

close in interface org.xnio.channels.CloseableChannel

Throws:

IOException

getPeerAddress

public SocketAddress getPeerAddress()

Description copied from interface: ServerConnection

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

Specified by:

getPeerAddress in interface ServerConnection

Specified by:

getPeerAddress in interface org.xnio.channels.ConnectedChannel

Returns:

The address of the remote peer

getPeerAddress

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

Description copied from interface: ServerConnection

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

Specified by:

getPeerAddress in interface ServerConnection

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

public SocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface ServerConnection

Specified by:

getLocalAddress in interface org.xnio.channels.BoundChannel

getLocalAddress

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

Specified by:

getLocalAddress in interface ServerConnection

Specified by:

getLocalAddress in interface org.xnio.channels.BoundChannel

getUndertowOptions

public org.xnio.OptionMap getUndertowOptions()

Specified by:

getUndertowOptions in interface ServerConnection

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ServerConnection

Returns:

The size of the buffers allocated by the buffer pool

getExtraBytes

public org.xnio.Pooled<ByteBuffer> getExtraBytes()

setExtraBytes

public void setExtraBytes(org.xnio.Pooled<ByteBuffer> extraBytes)

getOriginalSourceConduit

public org.xnio.conduits.StreamSourceConduit getOriginalSourceConduit()

Returns:

The original source conduit

getOriginalSinkConduit

public org.xnio.conduits.StreamSinkConduit getOriginalSinkConduit()

Returns:

The original underlying sink conduit

resetChannel

public AbstractServerConnection.ConduitState resetChannel()

Resets the channel to its original state, effectively disabling all current conduit wrappers. The current state is encapsulated inside a AbstractServerConnection.ConduitState object that can be used the restore the channel.

Returns:

An opaque representation of the previous channel state

restoreChannel

public void restoreChannel(AbstractServerConnection.ConduitState state)

Resores the channel conduits to a previous state.

Parameters:

state - The original state

See Also:

resetChannel()

sink

protected static org.xnio.conduits.StreamSinkConduit sink(AbstractServerConnection.ConduitState state)

source

protected static org.xnio.conduits.StreamSourceConduit source(AbstractServerConnection.ConduitState state)

addCloseListener

public void addCloseListener(ServerConnection.CloseListener listener)

Description copied from interface: ServerConnection

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

Specified by:

addCloseListener in interface ServerConnection

Parameters:

listener - The close listener

getSinkChannel

public org.xnio.conduits.ConduitStreamSinkChannel getSinkChannel()

Specified by:

getSinkChannel in interface ServerConnection

getSourceChannel

public org.xnio.conduits.ConduitStreamSourceChannel getSourceChannel()

Specified by:

getSourceChannel in interface ServerConnection