software.chronicle.datagrid.internal.testsupport

Class Chassis

java.lang.Object

software.chronicle.datagrid.internal.testsupport.Chassis

public final class Chassis
extends Object

This class is the starting point for a simple client or server configuration. It defines how to obtain some common resource types.

If you need a more complex environment or tests case you can create one or more AssetTrees directly.

Method Summary

Modifier and Type	Method and Description
static Asset	acquireAsset(@NotNull String name) Get or create an empty asset
static <K,V> @NotNull MapView<K,V>	acquireMap(@NotNull String uri, Class<K> kClass, Class<V> vClass) Get or create a Map, ConcurrentMap or MapView of an asset.
static <E> @NotNull Publisher<E>	acquirePublisher(@NotNull String uri, Class<E> eClass) Get or create a Publisher view for a given element or update type.
static <T,M> @NotNull QueueView<T,M>	acquireQueue(@NotNull String uri, Class<T> typeClass, Class<M> messageClass)
static <E> @NotNull Reference<E>	acquireReference(@NotNull String uri, Class<E> eClass) Obtain a reference to an element or value of Map.
static <E> @NotNull Set<E>	acquireSet(@NotNull String uri, Class<E> eClass) View an asset as a set.
static <T,M> @NotNull TopicPublisher<T,M>	acquireTopicPublisher(@NotNull String uri, Class<T> tClass, Class<M> mClass) Get or create a TopicPublisher.
static AssetTree	assetTree()
static void	close() Shutdown everything in the asset tree.
static @NotNull Optional<Asset>	getAsset(String uri) Get an existing Asset or return null
static <E> void	registerSubscriber(@NotNull String uri, Class<E> eClass, @NotNull Subscriber<? extends E> subscriber) Register a Subscriber to events on an Asset.
static <T,M> void	registerTopicSubscriber(@NotNull String uri, Class<T> tClass, Class<M> mClass, @NotNull TopicSubscriber<? extends T,? extends M> subscriber) Register a Topic Subscription to a group.
static void	resetChassis() Replace the underlying
static <E> void	unregisterSubscriber(@NotNull String uri, @NotNull Subscriber<E> subscriber) Unregister a subscriber.
static <T,M> void	unregisterTopicSubscriber(@NotNull String uri, @NotNull TopicSubscriber<T,M> subscriber) Unregister a TopicSubscriber.

Methods inherited from class java.lang.Object

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

Method Detail

resetChassis

public static void resetChassis()

Replace the underlying

assetTree

public static AssetTree assetTree()

Returns:

Obtain the current AssetTree used by default.

acquireSet

@NotNull
public static <E> @NotNull Set<E> acquireSet(@NotNull
                                                      @NotNull String uri,
                                                      Class<E> eClass)

View an asset as a set.

Type Parameters:

E - element type

Parameters:

uri - of the set

eClass - of the elements of the set

Returns:

the set view.

Throws:

AssetNotFoundException - if not found or could not be created.

acquireMap

@NotNull
public static <K,V> @NotNull MapView<K,V> acquireMap(@NotNull
                                                              @NotNull String uri,
                                                              Class<K> kClass,
                                                              Class<V> vClass)

Get or create a Map, ConcurrentMap or MapView of an asset.

Type Parameters:

K - key type

V - value type

Parameters:

uri - of the Map.

kClass - key class

vClass - value class

Returns:

the Map

Throws:

AssetNotFoundException - if not found or could not be created.

acquireReference

@NotNull
public static <E> @NotNull Reference<E> acquireReference(@NotNull
                                                                  @NotNull String uri,
                                                                  Class<E> eClass)

Obtain a reference to an element or value of Map. Once this has been obtained you can perform a number of operation on this specific value would looking it up again.

Type Parameters:

E - element type

Parameters:

uri - of the resource

eClass - the type of the element

Returns:

a view to a resource.

Throws:

AssetNotFoundException - if not found or could not be created.

acquirePublisher

@NotNull
public static <E> @NotNull Publisher<E> acquirePublisher(@NotNull
                                                                  @NotNull String uri,
                                                                  Class<E> eClass)

Get or create a Publisher view for a given element or update type.

Type Parameters:

E - element type

Parameters:

uri - to publish to.

eClass - of the data to publish

Returns:

a Publisher for this uri

Throws:

AssetNotFoundException - if not found or could not be created.

acquireQueue

@NotNull
public static <T,M> @NotNull QueueView<T,M> acquireQueue(@NotNull
                                                                  @NotNull String uri,
                                                                  Class<T> typeClass,
                                                                  Class<M> messageClass)

acquireTopicPublisher

@NotNull
public static <T,M> @NotNull TopicPublisher<T,M> acquireTopicPublisher(@NotNull
                                                                                @NotNull String uri,
                                                                                Class<T> tClass,
                                                                                Class<M> mClass)

Get or create a TopicPublisher. A Topic Publisher can specify the topic to publish to.

Type Parameters:

T - topic type

M - message type

Parameters:

uri - of the group to publish to. When you specify a topic, in will be immediately under that group.

tClass - class of the topic. Typically String.class

mClass - class of the messages to publish on that topic.

Returns:

a TopicPublisher for the group uri.

Throws:

AssetNotFoundException - if not found or could not be created.

registerSubscriber

public static <E> void registerSubscriber(@NotNull
                                          @NotNull String uri,
                                          Class<E> eClass,
                                          @NotNull
                                          @NotNull Subscriber<? extends E> subscriber)

Register a Subscriber to events on an Asset. The rule of the AssetTree might allow different behaviour depending on the eClass subscribed to. e.g. if you subscribe to MapEvent you may get MapEvent updates, however, if you subscribe to the key type you may get just the keys which changed.

Type Parameters:

E - element type

Parameters:

uri - of the asset to subscribe to event for.

eClass - of the subscription

subscriber - to listen to events.

Throws:

AssetNotFoundException - if not found or could not be created.

unregisterSubscriber

public static <E> void unregisterSubscriber(@NotNull
                                            @NotNull String uri,
                                            @NotNull
                                            @NotNull Subscriber<E> subscriber)

Unregister a subscriber. Note: the subscriber must be equals() to the subscriber registered otherwise this will silently fail. e.g. two lambdas which capture the same object are never equals()

Type Parameters:

E - element type

Parameters:

uri - of the asset to unsubscribe from.

subscriber - to unregister

registerTopicSubscriber

public static <T,M> void registerTopicSubscriber(@NotNull
                                                 @NotNull String uri,
                                                 Class<T> tClass,
                                                 Class<M> mClass,
                                                 @NotNull
                                                 @NotNull TopicSubscriber<? extends T,? extends M> subscriber)

Register a Topic Subscription to a group. This subscriber will be give the topic and the message for each event.

Type Parameters:

T - topic type

M - message type

Parameters:

uri - of the group of Assets to listen to.

tClass - topic class

mClass - element class for messages.

subscriber - to listen to events on

Throws:

AssetNotFoundException - if not found or could not be created.

unregisterTopicSubscriber

public static <T,M> void unregisterTopicSubscriber(@NotNull
                                                   @NotNull String uri,
                                                   @NotNull
                                                   @NotNull TopicSubscriber<T,M> subscriber)

Unregister a TopicSubscriber. Note: the subscriber must be equals() to the subscriber registered otherwise this will silently fail. e.g. two lambdas which capture the same object are never equals()

Type Parameters:

T - topic type

M - message type

Parameters:

uri - of the group of Assets to unregister from

subscriber - to remove.

acquireAsset

public static Asset acquireAsset(@NotNull
                                 @NotNull String name)

Get or create an empty asset

Parameters:

name - of the asset

Returns:

the Asset

Throws:

AssetNotFoundException - if not found or could not be created.

getAsset

@NotNull
public static @NotNull Optional<Asset> getAsset(String uri)

Get an existing Asset or return null

Parameters:

uri - of the asset

Returns:

the Asset or null if not found

close

public static void close()

Shutdown everything in the asset tree.