org.springframework.data.gemfire.support

Class ComposableRegionResolver

java.lang.Object

org.apache.geode.cache.util.CacheListenerAdapter

org.springframework.data.gemfire.support.AbstractCachingRegionResolver

org.springframework.data.gemfire.support.ComposableRegionResolver

All Implemented Interfaces:

org.apache.geode.cache.CacheCallback, org.apache.geode.cache.CacheListener, org.apache.geode.cache.Declarable, RegionResolver

public class ComposableRegionResolver
extends AbstractCachingRegionResolver

RegionResolver implementation used to compose a collection of RegionResolvers.

Since:

2.3.0

Author:

John Blum

See Also:

Region, RegionResolver, AbstractCachingRegionResolver

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ComposableRegionResolver(RegionResolver regionResolverOne, RegionResolver regionResolverTwo) Constructs a new instance of ComposableRegionResolver initialized and composed with the given RegionResolvers forming the composition.

Method Summary

Modifier and Type	Method and Description
static RegionResolver	compose(Iterable<RegionResolver> regionResolvers) Factory method used to compose an Iterable collection of RegionResolvers in a composition.
static RegionResolver	compose(RegionResolver... regionResolvers) Factory method used to compose an array of RegionResolvers in a composition.
static RegionResolver	compose(RegionResolver one, RegionResolver two) Composes two RegionResolvers in a composition.
protected <K,V> org.apache.geode.cache.Region<K,V>	doResolve(String regionName) Resolves the first non-null reference to cache Region identified by the given name, handling any Exceptions throwing by the composed RegionResolvers, such as a RegionDestroyedException.
protected RegionResolver	getRegionResolverOne() Returns a reference to the first, non-null, configured RegionResolver in the composition.
protected RegionResolver	getRegionResolverTwo() Returns a reference to the second, non-null, configured RegionResolver in the composition.

Methods inherited from class org.springframework.data.gemfire.support.AbstractCachingRegionResolver

afterRegionDestroy, resolve

Methods inherited from class org.apache.geode.cache.util.CacheListenerAdapter

afterCreate, afterDestroy, afterInvalidate, afterRegionClear, afterRegionCreate, afterRegionInvalidate, afterRegionLive, afterUpdate, close

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.RegionResolver

require

Methods inherited from interface org.apache.geode.cache.Declarable

init, initialize

Constructor Detail

ComposableRegionResolver

protected ComposableRegionResolver(@NonNull
                                   RegionResolver regionResolverOne,
                                   @NonNull
                                   RegionResolver regionResolverTwo)

Constructs a new instance of ComposableRegionResolver initialized and composed with the given RegionResolvers forming the composition.

Parameters:

regionResolverOne - first RegionResolver in the composition; must not be null.

regionResolverTwo - second RegionResolver in the composition; must not be null.

Throws:

IllegalArgumentException - if either RegionResolver argument is null.

See Also:

RegionResolver

Method Detail

compose

public static RegionResolver compose(@Nullable
                                     RegionResolver... regionResolvers)

Factory method used to compose an array of RegionResolvers in a composition.

Parameters:

regionResolvers - array of RegionResolvers to compose; may be null.

Returns:

a composition from the array of RegionResolvers; may be null.

See Also:

RegionResolver, compose(Iterable)

compose

@Nullable
public static RegionResolver compose(@Nullable
                                               Iterable<RegionResolver> regionResolvers)

Factory method used to compose an Iterable collection of RegionResolvers in a composition.

Parameters:

regionResolvers - Iterable collection of RegionResolvers to compose; may be null.

Returns:

a composition from the Iterable collection of RegionResolvers; may be null.

See Also:

compose(RegionResolver, RegionResolver), RegionResolver, Iterable

compose

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

Composes two RegionResolvers in a composition.

Parameters:

one - first RegionResolver in the composition.

two - second RegionResolver in the composition.

Returns:

a ComposableRegionResolver composed of the RegionResolver arguments. Returns the first RegionResolver if the second is null. Returns the second RegionResolver if the first is null. Returns null if both RegionResolver arguments are null.

See Also:

ComposableRegionResolver(RegionResolver, RegionResolver), RegionResolver

getRegionResolverOne

@NonNull
protected RegionResolver getRegionResolverOne()

Returns a reference to the first, non-null, configured RegionResolver in the composition.

Returns:

a reference to the first RegionResolver in the composition.

See Also:

RegionResolver

getRegionResolverTwo

@NonNull
protected RegionResolver getRegionResolverTwo()

Returns a reference to the second, non-null, configured RegionResolver in the composition.

Returns:

a reference to the second RegionResolver in the composition.

See Also:

RegionResolver

doResolve

@Nullable
protected <K,V> org.apache.geode.cache.Region<K,V> doResolve(@Nullable
                                                                       String regionName)

Resolves the first non-null reference to cache Region identified by the given name, handling any Exceptions throwing by the composed RegionResolvers, such as a RegionDestroyedException. This method may ultimately still result in a thrown Exception, but it will make a best effort to exhaustively consult all composed RegionResolvers.

Specified by:

doResolve in class AbstractCachingRegionResolver

Type Parameters:

K - type of the Region key.

V - type of the Region value.

Parameters:

regionName - name of the Region to resolve.

Returns:

the first, resolved reference to a cache Region identified by the given name.

See Also:

RegionResolver.resolve(String), Region, Function, getRegionResolverOne(), getRegionResolverTwo()