org.jboss.remoting3.remote

Class RemoteConnectionHandler

java.lang.Object

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

org.jboss.remoting3.remote.RemoteConnectionHandler

All Implemented Interfaces:

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

final class RemoteConnectionHandler
extends AbstractHandleableCloseable<ConnectionHandler>
implements ConnectionHandler

Nested Class Summary

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

HandleableCloseable.Key

Field Summary

Fields

Modifier and Type	Field and Description
private int	behavior
private IntIndexMap<RemoteConnectionChannel>	channels Channels.
private int	channelState
private static java.util.concurrent.atomic.AtomicIntegerFieldUpdater<RemoteConnectionHandler>	channelStateUpdater
private ConnectionHandlerContext	connectionContext
private static int	INBOUND_CHANNELS_MASK
private int	maxInboundChannels
private int	maxOutboundChannels
private static int	ONE_INBOUND_CHANNEL
private static int	ONE_OUTBOUND_CHANNEL
private static int	OUTBOUND_CHANNELS_MASK
private IntIndexMap<PendingChannel>	pendingChannels Pending channels.
private java.util.Collection<java.security.Principal>	principals
private static int	RECEIVED_CLOSE_REQ Received close request.
private RemoteConnection	remoteConnection
private java.lang.String	remoteEndpointName
private static int	SENT_CLOSE_REQ Sending close request, now shutting down the write side of all channels and refusing new channels.
private UserInfo	userInfo

Constructor Summary

Constructors

Constructor and Description
RemoteConnectionHandler(ConnectionHandlerContext connectionContext, RemoteConnection remoteConnection, java.util.Collection<java.security.Principal> principals, UserInfo userInfo, int maxInboundChannels, int maxOutboundChannels, java.lang.String remoteEndpointName, int behavior)

Method Summary

Modifier and Type	Method and Description
(package private) RemoteConnectionChannel	addChannel(RemoteConnectionChannel channel)
private boolean	casState(int oldState, int newState)
protected void	closeAction() Called exactly once when the close() method is invoked; the actual close operation should take place here.
private void	closeAllChannels()
protected void	closeComplete() Make this method visible.
private void	closePendingChannels()
(package private) void	dumpState(java.lang.StringBuilder b)
(package private) RemoteConnectionChannel	getChannel(int id)
(package private) ConnectionHandlerContext	getConnectionContext()
java.util.Collection<java.security.Principal>	getPrincipals() Get the authenticated principals for this connection.
java.lang.String	getRemoteEndpointName() Get the name of the remote endpoint.
javax.net.ssl.SSLSession	getSslSession() Get the underlying SSLSession for this connection if one is established.
UserInfo	getUserInfo() Get the authenticated UserInfo for this connection.
(package private) void	handleChannelClosed(RemoteConnectionChannel channel) A channel was closed, locally or remotely.
(package private) void	handleConnectionClose() The socket channel was closed with or without our consent.
(package private) void	handleInboundChannelClosed()
(package private) boolean	handleInboundChannelOpen()
(package private) void	handleOutboundChannelClosed()
(package private) void	handleOutboundChannelOpen()
private int	incrementState(int count)
(package private) boolean	isFaultyMessageSize()
(package private) boolean	isMessageClose()
org.xnio.Cancellable	open(java.lang.String serviceType, org.xnio.Result<Channel> result, org.xnio.OptionMap optionMap) Open a request handler.
(package private) void	putChannel(RemoteConnectionChannel channel)
(package private) void	receiveCloseRequest() The remote side requests a close of the whole channel.
(package private) PendingChannel	removePendingChannel(int id)
(package private) void	sendCloseRequest()
private void	sendCloseRequestBody()
(package private) static void	sendCloseRequestBody(RemoteConnection remoteConnection)
java.lang.String	toString()

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

addCloseHandler, awaitClosed, awaitClosedUninterruptibly, checkOpen, close, closeAsync, closeFailed, finalize, getExecutor, 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

connectionContext

private final ConnectionHandlerContext connectionContext

remoteConnection

private final RemoteConnection remoteConnection

channels

private final IntIndexMap<RemoteConnectionChannel> channels

Channels. Remote channel IDs are read with a "1" MSB and written with a "0" MSB. Local channel IDs are read with a "0" MSB and written with a "1" MSB. Channel IDs here are stored from the "write" perspective. Remote channels "0", Local channels "1" MSB.

pendingChannels

private final IntIndexMap<PendingChannel> pendingChannels

Pending channels. All have a "1" MSB. Replies are read with a "0" MSB.

principals

private final java.util.Collection<java.security.Principal> principals

userInfo

private final UserInfo userInfo

maxInboundChannels

private final int maxInboundChannels

maxOutboundChannels

private final int maxOutboundChannels

remoteEndpointName

private final java.lang.String remoteEndpointName

behavior

private final int behavior

channelState

private volatile int channelState

channelStateUpdater

private static final java.util.concurrent.atomic.AtomicIntegerFieldUpdater<RemoteConnectionHandler> channelStateUpdater

SENT_CLOSE_REQ

private static final int SENT_CLOSE_REQ

Sending close request, now shutting down the write side of all channels and refusing new channels. Once send, received = true and count == 0, shut down writes on the socket.

See Also:

Constant Field Values

RECEIVED_CLOSE_REQ

private static final int RECEIVED_CLOSE_REQ

Received close request. Send a close req if we haven't already done so.

See Also:

Constant Field Values

OUTBOUND_CHANNELS_MASK

private static final int OUTBOUND_CHANNELS_MASK

See Also:

Constant Field Values

ONE_OUTBOUND_CHANNEL

private static final int ONE_OUTBOUND_CHANNEL

See Also:

Constant Field Values

INBOUND_CHANNELS_MASK

private static final int INBOUND_CHANNELS_MASK

See Also:

Constant Field Values

ONE_INBOUND_CHANNEL

private static final int ONE_INBOUND_CHANNEL

See Also:

Constant Field Values

Constructor Detail

RemoteConnectionHandler

RemoteConnectionHandler(ConnectionHandlerContext connectionContext,
                        RemoteConnection remoteConnection,
                        java.util.Collection<java.security.Principal> principals,
                        UserInfo userInfo,
                        int maxInboundChannels,
                        int maxOutboundChannels,
                        java.lang.String remoteEndpointName,
                        int behavior)

Method Detail

handleConnectionClose

void handleConnectionClose()

The socket channel was closed with or without our consent.

closeComplete

protected void closeComplete()

Make this method visible.

Overrides:

closeComplete in class AbstractHandleableCloseable<ConnectionHandler>

handleChannelClosed

void handleChannelClosed(RemoteConnectionChannel channel)

A channel was closed, locally or remotely.

Parameters:

channel - the channel that was closed

handleInboundChannelClosed

void handleInboundChannelClosed()

handleOutboundChannelClosed

void handleOutboundChannelClosed()

handleInboundChannelOpen

boolean handleInboundChannelOpen()

handleOutboundChannelOpen

void handleOutboundChannelOpen()
                        throws java.io.IOException

Throws:

java.io.IOException

receiveCloseRequest

void receiveCloseRequest()

The remote side requests a close of the whole channel.

sendCloseRequest

void sendCloseRequest()

incrementState

private int incrementState(int count)

casState

private boolean casState(int oldState,
                         int newState)

sendCloseRequestBody

private void sendCloseRequestBody()

sendCloseRequestBody

static void sendCloseRequestBody(RemoteConnection remoteConnection)

open

public org.xnio.Cancellable open(java.lang.String serviceType,
                                 org.xnio.Result<Channel> result,
                                 org.xnio.OptionMap optionMap)

Description copied from interface: ConnectionHandler

Open a request handler.

Specified by:

open in interface ConnectionHandler

Parameters:

serviceType - the service type string

result - the result for the connected channel

optionMap - the options for this service

Returns:

a handle which may be used to cancel the pending operation

getPrincipals

public java.util.Collection<java.security.Principal> getPrincipals()

Description copied from interface: ConnectionHandler

Get the authenticated principals for this connection.

Specified by:

getPrincipals in interface ConnectionHandler

Returns:

the authenticated principals

getUserInfo

public UserInfo getUserInfo()

Description copied from interface: ConnectionHandler

Get the authenticated UserInfo for this connection.

Specified by:

getUserInfo in interface ConnectionHandler

Returns:

the authenticated UserInfo

getSslSession

public javax.net.ssl.SSLSession getSslSession()

Description copied from interface: ConnectionHandler

Get the underlying SSLSession for this connection if one is established.

Specified by:

getSslSession in interface ConnectionHandler

Returns:

the SSLSession for the connection if one is established, otherwise returns null.

getRemoteEndpointName

public java.lang.String getRemoteEndpointName()

Description copied from interface: ConnectionHandler

Get the name of the remote endpoint.

Specified by:

getRemoteEndpointName in interface ConnectionHandler

Returns:

the remote endpoint name

closeAction

protected void closeAction()
                    throws java.io.IOException

Description copied from class: AbstractHandleableCloseable

Called exactly once when the close() method is invoked; the actual close operation should take place here. This method must call AbstractHandleableCloseable.closeComplete(), directly or indirectly, for the close operation to finish (it may happen in another thread but it must happen). This method should not expect the AbstractHandleableCloseable.closeComplete() call to be made from another thread from the same thread pool that may cause AbstractHandleableCloseable.close(). As close will block, this can result in situations where all threads in the pool are blocked on AbstractHandleableCloseable.close() method calls, which means the AbstractHandleableCloseable.closeComplete() will never be run.

Overrides:

closeAction in class AbstractHandleableCloseable<ConnectionHandler>

Throws:

RemotingException - if the close failed

java.io.IOException

closePendingChannels

private void closePendingChannels()

closeAllChannels

private void closeAllChannels()

getConnectionContext

ConnectionHandlerContext getConnectionContext()

addChannel

RemoteConnectionChannel addChannel(RemoteConnectionChannel channel)

getChannel

RemoteConnectionChannel getChannel(int id)

removePendingChannel

PendingChannel removePendingChannel(int id)

putChannel

void putChannel(RemoteConnectionChannel channel)

isMessageClose

boolean isMessageClose()

isFaultyMessageSize

boolean isFaultyMessageSize()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

dumpState

void dumpState(java.lang.StringBuilder b)