org.wildfly.naming.client

Interface NamingProvider

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

HttpNamingProvider, 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.
static NamingProvider	getCurrentNamingProvider() Get the current naming provider being used for the current deserialization operation.
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.
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

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

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