org.wildfly.naming.client

Interface NamingProvider

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RemoteNamingProvider

public interface NamingProvider
extends AutoCloseable

A provider for a single naming scheme. Each implementation of a naming provider has different characteristics.

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method and Description
default void	close() Close the provider.
org.wildfly.security.auth.client.PeerIdentity	getPeerIdentityForNaming() Get the peer identity to use for context operations.
URI	getProviderUri() Get the provider URI of this provider.

Method Detail

getProviderUri

URI getProviderUri()

Get the provider URI of this provider.

Returns:

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

getPeerIdentityForNaming

org.wildfly.security.auth.client.PeerIdentity getPeerIdentityForNaming()
                                                                throws NamingException

Get the peer identity to use for context operations. The identity may be fixed or it may vary, depending on the context configuration.

Returns:

the peer identity to use (must not be null)

Throws:

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

close

default void close()
            throws NamingException

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

Specified by:

close in interface AutoCloseable

Throws:

NamingException - if an error occurred while closing this provider