org.springframework.data.gemfire.client.support

Class ComposablePoolResolver

java.lang.Object

org.springframework.data.gemfire.client.support.ComposablePoolResolver

All Implemented Interfaces:

PoolResolver

public class ComposablePoolResolver
extends Object
implements PoolResolver

Composite of PoolResolvers functioning as a single PoolResolver.

Since:

2.3.0

Author:

John Blum

See Also:

Pool, PoolResolver

Field Summary

Fields inherited from interface org.springframework.data.gemfire.client.PoolResolver

DEFAULT_POOL_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ComposablePoolResolver(PoolResolver poolResolverOne, PoolResolver poolResolverTwo) Constructs a new instance of ComposablePoolResolver initialized and composed of two PoolResolver implementations that will function as one.

Method Summary

Modifier and Type	Method and Description
static PoolResolver	compose(Iterable<PoolResolver> poolResolvers) Null-safe factory method to compose an Iterable of PoolResolver objects.
static PoolResolver	compose(PoolResolver... poolResolvers) Null-safe factory method to compose an array of PoolResolver objects.
static PoolResolver	compose(PoolResolver one, PoolResolver two) Null-safe factory method to compose two PoolResolver objects in a composition.
protected PoolResolver	getPoolResolverOne() Returns a reference to the first PoolResolver in the composition.
protected PoolResolver	getPoolResolverTwo() Returns a reference to the second PoolResolver in the composition.
org.apache.geode.cache.client.Pool	resolve(String poolName) Attempts to resolve a Pool with the given name by delegating to the composed PoolResolver objects.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.gemfire.client.PoolResolver

require, resolve, resolve

Constructor Detail

ComposablePoolResolver

protected ComposablePoolResolver(PoolResolver poolResolverOne,
                                 PoolResolver poolResolverTwo)

Constructs a new instance of ComposablePoolResolver initialized and composed of two PoolResolver implementations that will function as one.

Parameters:

poolResolverOne - first PoolResolver in the composition order.

poolResolverTwo - second PoolResolver in the composition order.

Throws:

IllegalArgumentException - if either the first or second PoolResolver are null.

See Also:

PoolResolver

Method Detail

compose

@Nullable
public static PoolResolver compose(@Nullable
                                             PoolResolver... poolResolvers)

Null-safe factory method to compose an array of PoolResolver objects. Preserves order in the composition.

Parameters:

poolResolvers - array of PoolResolver objects to compose.

Returns:

a composition from the array of PoolResolver objects; may return null.

See Also:

PoolResolver, compose(Iterable)

compose

@Nullable
public static PoolResolver compose(@Nullable
                                             Iterable<PoolResolver> poolResolvers)

Null-safe factory method to compose an Iterable of PoolResolver objects. Preserves order in the composition if the Iterable collection-like data structure is ordered, like a List).

Parameters:

poolResolvers - Iterable of PoolResolver objects to compose.

Returns:

a composition from the Iterable of PoolResolver objects; may return null.

See Also:

PoolResolver, Iterable, compose(PoolResolver, PoolResolver)

compose

@Nullable
public static PoolResolver compose(@Nullable
                                             PoolResolver one,
                                             @Nullable
                                             PoolResolver two)

Null-safe factory method to compose two PoolResolver objects in a composition.

Parameters:

one - first PoolResolver in the composition.

two - second PoolResolver in the composition.

Returns:

a composition from the two PoolResolver objects. Returns the first PoolResolver if the second PoolResolver is null. Returns the second PoolResolver if the first PoolResolver is null. Returns null if both PoolResolver arguments are null.

See Also:

PoolResolver, ComposablePoolResolver(PoolResolver, PoolResolver)

getPoolResolverOne

@NonNull
protected PoolResolver getPoolResolverOne()

Returns a reference to the first PoolResolver in the composition.

Returns:

a reference to the first PoolResolver in the composition.

See Also:

PoolResolver

getPoolResolverTwo

@NonNull
protected PoolResolver getPoolResolverTwo()

Returns a reference to the second PoolResolver in the composition.

Returns:

a reference to the second PoolResolver in the composition.

See Also:

PoolResolver

resolve

@Nullable
public org.apache.geode.cache.client.Pool resolve(@Nullable
                                                            String poolName)

Attempts to resolve a Pool with the given name by delegating to the composed PoolResolver objects. The first PoolResolver in the composition to resolve a Pool with the given name stops the resolution process and returns the target Pool. If no Pool with the given name can be resolved by any PoolResolver in the composition, then null will be returned.

Specified by:

resolve in interface PoolResolver

Parameters:

poolName - name of the Pool to resolve.

Returns:

the resolved Pool or null if a Pool with name cannot be resolved.

See Also:

Pool, getPoolResolverOne(), getPoolResolverTwo()