org.wildfly.naming.client.remote

Class RemoteNamingProvider

java.lang.Object

org.wildfly.naming.client.remote.RemoteNamingProvider

All Implemented Interfaces:

AutoCloseable, NamingProvider

public final class RemoteNamingProvider
extends Object
implements NamingProvider

A provider for JBoss Remoting-based JNDI contexts. Any scheme which uses JBoss Remoting using this provider will share a connection and a captured security context.

Author:

David M. Lloyd

Nested Class Summary

Nested classes/interfaces inherited from interface org.wildfly.naming.client.NamingProvider

NamingProvider.Location

Method Summary

Modifier and Type	Method and Description
org.jboss.remoting3.Endpoint	getEndpoint() Get the Remoting endpoint for this provider.
org.xnio.IoFuture<org.jboss.remoting3.ConnectionPeerIdentity>	getFuturePeerIdentity(NamingProvider.Location location) Get the future connection peer identity.
List<NamingProvider.Location>	getLocations() Get the location(s) of this provider.
org.jboss.remoting3.ConnectionPeerIdentity	getPeerIdentity(NamingProvider.Location location) Get the connection peer identity.
org.jboss.remoting3.ConnectionPeerIdentity	getPeerIdentityForNaming() Get the connection peer identity for a naming operation.
org.jboss.remoting3.ConnectionPeerIdentity	getPeerIdentityForNaming(NamingProvider.Location location) Get the connection peer identity for a naming operation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wildfly.naming.client.NamingProvider

close, getAuthenticationConfiguration, getCurrentNamingProvider, getProviderUri, getSSLContext, performAction, performExceptionAction

Method Detail

getEndpoint

public org.jboss.remoting3.Endpoint getEndpoint()

Get the Remoting endpoint for this provider.

Returns:

the Remoting endpoint for this provider (not null)

getLocations

public List<NamingProvider.Location> getLocations()

Description copied from interface: NamingProvider

Get the location(s) of this provider. The returned list must non-null and non-empty, but may contain only one element. The returned list should be read-only or a copy, and the underlying list should not change.

Specified by:

getLocations in interface NamingProvider

Returns:

the locations of this provider (not null or empty)

getPeerIdentityForNaming

public org.jboss.remoting3.ConnectionPeerIdentity getPeerIdentityForNaming()
                                                                    throws NamingException

Get the connection peer identity for a naming operation. If the connection is not configured as immediate, then the connection will not actually be established until this method is called. The resultant connection should be closed and discarded in the event of an error, in order to facilitate automatic reconnection.

Specified by:

getPeerIdentityForNaming in interface NamingProvider

Returns:

the connection peer identity (not null)

Throws:

NamingException - if connecting, authenticating, or re-authenticating the peer failed

getPeerIdentityForNaming

public org.jboss.remoting3.ConnectionPeerIdentity getPeerIdentityForNaming(NamingProvider.Location location)
                                                                    throws NamingException

Get the connection peer identity for a naming operation. If the connection is not configured as immediate, then the connection will not actually be established until this method is called. The resultant connection should be closed and discarded in the event of an error, in order to facilitate automatic reconnection.

Specified by:

getPeerIdentityForNaming in interface NamingProvider

Parameters:

location - a location from getLocations() (must not be null)

Returns:

the connection peer identity (not null)

Throws:

NamingException - if connecting, authenticating, or re-authenticating the peer failed

getPeerIdentity

public org.jboss.remoting3.ConnectionPeerIdentity getPeerIdentity(NamingProvider.Location location)
                                                           throws IOException

Get the connection peer identity. If the connection is not configured as immediate, then the connection will not actually be established until this method is called. The resultant connection should be closed and discarded in the event of an error, in order to facilitate automatic reconnection.

Parameters:

location - a location from getLocations() (must not be null)

Returns:

the connection peer identity (not null)

Throws:

org.wildfly.security.auth.AuthenticationException - if authenticating or re-authenticating the peer failed

IOException - if connecting the peer failed

getFuturePeerIdentity

public org.xnio.IoFuture<org.jboss.remoting3.ConnectionPeerIdentity> getFuturePeerIdentity(NamingProvider.Location location)

Get the future connection peer identity. If the connection is not configured as immediate, then the connection will not actually be established until this method is called. The resultant connection should be closed and discarded in the event of an error, in order to facilitate automatic reconnection.

Returns:

the future connection peer identity (not null)