software.chronicle.datagrid.tree

Interface AssetTree

All Superinterfaces:

AutoCloseable, Closeable, net.openhft.chronicle.core.io.QueryCloseable

All Known Implementing Classes:

VanillaAssetTree

public interface AssetTree
extends net.openhft.chronicle.core.io.Closeable

A Hierarchical collection of Assets in a tree structure.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AssetTree.ClientBuilder

Method Summary

Modifier and Type	Method and Description
default <K,V> @NotNull MapView<K,V>	acquireMap(@NotNull String uri, Class<K> kClass, Class<V> vClass) Acquire a map view for a URI.
default <E> @NotNull Publisher<E>	acquirePublisher(@NotNull String uri, Class<E> eClass) Acquire a publisher to a single URI.
default <T,M> @NotNull QueueView<T,M>	acquireQueue(@NotNull String uri, Class<T> typeClass, Class<M> messageClass)
default <T,M> @NotNull QueueView<T,M>	acquireQueue(@NotNull String uri, Class<T> typeClass, Class<M> messageClass, String cluster)
default <T,M> @NotNull QueueView<T,M>	acquireQueue(@NotNull String uri, Class<T> typeClass, Class<M> messageClass, String cluster, String basePath)
default <E> @NotNull Reference<E>	acquireReference(@NotNull String uri, Class<E> eClass) Acquire a reference to a single URI
default <S> S	acquireService(@NotNull String uri, Class<S> serviceType) Acquire a generic service by URI and serviceType.
default <E> @NotNull Set<E>	acquireSet(@NotNull String uri, Class<E> eClass) Acquire a set view for a URI.
default @NotNull SubscriptionCollection	acquireSubscription(@NotNull RequestContext requestContext) Acquire the Subscription view for a URI.
default <T,M> @NotNull TopicPublisher<T,M>	acquireTopicPublisher(@NotNull String uri, Class<T> topicClass, Class<M> messageClass) Acquire a Topic Publisher view for a URI.
default <T,M> @NotNull TopicPublisher<T,M>	acquireTopicPublisher(@NotNull String uri, String basePath, Class<T> topicClass, Class<M> messageClass) Acquire a Topic Publisher view for a URI.
default <V> V	acquireView(@NotNull RequestContext requestContext) Acquire a generic view by ResourceContext.
static @NotNull AssetTree.ClientBuilder	clientBuilder() Creates and returns a new AssetTreeBuilder that can build a server AssetTree.
default @NotNull AssetTree	disableManagement() Disable JMX management of this Asset Tree
default @NotNull AssetTree	enableManagement() Enable JMX management of this Asset Tree
default @NotNull AssetTree	enableManagement(int port) Enable JMX management of this Asset Tree
default @Nullable SubscriptionCollection	getSubscription(@NotNull RequestContext requestContext) Get a Subscription view for a URI if ti exists.
default <E> void	registerSubscriber(@NotNull String uri, Class<E> eClass, @NotNull Subscriber<? extends E> subscriber) Register a subscriber to a URI with an expected type of message by class.
default <E> void	registerSubscriber(@NotNull String uri, String basePath, Class<E> eClass, @NotNull Subscriber<? super E> subscriber) Register a subscriber to a URI with an expected type of message by class.
default <T,M> void	registerTopicSubscriber(@NotNull String uri, Class<T> topicClass, Class<M> messageClass, @NotNull TopicSubscriber<? extends T,? extends M> subscriber) Register a topic subscriber to a URI with an expected type of message by topic class and message class
default <T,M> void	registerTopicSubscriber(@NotNull String uri, @NotNull File baseFile, Class<T> topicClass, Class<M> messageClass, @NotNull TopicSubscriber<? extends T,? extends M> subscriber) Register a topic subscriber to a URI with an expected type of message by topic class and message class
default <T,M> void	registerTopicSubscriber(@NotNull String uri, String basePath, Class<T> topicClass, Class<M> messageClass, @NotNull TopicSubscriber<? extends T,? extends M> subscriber) Register a topic subscriber to a URI with an expected type of message by topic class and message class
@NotNull Asset	root() Returns the root asset.
default <E> void	unregisterSubscriber(@NotNull String uri, @NotNull Subscriber<? extends E> subscriber) Remove a subscription.
default <T,M> void	unregisterTopicSubscriber(@NotNull String uri, @NotNull TopicSubscriber<? extends T,? extends M> subscriber) Remove a topic subscription.
@NotNull AssetTreeStats	usageStats()

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

close, closeQuietly, closeQuietly

Methods inherited from interface net.openhft.chronicle.core.io.QueryCloseable

isClosed, isClosing

Method Detail

root

@NotNull
@NotNull Asset root()

Returns the root asset.

This gives an entry point to the entire asset Tress. This is useful for adding global rules for constructing views.

Returns:

the root Asset.

acquireSet

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

Acquire a set view for a URI.

Type Parameters:

E - element type

Parameters:

uri - to search for

eClass - element class.

Returns:

the Set.

Throws:

AssetNotFoundException - the view could not be constructed.

acquireMap

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

Acquire a map view for a URI.

Type Parameters:

K - key type of the map

V - value type of the map

Parameters:

uri - to search for

kClass - key class of the map.

vClass - value class of the map.

Returns:

the Map.

Throws:

AssetNotFoundException - if the view could not be constructed.

acquirePublisher

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

Acquire a publisher to a single URI.

Type Parameters:

E - element type

Parameters:

uri - to search for

eClass - element class.

Returns:

the Set

Throws:

AssetNotFoundException - the view could not be constructed.

acquireReference

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

Acquire a reference to a single URI

Type Parameters:

E - type of the state referenced

Parameters:

uri - to search for

eClass - class of the state referenced

Returns:

a reference to that state.

Throws:

AssetNotFoundException - the view could not be constructed.

acquireTopicPublisher

@NotNull
default <T,M> @NotNull TopicPublisher<T,M> acquireTopicPublisher(@NotNull
                                                                          @NotNull String uri,
                                                                          Class<T> topicClass,
                                                                          Class<M> messageClass)

Acquire a Topic Publisher view for a URI. A Topic Publisher can publish to any topic in a group by passing the topic as an additional argument.

Type Parameters:

T - topic type

M - message type

Parameters:

uri - to search for

topicClass - class of topic descriptions e.g. String.class.

messageClass - class of messages to send on that topic.

Returns:

the TopicPublisher

Throws:

AssetNotFoundException - the view could not be constructed.

acquireTopicPublisher

@NotNull
default <T,M> @NotNull TopicPublisher<T,M> acquireTopicPublisher(@NotNull
                                                                          @NotNull String uri,
                                                                          String basePath,
                                                                          Class<T> topicClass,
                                                                          Class<M> messageClass)

Acquire a Topic Publisher view for a URI. A Topic Publisher can publish to any topic in a group by passing the topic as an additional argument.

Type Parameters:

T - topic type

M - message type

Parameters:

uri - to search for

basePath - the location the topic is pushed to on the file system

topicClass - class of topic descriptions e.g. String.class.

messageClass - class of messages to send on that topic.

Returns:

the TopicPublisher

Throws:

AssetNotFoundException - the view could not be constructed.

registerSubscriber

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

Register a subscriber to a URI with an expected type of message by class.

E.g. if you subscribe to a type of String.class you get the keys which changed, if you subscribe to MapEvent.class you get all the changes to the map.

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Type Parameters:

E - the type of event/message to subscribe to

Parameters:

uri - of the asset to subscribe to.

eClass - the class of event/message to subscribe to

subscriber - to notify which this type of message is sent.

Throws:

AssetNotFoundException - the view could not be constructed.

registerSubscriber

default <E> void registerSubscriber(@NotNull
                                    @NotNull String uri,
                                    String basePath,
                                    Class<E> eClass,
                                    @NotNull
                                    @NotNull Subscriber<? super E> subscriber)

Register a subscriber to a URI with an expected type of message by class.

E.g. if you subscribe to a type of String.class you get the keys which changed, if you subscribe to MapEvent.class you get all the changes to the map.

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Type Parameters:

E - the type of event/message to subscribe to

Parameters:

uri - of the asset to subscribe to.

basePath - the location the topic is pushed to on the file system

eClass - the class of event/message to subscribe to

subscriber - to notify which this type of message is sent.

Throws:

AssetNotFoundException - the view could not be constructed.

registerTopicSubscriber

default <T,M> void registerTopicSubscriber(@NotNull
                                           @NotNull String uri,
                                           Class<T> topicClass,
                                           Class<M> messageClass,
                                           @NotNull
                                           @NotNull TopicSubscriber<? extends T,? extends M> subscriber)

Register a topic subscriber to a URI with an expected type of message by topic class and message class

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Type Parameters:

T - topic type

M - message type

Parameters:

uri - of the asset to subscribe to.

topicClass - the type of topic to subscribe to

messageClass - the type of event/message to subscribe to

subscriber - to notify which this type of message is sent.

Throws:

AssetNotFoundException - the view could not be constructed.

registerTopicSubscriber

default <T,M> void registerTopicSubscriber(@NotNull
                                           @NotNull String uri,
                                           String basePath,
                                           Class<T> topicClass,
                                           Class<M> messageClass,
                                           @NotNull
                                           @NotNull TopicSubscriber<? extends T,? extends M> subscriber)

Register a topic subscriber to a URI with an expected type of message by topic class and message class

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Type Parameters:

T - topic type

M - message type

Parameters:

uri - of the asset to subscribe to.

basePath - the path the asset is stored to

topicClass - the type of topic to subscribe to

messageClass - the type of event/message to subscribe to

subscriber - to notify which this type of message is sent.

Throws:

AssetNotFoundException - the view could not be constructed.

registerTopicSubscriber

default <T,M> void registerTopicSubscriber(@NotNull
                                           @NotNull String uri,
                                           @NotNull
                                           @NotNull File baseFile,
                                           Class<T> topicClass,
                                           Class<M> messageClass,
                                           @NotNull
                                           @NotNull TopicSubscriber<? extends T,? extends M> subscriber)

Register a topic subscriber to a URI with an expected type of message by topic class and message class

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Type Parameters:

T - topic type

M - message type

Parameters:

uri - of the asset to subscribe to.

baseFile - the path the asset is stored to

topicClass - the type of topic to subscribe to

messageClass - the type of event/message to subscribe to

subscriber - to notify which this type of message is sent.

Throws:

AssetNotFoundException - the view could not be constructed.

acquireSubscription

@NotNull
default @NotNull SubscriptionCollection acquireSubscription(@NotNull
                                                                     @NotNull RequestContext requestContext)

Acquire the Subscription view for a URI.

Parameters:

requestContext - to find the subscription

Returns:

the Subscription

Throws:

AssetNotFoundException - the view could not be constructed.

unregisterSubscriber

default <E> void unregisterSubscriber(@NotNull
                                      @NotNull String uri,
                                      @NotNull
                                      @NotNull Subscriber<? extends E> subscriber)

Remove a subscription. The alternative is for the Subscription to throw an IllegalSubscriberException.

This method is asynchronous and the provided subscriber will be prevented from receiving events as some later unspecified time.

Type Parameters:

E - element type

Parameters:

uri - of the asset subscribed to.

subscriber - to remove

unregisterTopicSubscriber

default <T,M> void unregisterTopicSubscriber(@NotNull
                                             @NotNull String uri,
                                             @NotNull
                                             @NotNull TopicSubscriber<? extends T,? extends M> subscriber)

Remove a topic subscription. The alternative is for the Subscription to throw an IllegalSubscriberException.

This method is asynchronous and the provided subscriber will be prevented from receiving events as some later unspecified time.

Type Parameters:

T - topic type

M - message type

Parameters:

uri - of the asset subscribed to.

subscriber - to remove

Throws:

AssetNotFoundException - the asset could not be found

getSubscription

@Nullable
default @Nullable SubscriptionCollection getSubscription(@NotNull
                                                                   @NotNull RequestContext requestContext)

Get a Subscription view for a URI if ti exists. This is useful for unsubscribing.

Parameters:

requestContext - to find the subscription

Returns:

the Subscription

Throws:

AssetNotFoundException - the view could not be constructed.

acquireService

@NotNull
default <S> S acquireService(@NotNull
                                      @NotNull String uri,
                                      Class<S> serviceType)

Acquire a generic service by URI and serviceType.

Type Parameters:

S - service type

Parameters:

uri - to search for

serviceType - type of the service

Returns:

the Service

Throws:

AssetNotFoundException - if not found, and could not be created.

acquireView

@NotNull
default <V> V acquireView(@NotNull
                                   @NotNull RequestContext requestContext)

Acquire a generic view by ResourceContext.

Type Parameters:

V - view type

Parameters:

requestContext - to use to search or create the view.

Returns:

the view obtained

Throws:

AssetNotFoundException - if the view could not be created.

enableManagement

@NotNull
default @NotNull AssetTree enableManagement()

Enable JMX management of this Asset Tree

Returns:

this AssetTree

enableManagement

@NotNull
default @NotNull AssetTree enableManagement(int port)

Enable JMX management of this Asset Tree

Parameters:

port - to enable a simple web service on

Returns:

this AssetTree

disableManagement

@NotNull
default @NotNull AssetTree disableManagement()

Disable JMX management of this Asset Tree

Returns:

this AssetTree

usageStats

@NotNull
@NotNull AssetTreeStats usageStats()

acquireQueue

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

acquireQueue

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

acquireQueue

@NotNull
default <T,M> @NotNull QueueView<T,M> acquireQueue(@NotNull
                                                            @NotNull String uri,
                                                            Class<T> typeClass,
                                                            Class<M> messageClass,
                                                            String cluster,
                                                            String basePath)

clientBuilder

@NotNull
static @NotNull AssetTree.ClientBuilder clientBuilder()

Creates and returns a new AssetTreeBuilder that can build a server AssetTree.

Returns:

a new AssetTreeBuilder that can build a server AssetTree