io.undertow.server

Class AbstractServerConnection

java.lang.Object

io.undertow.util.AbstractAttachable

io.undertow.server.ServerConnection

io.undertow.server.AbstractServerConnection

All Implemented Interfaces:

Attachable, Closeable, AutoCloseable, Channel, InterruptibleChannel, BoundChannel, CloseableChannel, Configurable, ConnectedChannel

Direct Known Subclasses:

AjpServerConnection, HttpServerConnection

public abstract class AbstractServerConnection
extends ServerConnection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractServerConnection.ConduitState

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

ServerConnection.CloseListener

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteBufferPool	bufferPool
protected StreamConnection	channel
protected List<ServerConnection.CloseListener>	closeListeners
protected io.undertow.server.AbstractServerConnection.CloseSetter	closeSetter
protected HttpServerExchange	current
protected PooledByteBuffer	extraBytes Any extra bytes that were read from the channel.
protected StreamSinkConduit	originalSinkConduit
protected StreamSourceConduit	originalSourceConduit
protected HttpHandler	rootHandler
protected OptionMap	undertowOptions

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Constructor Summary

Constructors

Constructor and Description
AbstractServerConnection(StreamConnection channel, ByteBufferPool bufferPool, HttpHandler rootHandler, OptionMap undertowOptions, int bufferSize)

Method Summary

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	clearChannel() Resets the channel to its original state, effectively disabling all current conduit wrappers.
void	close() Close this channel.
Pool<ByteBuffer>	getBufferPool()
int	getBufferSize()
ByteBufferPool	getByteBufferPool() Get the buffer pool for this connection.
StreamConnection	getChannel() Get the underlying channel.
ChannelListener.Setter<ServerConnection>	getCloseSetter() Get the setter which can be used to change the close listener for this channel.
PooledByteBuffer	getExtraBytes()
XnioIoThread	getIoThread() Get the I/O thread associated with this channel.
SocketAddress	getLocalAddress() Get the local address that this channel is bound to.
<A extends SocketAddress> A	getLocalAddress(Class<A> type) Get the local address of a given type, or null if the address is not of that type.
<T> T	getOption(Option<T> option) Get the value of a channel option.
StreamSinkConduit	getOriginalSinkConduit()
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.
protected ConduitStreamSinkChannel	getSinkChannel()
protected ConduitStreamSourceChannel	getSourceChannel()
OptionMap	getUndertowOptions()
XnioWorker	getWorker() Get the worker for this channel.
boolean	isOpen()
protected void	maxEntitySizeUpdated(HttpServerExchange exchange) Callback that is invoked if the max entity size is updated.
AbstractServerConnection.ConduitState	resetChannel() Resets the channel to its original state, effectively disabling all current conduit wrappers.
void	restoreChannel(AbstractServerConnection.ConduitState state) Restores the channel conduits to a previous state.
void	setExtraBytes(PooledByteBuffer extraBytes)
<T> T	setOption(Option<T> option, T value) Set an option for this channel.
protected void	setUpgradeListener(HttpUpgradeListener upgradeListener)
protected static StreamSinkConduit	sink(AbstractServerConnection.ConduitState state)
protected static StreamSourceConduit	source(AbstractServerConnection.ConduitState state)
boolean	supportsOption(Option<?> option) Determine whether an option is supported on this channel.

Methods inherited from class io.undertow.server.ServerConnection

exchangeComplete, getSinkConduit, getSslSessionInfo, getTransportProtocol, isConnectSupported, isContinueResponseSupported, isPushSupported, isUpgradeSupported, pushResource, pushResource, sendOutOfBandResponse, setConnectListener, setSslSessionInfo, terminateRequestChannel, upgradeChannel

Methods inherited from class io.undertow.util.AbstractAttachable

addToAttachmentList, createAttachmentMap, getAttachment, getAttachmentList, putAttachment, removeAttachment

Methods inherited from class java.lang.Object

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

Field Detail

channel

protected final StreamConnection channel

closeSetter

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

bufferPool

protected final ByteBufferPool bufferPool

rootHandler

protected final HttpHandler rootHandler

undertowOptions

protected final OptionMap undertowOptions

originalSourceConduit

protected final StreamSourceConduit originalSourceConduit

originalSinkConduit

protected final StreamSinkConduit originalSinkConduit

closeListeners

protected final List<ServerConnection.CloseListener> closeListeners

current

protected HttpServerExchange current

extraBytes

protected PooledByteBuffer 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(StreamConnection channel,
                                ByteBufferPool bufferPool,
                                HttpHandler rootHandler,
                                OptionMap undertowOptions,
                                int bufferSize)

Method Detail

getBufferPool

public Pool<ByteBuffer> getBufferPool()

Specified by:

getBufferPool in class ServerConnection

Returns:

The connections buffer pool

getRootHandler

public HttpHandler getRootHandler()

Get the root HTTP handler for this connection.

Returns:

the root HTTP handler for this connection

getByteBufferPool

public ByteBufferPool getByteBufferPool()

Get the buffer pool for this connection.

Specified by:

getByteBufferPool in class ServerConnection

Returns:

the buffer pool for this connection

getChannel

public StreamConnection getChannel()

Get the underlying channel.

Returns:

the underlying channel

getCloseSetter

public ChannelListener.Setter<ServerConnection> getCloseSetter()

Description copied from interface: ConnectedChannel

Get the setter which can be used to change the close listener for this channel. If the channel is already closed, then the listener will not be called.

Returns:

the setter

getWorker

public XnioWorker getWorker()

Description copied from interface: CloseableChannel

Get the worker for this channel.

Specified by:

getWorker in interface CloseableChannel

Specified by:

getWorker in class ServerConnection

Returns:

The connections worker

getIoThread

public XnioIoThread getIoThread()

Description copied from interface: CloseableChannel

Get the I/O thread associated with this channel.

Specified by:

getIoThread in interface CloseableChannel

Specified by:

getIoThread in class ServerConnection

Returns:

The IO thread associated with the connection

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

Specified by:

isOpen in class ServerConnection

Returns:

true if the connection is open

supportsOption

public boolean supportsOption(Option<?> option)

Description copied from interface: Configurable

Determine whether an option is supported on this channel.

Specified by:

supportsOption in interface Configurable

Specified by:

supportsOption in class ServerConnection

Parameters:

option - the option

Returns:

true if it is supported

getOption

public <T> T getOption(Option<T> option)
                throws IOException

Description copied from interface: Configurable

Get the value of a channel option.

Specified by:

getOption in interface Configurable

Specified by:

getOption in class ServerConnection

Type Parameters:

T - the type of the option value

Parameters:

option - the option to get

Returns:

the value of the option, or null if it is not set

Throws:

IOException - if an I/O error occurred when reading the option

setOption

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

Description copied from interface: Configurable

Set an option for this channel. Unsupported options are ignored.

Specified by:

setOption in interface Configurable

Specified by:

setOption in class ServerConnection

Type Parameters:

T - the type of the option value

Parameters:

option - the option to set

value - the value of the option to set

Returns:

the previous option value, if any

Throws:

IllegalArgumentException - if the value is not acceptable for this option

IOException - if an I/O error occurred when modifying the option

close

public void close()
           throws IOException

Description copied from interface: CloseableChannel

Close this channel. When a channel is closed, its close listener is invoked. Invoking this method more than once has no additional effect.

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 CloseableChannel

Specified by:

close in class ServerConnection

Throws:

IOException - if the close failed

getPeerAddress

public SocketAddress getPeerAddress()

Description copied from class: 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 ConnectedChannel

Specified by:

getPeerAddress in class ServerConnection

Returns:

The address of the remote peer

getPeerAddress

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

Description copied from class: 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 ConnectedChannel

Specified by:

getPeerAddress in class ServerConnection

Type Parameters:

A - The address type

Parameters:

type - The type of address to return

Returns:

The remote endpoint address

getLocalAddress

public SocketAddress getLocalAddress()

Description copied from interface: BoundChannel

Get the local address that this channel is bound to.

Specified by:

getLocalAddress in interface BoundChannel

Specified by:

getLocalAddress in class ServerConnection

Returns:

the local address

getLocalAddress

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

Description copied from interface: BoundChannel

Get the local address of a given type, or null if the address is not of that type.

Specified by:

getLocalAddress in interface BoundChannel

Specified by:

getLocalAddress in class ServerConnection

Type Parameters:

A - the address type

Parameters:

type - the address type class

Returns:

the local address, or null if unknown

getUndertowOptions

public OptionMap getUndertowOptions()

Specified by:

getUndertowOptions in class ServerConnection

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in class ServerConnection

Returns:

The size of the buffers allocated by the buffer pool

getExtraBytes

public PooledByteBuffer getExtraBytes()

setExtraBytes

public void setExtraBytes(PooledByteBuffer extraBytes)

getOriginalSourceConduit

public StreamSourceConduit getOriginalSourceConduit()

Returns:

The original source conduit

getOriginalSinkConduit

public 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

clearChannel

public void clearChannel()

Resets the channel to its original state, effectively disabling all current conduit wrappers. The current state is lost.

restoreChannel

public void restoreChannel(AbstractServerConnection.ConduitState state)

Restores the channel conduits to a previous state.

Parameters:

state - The original state

See Also:

resetChannel()

sink

protected static StreamSinkConduit sink(AbstractServerConnection.ConduitState state)

source

protected static StreamSourceConduit source(AbstractServerConnection.ConduitState state)

addCloseListener

public void addCloseListener(ServerConnection.CloseListener listener)

Description copied from class: ServerConnection

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

Specified by:

addCloseListener in class ServerConnection

Parameters:

listener - The close listener

getSinkChannel

protected ConduitStreamSinkChannel getSinkChannel()

Specified by:

getSinkChannel in class ServerConnection

getSourceChannel

protected ConduitStreamSourceChannel getSourceChannel()

Specified by:

getSourceChannel in class ServerConnection

setUpgradeListener

protected void setUpgradeListener(HttpUpgradeListener upgradeListener)

Specified by:

setUpgradeListener in class ServerConnection

maxEntitySizeUpdated

protected void maxEntitySizeUpdated(HttpServerExchange exchange)

Description copied from class: ServerConnection

Callback that is invoked if the max entity size is updated.

Specified by:

maxEntitySizeUpdated in class ServerConnection

Parameters:

exchange - The current exchange