org.jboss.remoting3.spi

Interface ConnectionHandler

All Superinterfaces:

AutoCloseable, Closeable, HandleableCloseable<ConnectionHandler>

public interface ConnectionHandler
extends HandleableCloseable<ConnectionHandler>

A connection to a foreign endpoint. This interface is implemented by the protocol implementation.

Nested Class Summary

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

HandleableCloseable.Key

Method Summary

Modifier and Type	Method and Description
SocketAddress	getLocalAddress() Get the local address, if any.
org.wildfly.security.auth.server.SecurityIdentity	getLocalIdentity() Get the local identity corresponding to the peer authentication which was performed on this connection, if it is an incoming connection.
org.wildfly.security.auth.server.SecurityIdentity	getLocalIdentity(int id) Get the local identity associated with the given ID that was previously shared to the peer.
SocketAddress	getPeerAddress() Get the peer address, if any.
int	getPeerIdentityId() The the ID number for the peer identity which is currently associated with the calling thread.
String	getRemoteEndpointName() Get the name of the remote endpoint.
SSLSession	getSslSession() /** Get the underlying SSLSession for this connection if one is established.
org.xnio.Cancellable	open(String serviceType, org.xnio.Result<Channel> result, org.xnio.OptionMap optionMap) Open a request handler.

Methods inherited from interface org.jboss.remoting3.HandleableCloseable

addCloseHandler, awaitClosed, awaitClosedUninterruptibly, close, closeAsync

Method Detail

open

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

Open a request handler.

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

getSslSession

SSLSession getSslSession()

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

Returns:

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

getRemoteEndpointName

String getRemoteEndpointName()

Get the name of the remote endpoint.

Returns:

the remote endpoint name

getLocalAddress

SocketAddress getLocalAddress()

Get the local address, if any.

Returns:

the local address, or null if there is none

getPeerAddress

SocketAddress getPeerAddress()

Get the peer address, if any.

Returns:

the peer address, or null if there is none

getLocalIdentity

org.wildfly.security.auth.server.SecurityIdentity getLocalIdentity()

Get the local identity corresponding to the peer authentication which was performed on this connection, if it is an incoming connection. Outbound connections will always return null for this property.

Returns:

the local identity of inbound connections, or null if the connection is not inbound

getLocalIdentity

org.wildfly.security.auth.server.SecurityIdentity getLocalIdentity(int id)

Get the local identity associated with the given ID that was previously shared to the peer.

Parameters:

id - the numeric ID

Returns:

the identity, or null if the the given ID is not valid

getPeerIdentityId

int getPeerIdentityId()

The the ID number for the peer identity which is currently associated with the calling thread. The special value 0 indicates that the connection's identity is in use; the special value 1 indicates that the anonymous identity is in use.

Returns:

the numeric ID