org.wildfly.naming.client.remote

Class RemoteNamingProvider

java.lang.Object

org.wildfly.naming.client.remote.RemoteNamingProvider

All Implemented Interfaces:

AutoCloseable, NamingProvider

public abstract 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

Constructor Summary

Constructors

Constructor and Description
RemoteNamingProvider()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Close the provider.
abstract Endpoint	getEndpoint() Get the Remoting endpoint for this provider.
abstract IoFuture<ConnectionPeerIdentity>	getFuturePeerIdentity() Get the future connection peer identity.
abstract ConnectionPeerIdentity	getPeerIdentity() Get the connection peer identity.
ConnectionPeerIdentity	getPeerIdentityForNaming() Get the connection peer identity for a naming operation.
abstract URI	getProviderUri() Get the provider URI of this provider.

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

getCurrentNamingProvider, performAction, performExceptionAction

Constructor Detail

RemoteNamingProvider

public RemoteNamingProvider()

Method Detail

getEndpoint

public abstract Endpoint getEndpoint()

Get the Remoting endpoint for this provider.

Returns:

the Remoting endpoint for this provider (not null)

getPeerIdentityForNaming

public 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

getPeerIdentity

public abstract ConnectionPeerIdentity getPeerIdentity()
                                                throws org.wildfly.security.auth.AuthenticationException,
                                                       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.

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 abstract IoFuture<ConnectionPeerIdentity> getFuturePeerIdentity()

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)

getProviderUri

public abstract URI getProviderUri()

Description copied from interface: NamingProvider

Get the provider URI of this provider.

Specified by:

getProviderUri in interface NamingProvider

Returns:

the provider URI of this provider (must not be null)

close

public abstract void close()
                    throws NamingException

Description copied from interface: NamingProvider

Close the provider. This method is called when the corresponding InitialContext is closed. This method should be idempotent.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface NamingProvider

Throws:

NamingException - if an error occurred while closing this provider