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

Method Summary

Modifier and Type	Method and Description
Endpoint	getEndpoint() Get the Remoting endpoint for this provider.
IoFuture<ConnectionPeerIdentity>	getFuturePeerIdentity(URI location) Get the future connection peer identity.
ConnectionPeerIdentity	getPeerIdentity(URI location) Get the connection peer identity.
ConnectionPeerIdentity	getPeerIdentityForNaming() Get the connection peer identity for a naming operation.
ConnectionPeerIdentity	getPeerIdentityForNaming(URI location) Get the connection peer identity for a naming operation.
ConnectionPeerIdentity	getPeerIdentityForNamingUsingRetry(RetryContext context) Get a peer identity to use for context operations, retrying on failure.
ProviderEnvironment	getProviderEnvironment() Get the provider environment.

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, getCurrentNamingProvider, performAction, performExceptionAction, performExceptionAction, throwNoMoreDestinationsException

Method Detail

getEndpoint

public Endpoint getEndpoint()

Get the Remoting endpoint for this provider.

Returns:

the Remoting endpoint for this provider (not null)

getProviderEnvironment

public ProviderEnvironment getProviderEnvironment()

Description copied from interface: NamingProvider

Get the provider environment.

Specified by:

getProviderEnvironment in interface NamingProvider

Returns:

the provider environment (must not be 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

getPeerIdentityForNamingUsingRetry

public ConnectionPeerIdentity getPeerIdentityForNamingUsingRetry(RetryContext context)
                                                          throws NamingException

Description copied from interface: NamingProvider

Get a peer identity to use for context operations, retrying on failure. The identity may be fixed or it may vary, depending on the context configuration. If the provider has multiple locations, a location is randomly selected. If the retry context is null, a retry will not occur.

Specified by:

getPeerIdentityForNamingUsingRetry in interface NamingProvider

Parameters:

context - the retry context for storing state required when retrying

Returns:

the peer identity to use (must not be null)

Throws:

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

getPeerIdentityForNaming

public ConnectionPeerIdentity getPeerIdentityForNaming(URI 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 ProviderEnvironment.getProviderUris() (must not be null)

Returns:

the connection peer identity (not null)

Throws:

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

getPeerIdentity

public ConnectionPeerIdentity getPeerIdentity(URI 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 ProviderEnvironment.getProviderUris() (must not be null)

Returns:

the connection peer identity (not null)

Throws:

AuthenticationException - if authenticating or re-authenticating the peer failed

IOException - if connecting the peer failed

getFuturePeerIdentity

public IoFuture<ConnectionPeerIdentity> getFuturePeerIdentity(URI 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.

Parameters:

location - a location from ProviderEnvironment.getProviderUris() (must not be null)

Returns:

the future connection peer identity (not null)