Package dev.getelements.elements.rt

Interface IndexContext

All Known Implementing Classes:

SimpleIndexContext

public interface IndexContext

Used to index various Resource instances by Path.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IndexContext.Listing	Represents an association between a Path and the ResourceId to which it points.
static interface	IndexContext.Unlink	The result of the unlinkAsync(Path, Consumer, Consumer) and unlink(Path) call.

Method Summary

Modifier and Type	Method	Description
default void	link(ResourceId resourceId, Path destination)	Performs the operations of linkAsync(ResourceId, Path, Consumer, Consumer) synchronously.
void	linkAsync(ResourceId resourceId, Path destination, Consumer<Void> success, Consumer<Throwable> failure)	Links a single ResourceId to a Path destination.
default void	linkPath(Path source, Path destination)	Performs the operations linkPathAsync(Path, Path, Consumer, Consumer) synchronously.
void	linkPathAsync(Path source, Path destination, Consumer<Void> success, Consumer<Throwable> failure)	Links a single Path to a Path destination.
default List<IndexContext.Listing>	list(Path path)	Performs the operations of listAsync(Path, Consumer, Consumer) synchronously.
void	listAsync(Path path, Consumer<List<IndexContext.Listing>> success, Consumer<Throwable> failure)	Fetches a IndexContext.Listing of all Paths and assocaited ResourceId instances which match the provided Path.
default void	start()	Starts this IndexContext.
default void	stop()	Stops this IndexContext.
default IndexContext.Unlink	unlink(Path path)	Performs the operations of unlinkAsync(Path, Consumer, Consumer) synchronously.
void	unlinkAsync(Path path, Consumer<IndexContext.Unlink> success, Consumer<Throwable> failure)	Unlinks the provided Path and if this is the last Path reference to a ResourceId, then the cluster will remove and destroy the associated Resource.

Method Details

start

default void start()

Starts this IndexContext.

stop

default void stop()

Stops this IndexContext.

list

default List<IndexContext.Listing> list(Path path)

Performs the operations of listAsync(Path, Consumer, Consumer) synchronously.

Parameters:

path - the Path to match

Returns:

a List<IndexContext.Listing> representing all matched Paths

listAsync

void listAsync(Path path,
 Consumer<List<IndexContext.Listing>> success,
 Consumer<Throwable> failure)

Fetches a IndexContext.Listing of all Paths and assocaited ResourceId instances which match the provided Path. Unlike other methods for linking and unlinking, the provided Path may be a wildcard as determined by Path.isWildcard(). The supplied List should represent a complete buffering of all IndexContext.Listing instances matching the Path.

Parameters:

path - the Path to match

success - a Consumer which receives an instance of IndexContext.Listing

failure - a Consumer which receives an exception indicating a failure reason.

link

default void link(ResourceId resourceId,
 Path destination)

Performs the operations of linkAsync(ResourceId, Path, Consumer, Consumer) synchronously.

Parameters:

resourceId - the source ResourceId to link

destination - the Path of the destination to link

linkAsync

void linkAsync(ResourceId resourceId,
 Path destination,
 Consumer<Void> success,
 Consumer<Throwable> failure)

Links a single ResourceId to a Path destination.

Parameters:

resourceId - the source ResourceId to link

destination - the Path of the destination to link

success - a Consumer which will be called on successful completion

failure - a Consumer which will be called on a failure

linkPath

default void linkPath(Path source,
 Path destination)

Performs the operations linkPathAsync(Path, Path, Consumer, Consumer) synchronously.

Parameters:

source - the source Path to link

destination - the Path of the destination to link

linkPathAsync

void linkPathAsync(Path source,
 Path destination,
 Consumer<Void> success,
 Consumer<Throwable> failure)

Links a single Path to a Path destination.

Parameters:

source - the source Path to link

destination - the Path of the destination to link

success - a Consumer which will be called on successful completion

failure - a Consumer which will be called on a failure

unlink

default IndexContext.Unlink unlink(Path path)

Performs the operations of unlinkAsync(Path, Consumer, Consumer) synchronously.

Parameters:

path - the path to unlink

Returns:

an IndexContext.Unlink representing the result of the operation

unlinkAsync

void unlinkAsync(Path path,
 Consumer<IndexContext.Unlink> success,
 Consumer<Throwable> failure)

Unlinks the provided Path and if this is the last Path reference to a ResourceId, then the cluster will remove and destroy the associated Resource. Further details on the operation can be obtained through the IndexContext.Unlink interface. If the result is a complete removal, then this will have the same end result as ResourceContext.destroy(ResourceId) or ResourceContext.destroyAsync(Consumer, Consumer, ResourceId).

Parameters:

path - the path to unlink

success - a Consumer<IndexContext.Unlink> to receive the successful operation

failure - a Consumer<Throwable> to receive an exception if one was generated