org.wildfly.naming.client

Class ProviderEnvironment

java.lang.Object

org.wildfly.naming.client.ProviderEnvironment

public final class ProviderEnvironment
extends Object

Environmental information pertaining to a naming provider.

Author:

David M. Lloyd

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProviderEnvironment.Builder The builder for ProviderEnvironment instances.

Field Summary

Fields

Modifier and Type	Field and Description
static long	TIME_MASK

Method Summary

Modifier and Type	Method and Description
void	dropFromBlacklist(URI location) Removes the specified location from the black-list, allowing it to be used again.
Supplier<AuthenticationContext>	getAuthenticationContextSupplier() Get the authentication context supplier to use.
ConcurrentMap<URI,Long>	getBlackList() Gets the black-list for this provider.
List<URI>	getProviderUris() Get the list of provider URLs.
void	updateBlacklist(URI location) Adds location to black-list, or extends it's back-off value if already present in the black list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TIME_MASK

public static final long TIME_MASK

See Also:

Constant Field Values

Method Detail

getProviderUris

public List<URI> getProviderUris()

Get the list of provider URLs.

Returns:

the list of provider URLs (not null)

getBlackList

public ConcurrentMap<URI,Long> getBlackList()

Gets the black-list for this provider. The map should generally not be mutated, with updates instead going through updateBlacklist(URI) and dropFromBlacklist(URI).

The map is keyed by destination URI, as specified by PROVIDER_URL. The value is a long that loosely corresponds to an expiration timestamp. More specifically the time portion is the first 49 bits, retrievable using a bitwise AND on TIME_MASK. The remaining bits are used to store the current back-off multiplier. These are typically not of interest to a user or provider implementor, as updateBlacklist(URI) will update them accordingly.

A simple provider implementation would perform the falling pseudo-code when selecting a destination:

 URI location = ...
 Long timeout = env.getBlackList().get(location);
 if (timeout == null || time >= (timeout & TIME_MASK)) {
     // Black-list entry expired!!
 } else {
     // Ignoring, still black-listed!
 }

 

Returns:

a concurrent map representing the black-list

updateBlacklist

public void updateBlacklist(URI location)

Adds location to black-list, or extends it's back-off value if already present in the black list. Each call doubles the back-off time, as well as resets the starting time. Providers should call this method anytime a location is non-responsive.

Parameters:

location - the URI to black-list.

dropFromBlacklist

public void dropFromBlacklist(URI location)

Removes the specified location from the black-list, allowing it to be used again.

Parameters:

location - the location to remove

getAuthenticationContextSupplier

public Supplier<AuthenticationContext> getAuthenticationContextSupplier()

Get the authentication context supplier to use. The default supplier simply captures the current context from the calling thread, but this behavior can be modified by establishing authentication information on the environment of the initial context or by individual naming providers.

Returns:

the authentication context supplier to use (must not be null)