Package dev.getelements.elements.rt

Interface ResourceContext

All Known Implementing Classes:

SimpleResourceContext

public interface ResourceContext

The interface for manipulating Resources in the cluster.

Method Summary

Modifier and Type	Method	Description
default ResourceId	create(String module, Path path, Object... args)	Creates a Resource at the provided Path.
default void	createAsync(Consumer<ResourceId> success, Consumer<Throwable> failure, String module, Path path, Object... args)	Creates a Resource passing the default Attributes obtained from Attributes.emptyAttributes().
default ResourceId	createAttributes(String module, Path path, Attributes attributes, Object... args)	Creates a Resource at the provided Path.
void	createAttributesAsync(Consumer<ResourceId> success, Consumer<Throwable> failure, String module, Path path, Attributes attributes, Object... args)	Creates a Resource asynchronously.
default void	destroy(ResourceId resourceId)	Destroys the Resource with the provided ResourceId.
default void	destroyAllResources()	Performs the operations of destroyAllResourcesAsync(Consumer, Consumer) in a synchronous fashion.
void	destroyAllResourcesAsync(Consumer<Void> success, Consumer<Throwable> failure)	Clears all Resource instances from the system.
void	destroyAsync(Consumer<Void> success, Consumer<Throwable> failure, ResourceId resourceId)	Destroys the Resource with the provided ResourceId.
default void	destroyAsync(Consumer<Void> success, Consumer<Throwable> failure, String resourceIdString)	Destroys the Resource using the ResourceId String.
default Object	invoke(ResourceId resourceId, String method, Object... args)	Synchronous invoke of invokePathAsync(Consumer, Consumer, Path, String, Object...).
void	invokeAsync(Consumer<Object> success, Consumer<Throwable> failure, ResourceId resourceId, String method, Object... args)	Invokes the method on the ResourceId.
default Object	invokePath(Path path, String method, Object... args)	Synchronous invoke of invokePathAsync(Consumer, Consumer, Path, String, Object...).
void	invokePathAsync(Consumer<Object> success, Consumer<Throwable> failure, Path path, String method, Object... args)	Invokes the method on the Resource Path.
default void	start()	Starts this ResourceContext.
default void	stop()	Stops this ResourceContext.

Method Details

start

default void start()

Starts this ResourceContext.

stop

default void stop()

Stops this ResourceContext.

create

default ResourceId create(String module,
 Path path,
 Object... args)

Creates a Resource at the provided Path.

Parameters:

module - the module to instantiate

path - the path

args - the arguments to pass to the module instantiation

Returns:

the system-assigned ResourceId

createAsync

default void createAsync(Consumer<ResourceId> success,
 Consumer<Throwable> failure,
 String module,
 Path path,
 Object... args)

Creates a Resource passing the default Attributes obtained from Attributes.emptyAttributes().

Parameters:

success - the Consumer which will be called if the call succeeds

failure - the Consumer which will be called if the call fails, capturing any failure

module - module name to instantiate

path - the Path for the Resource

args - the arguments to pass to the Resource on initialization

createAttributes

default ResourceId createAttributes(String module,
 Path path,
 Attributes attributes,
 Object... args)

Creates a Resource at the provided Path.

Parameters:

module - the module to instantiate

path - the path

args - the arguments to pass to the module instantiation

Returns:

the system-assigned ResourceId

createAttributesAsync

void createAttributesAsync(Consumer<ResourceId> success,
 Consumer<Throwable> failure,
 String module,
 Path path,
 Attributes attributes,
 Object... args)

Creates a Resource asynchronously. Once created, the Resource can be provided to the supplied Consumer<Resource>.

Parameters:

success - the Consumer which will be called if the call succeeds

failure - the Consumer which will be called if the call fails, capturing any failure

module - module name to instantiate

path - the Path for the Resource

args - the arguments to pass to the Resource on initialization

invoke

default Object invoke(ResourceId resourceId,
 String method,
 Object... args)

Synchronous invoke of invokePathAsync(Consumer, Consumer, Path, String, Object...).

Parameters:

resourceId - the resource's id

method - the method name

args - the argument array

Returns:

the result of the invocation

invokeAsync

void invokeAsync(Consumer<Object> success,
 Consumer<Throwable> failure,
 ResourceId resourceId,
 String method,
 Object... args)

Invokes the method on the ResourceId.

Parameters:

success - called when the operation succeeds

failure - called when the operation fails

resourceId - the resource's id

method - the method

args - the args

invokePath

default Object invokePath(Path path,
 String method,
 Object... args)

Synchronous invoke of invokePathAsync(Consumer, Consumer, Path, String, Object...).

Parameters:

path - the path

method - the method name

args - the argument array

Returns:

the result of the invocation

invokePathAsync

void invokePathAsync(Consumer<Object> success,
 Consumer<Throwable> failure,
 Path path,
 String method,
 Object... args)

Invokes the method on the Resource Path.

Parameters:

success - called when the operation succeeds

failure - called when the operation fails

path - the Path

method - the method

args - the args

destroy

default void destroy(ResourceId resourceId)

Destroys the Resource with the provided ResourceId.

Parameters:

resourceId - the ResourceId

destroyAsync

void destroyAsync(Consumer<Void> success,
 Consumer<Throwable> failure,
 ResourceId resourceId)

Destroys the Resource with the provided ResourceId.

Parameters:

success - called if the operation succeeds

failure - called if the operation fails

resourceId - the ResourceId

destroyAsync

default void destroyAsync(Consumer<Void> success,
 Consumer<Throwable> failure,
 String resourceIdString)

Destroys the Resource using the ResourceId String.

Parameters:

resourceIdString - the ResourceId String.

destroyAllResources

default void destroyAllResources()

Performs the operations of destroyAllResourcesAsync(Consumer, Consumer) in a synchronous fashion.

destroyAllResourcesAsync

void destroyAllResourcesAsync(Consumer<Void> success,
 Consumer<Throwable> failure)

Clears all Resource instances from the system. This is a call that should be used with extreme care as it can possibly destroy the whole system. This is primarily used for testing, or restarting or shutting down handler instances which are intended to be short-lived. This may not exist for all implementations of ResourceContext, and may simply provide an exception indicating so.