Package com.tangosol.util

Interface ResourceRegistry

All Superinterfaces:

AutoCloseable, Disposable, ResourceResolver

All Known Implementing Classes:

NullImplementation.NullResourceRegistry, SimpleResourceRegistry, SimpleResourceResolver

public interface ResourceRegistry
extends ResourceResolver, Disposable

A ResourceRegistry is a registry and owner of strongly typed and explicitly named resources.

When a resource is registered with a ResourceRegistry, the ResourceRegistry assumes ownership of the said resource, up until at which point the ResourceRegistry is disposed.

Important: Although a ResourceRegistry manages resources in a thread-safe manner, it is possible for a thread calling ResourceResolver.getResource(Class, String) to receive a null return value while another thread is registering a resource.

Since:

Coherence 12.1.2

Author:

bo 2011.06.05

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ResourceRegistry.ResourceLifecycleObserver<R>	The ResourceRegistry.ResourceLifecycleObserver interface defines lifecycle handlers for resources registered with a ResourceRegistry.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_NAME	The name to use for the registration of a singleton and thus default resource.

Method Summary

Modifier and Type	Method	Description
<R> String	registerResource(Class<R> clzResource, Builder<? extends R> bldrResource, RegistrationBehavior behavior, ResourceRegistry.ResourceLifecycleObserver<R> observer)	Registers a resource according to the specified RegistrationBehavior.
<R> String	registerResource(Class<R> clzResource, String sResourceName, Builder<? extends R> bldrResource, RegistrationBehavior behavior, ResourceRegistry.ResourceLifecycleObserver<R> observer)	Registers a resource according to the specified RegistrationBehavior.
<R> String	registerResource(Class<R> clzResource, String sResourceName, R resource)	Registers the resource with the specified name for later retrieval with ResourceResolver.getResource(Class, String).
<R> String	registerResource(Class<R> clzResource, R resource)	Registers the resource for later retrieval with ResourceResolver.getResource(Class).
<R> void	unregisterResource(Class<R> clzResource, String sResourceName)	Unregisters the resource that was previously registered of the specified class and name.

Methods inherited from interface com.oracle.coherence.common.base.Disposable

close, dispose

Methods inherited from interface com.tangosol.util.ResourceResolver

getResource, getResource

Field Detail

DEFAULT_NAME

static final String DEFAULT_NAME

The name to use for the registration of a singleton and thus default resource.

See Also:

Constant Field Values

Method Detail

registerResource

<R> String registerResource(Class<R> clzResource,
                            R resource)
                     throws IllegalArgumentException

Registers the resource for later retrieval with ResourceResolver.getResource(Class).

Notes:

1. Multiple resources for the same class can be registered if each resource is registered with a unique name via registerResource(Class, String, Object)
2. Registration of resources will occur in a thread-safe manner.
3. Resources that are Disposable will be disposed when the ResourceRegistry is disposed.

Parameters:

clzResource - the class of the resource

resource - the resource

Returns:

the actual name used to register the resource

Throws:

IllegalArgumentException - if a resource of the same specified type is already registered

registerResource

<R> String registerResource(Class<R> clzResource,
                            String sResourceName,
                            R resource)
                     throws IllegalArgumentException

Registers the resource with the specified name for later retrieval with ResourceResolver.getResource(Class, String).

Notes:

1. Registration of resources will occur in a thread-safe manner.
2. Resources that are Disposable will be disposed when the ResourceRegistry is disposed.

Parameters:

clzResource - the class of the resource

resource - the resource

sResourceName - the proposed name of the resource

Returns:

the actual name used to register the resource

Throws:

IllegalArgumentException - if a resource of the same specified type and name is already registered

registerResource

<R> String registerResource(Class<R> clzResource,
                            Builder<? extends R> bldrResource,
                            RegistrationBehavior behavior,
                            ResourceRegistry.ResourceLifecycleObserver<R> observer)
                     throws IllegalArgumentException

Registers a resource according to the specified RegistrationBehavior. If successful the registered resource may later be retrieved using method ResourceResolver.getResource(Class).

Notes:

1. Multiple resources for the same class can be registered if each resource is registered with a unique name via registerResource(Class, String, Builder, RegistrationBehavior, ResourceLifecycleObserver)
2. Registration of resources will occur in a thread-safe manner.
3. Resources that are Disposable will be disposed when the ResourceRegistry is disposed.

Type Parameters:

R - the type of the resource

Parameters:

clzResource - the class of the resource

bldrResource - the Builder to realize the resource to register (if required the specified behavior requires a resource)

behavior - the RegistrationBehavior to use

observer - an optional ResourceRegistry.ResourceLifecycleObserver that will be called when the resource is being released from the ResourceRegistry (may be null)

Returns:

the actual name used to register the resource

Throws:

IllegalArgumentException - if a resource with the specified class is already registered with the ResourceRegistry and the behavior was RegistrationBehavior.FAIL

registerResource

<R> String registerResource(Class<R> clzResource,
                            String sResourceName,
                            Builder<? extends R> bldrResource,
                            RegistrationBehavior behavior,
                            ResourceRegistry.ResourceLifecycleObserver<R> observer)
                     throws IllegalArgumentException

Registers a resource according to the specified RegistrationBehavior. If successful the registered resource may later be retrieved using method ResourceResolver.getResource(Class, String).

Notes:

1. Registration of resources will occur in a thread-safe manner.
2. Resources that are Disposable will be disposed when the ResourceRegistry is disposed.

Type Parameters:

R - the type of the resource

Parameters:

clzResource - the class of the resource

sResourceName - the proposed name of the resource

bldrResource - the Builder to realize the resource to register (if required the specified behavior requires a resource)

behavior - the RegistrationBehavior to use

observer - an optional ResourceRegistry.ResourceLifecycleObserver that will be called when the resource is being released from the ResourceRegistry (may be null)

Returns:

the actual name used to register the resource

Throws:

IllegalArgumentException - if a resource with the specified class is already registered with the ResourceRegistry and the behavior was RegistrationBehavior.FAIL

unregisterResource

<R> void unregisterResource(Class<R> clzResource,
                            String sResourceName)

Unregisters the resource that was previously registered of the specified class and name.

Note: Unregistering a resource does not cause it to be disposed, but it does call ResourceRegistry.ResourceLifecycleObserver.onRelease(Object) if an observer was provided at the time of registration.

Type Parameters:

R - the type of the resource

Parameters:

clzResource - the class of the resource

sResourceName - the name of the resource