org.jboss.remoting3.remote

Class HttpUpgradeConnectionProvider

java.lang.Object

org.jboss.remoting3.spi.AbstractHandleableCloseable<ConnectionProvider>

org.jboss.remoting3.remote.RemoteConnectionProvider

org.jboss.remoting3.remote.HttpUpgradeConnectionProvider

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, HandleableCloseable<ConnectionProvider>, ConnectionProvider

final class HttpUpgradeConnectionProvider
extends RemoteConnectionProvider

Connection provider that performs a HTTP upgrade. The upgrade handshake borrows heavily from the web socket protocol, but with the following changes: - The magic number used is CF70DEB8-70F9-4FBA-8B4F-DFC3E723B4CD instead of 258EAFA5-E914-47DA-95CA-C5AB0DC85B11 - The 'Sec-JbossRemoting-Key' header is used in place of the 'Sec-WebSocket-Key' challenge header - The 'Sec-JbossRemoting-Accept' header is used in place of the 'Sec-WebSocket-Accept' header Other than that the handshake process is identical. Once the upgrade is completed the remoting handshake takes place as normal.

See Also:

http://tools.ietf.org/html/rfc6455

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	HttpUpgradeConnectionProvider.ConnectionAdaptorImpl
private static class	HttpUpgradeConnectionProvider.FlexBase64
(package private) class	HttpUpgradeConnectionProvider.ProviderInterface
private class	HttpUpgradeConnectionProvider.RemotingHandshakeChecker

Nested classes/interfaces inherited from interface org.jboss.remoting3.HandleableCloseable

HandleableCloseable.Key

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MAGIC_NUMBER Magic number used in the handshake.
private HttpUpgradeConnectionProvider.ProviderInterface	providerInterface
static java.lang.String	SEC_JBOSS_REMOTING_ACCEPT
static java.lang.String	SEC_JBOSS_REMOTING_KEY
static java.lang.String	UPGRADE

Fields inherited from class org.jboss.remoting3.remote.RemoteConnectionProvider

GLOBAL_POOL, LEAK_DEBUGGING, USE_POOLING

Fields inherited from interface org.jboss.remoting3.spi.ConnectionProvider

NO_PROVIDER_INTERFACES

Constructor Summary

Constructors

Constructor and Description
HttpUpgradeConnectionProvider(org.xnio.OptionMap optionMap, ConnectionProviderContext connectionProviderContext)

Method Summary

Modifier and Type	Method and Description
protected org.xnio.IoFuture<org.xnio.channels.ConnectedStreamChannel>	createConnection(java.net.SocketAddress bindAddress, java.net.SocketAddress dst, org.xnio.OptionMap connectOptions, org.xnio.ChannelListener<org.xnio.channels.ConnectedStreamChannel> openListener)
protected java.lang.String	createExpectedResponse(java.lang.String secKey)
protected java.lang.String	createSecKey()
protected org.xnio.IoFuture<org.xnio.channels.ConnectedSslStreamChannel>	createSslConnection(java.net.SocketAddress bindAddress, java.net.InetSocketAddress destination, org.xnio.OptionMap options, org.xnio.ssl.XnioSsl xnioSsl, org.xnio.ChannelListener<org.xnio.channels.ConnectedStreamChannel> openListener)
HttpUpgradeConnectionProvider.ProviderInterface	getProviderInterface() Get the user data associated with this connection provider.

Methods inherited from class org.jboss.remoting3.remote.RemoteConnectionProvider

addConnectionHandler, closeAction, connect, getConnectionProviderContext, getExecutor, getXnioWorker, removeConnectionHandler, toString

Methods inherited from class org.jboss.remoting3.spi.AbstractHandleableCloseable

addCloseHandler, awaitClosed, awaitClosedUninterruptibly, checkOpen, close, closeAsync, closeComplete, closeFailed, finalize, isOpen

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.remoting3.HandleableCloseable

addCloseHandler, awaitClosed, awaitClosedUninterruptibly, close, closeAsync

Field Detail

MAGIC_NUMBER

public static final java.lang.String MAGIC_NUMBER

Magic number used in the handshake.

See Also:

Constant Field Values

SEC_JBOSS_REMOTING_KEY

public static final java.lang.String SEC_JBOSS_REMOTING_KEY

See Also:

Constant Field Values

SEC_JBOSS_REMOTING_ACCEPT

public static final java.lang.String SEC_JBOSS_REMOTING_ACCEPT

See Also:

Constant Field Values

UPGRADE

public static final java.lang.String UPGRADE

See Also:

Constant Field Values

providerInterface

private final HttpUpgradeConnectionProvider.ProviderInterface providerInterface

Constructor Detail

HttpUpgradeConnectionProvider

HttpUpgradeConnectionProvider(org.xnio.OptionMap optionMap,
                              ConnectionProviderContext connectionProviderContext)
                       throws java.io.IOException

Throws:

java.io.IOException

Method Detail

createConnection

protected org.xnio.IoFuture<org.xnio.channels.ConnectedStreamChannel> createConnection(java.net.SocketAddress bindAddress,
                                                                                       java.net.SocketAddress dst,
                                                                                       org.xnio.OptionMap connectOptions,
                                                                                       org.xnio.ChannelListener<org.xnio.channels.ConnectedStreamChannel> openListener)

Overrides:

createConnection in class RemoteConnectionProvider

createSslConnection

protected org.xnio.IoFuture<org.xnio.channels.ConnectedSslStreamChannel> createSslConnection(java.net.SocketAddress bindAddress,
                                                                                             java.net.InetSocketAddress destination,
                                                                                             org.xnio.OptionMap options,
                                                                                             org.xnio.ssl.XnioSsl xnioSsl,
                                                                                             org.xnio.ChannelListener<org.xnio.channels.ConnectedStreamChannel> openListener)

Overrides:

createSslConnection in class RemoteConnectionProvider

getProviderInterface

public HttpUpgradeConnectionProvider.ProviderInterface getProviderInterface()

Description copied from interface: ConnectionProvider

Get the user data associated with this connection provider. This object should implement all of the provider interfaces which are supported by this provider. Must not return null.

Specified by:

getProviderInterface in interface ConnectionProvider

Overrides:

getProviderInterface in class RemoteConnectionProvider

Returns:

the user data (not null)

See Also:

NetworkServerProvider

createSecKey

protected java.lang.String createSecKey()

createExpectedResponse

protected java.lang.String createExpectedResponse(java.lang.String secKey)
                                           throws java.io.IOException

Throws:

java.io.IOException