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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	NamingProvider.Location A provider location.

Method Summary

Modifier and Type	Method and Description
default void	close() Close the provider.
default org.wildfly.security.auth.client.AuthenticationConfiguration	getAuthenticationConfiguration() Deprecated. Use getLocations() instead.
static NamingProvider	getCurrentNamingProvider() Get the current naming provider being used for the current deserialization operation.
List<NamingProvider.Location>	getLocations() Get the location(s) of this provider.
default org.wildfly.security.auth.client.PeerIdentity	getPeerIdentityForNaming() Get a peer identity to use for context operations.
org.wildfly.security.auth.client.PeerIdentity	getPeerIdentityForNaming(NamingProvider.Location location) Get the peer identity to use for context operations for the specified location.
default URI	getProviderUri() Deprecated. Use getLocations() instead.
default SSLContext	getSSLContext() Deprecated. Use getLocations() instead.
default <T,U,R> R	performAction(BiFunction<T,U,R> function, T arg1, U arg2) Perform an action under the current naming provider.
default <T,U,R,E extends Exception> R	performExceptionAction(org.wildfly.common.function.ExceptionBiFunction<T,U,R,E> function, T arg1, U arg2) Perform an action under the current naming provider.

Method Detail

getLocations

List<NamingProvider.Location> getLocations()

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.

Returns:

the locations of this provider (not null or empty)

getProviderUri

@Deprecated
default URI getProviderUri()

Deprecated. Use getLocations() instead.

Get the provider URI of this provider.

Returns:

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

getPeerIdentityForNaming

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

Get a peer identity to use for context operations. 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.

Returns:

the peer identity to use (must not be null)

Throws:

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

getPeerIdentityForNaming

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

Get the peer identity to use for context operations for the specified location. The identity may be fixed or it may vary, depending on the context configuration. The location should be from the list returned by getLocations().

Parameters:

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

Returns:

the peer identity to use (must not be null)

Throws:

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

getAuthenticationConfiguration

@Deprecated
default org.wildfly.security.auth.client.AuthenticationConfiguration getAuthenticationConfiguration()

Deprecated. Use getLocations() instead.

Get the authentication configuration for this naming provider, or null if no particular configuration is established.

Returns:

the naming configuration, or null for none

getSSLContext

@Deprecated
default SSLContext getSSLContext()

Deprecated. Use getLocations() instead.

Get the SSL context for this naming provider, or null if no particular SSL context is established.

Returns:

the SSL context, or null for none

getCurrentNamingProvider

static NamingProvider getCurrentNamingProvider()

Get the current naming provider being used for the current deserialization operation.

Returns:

the current naming provider, or null if no provider-related deserialization is occurring

performAction

default <T,U,R> R performAction(BiFunction<T,U,R> function,
                                T arg1,
                                U arg2)

Perform an action under the current naming provider.

Type Parameters:

T - the first argument type

U - the second argument type

R - the function return type

Parameters:

function - the function to apply (must not be null)

arg1 - the first argument

arg2 - the second argument

Returns:

the function return value

performExceptionAction

default <T,U,R,E extends Exception> R performExceptionAction(org.wildfly.common.function.ExceptionBiFunction<T,U,R,E> function,
                                                             T arg1,
                                                             U arg2)
                                                      throws E extends Exception

Perform an action under the current naming provider.

Type Parameters:

T - the first argument type

U - the second argument type

R - the function return type

E - the function exception type

Parameters:

function - the function to apply (must not be null)

arg1 - the first argument

arg2 - the second argument

Returns:

the function return value

Throws:

E - if the function throws an exception of the given type

E extends Exception

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