net.openhft.chronicle.engine.api.tree

Interface AssetTree

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

VanillaAssetTree

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

A Hierarchical collection of Assets in a tree structure.

Method Summary

Modifier and Type	Method and Description
Asset	acquireAsset(String fullName) Get or create an asset
default <K,V> MapView<K,V,V>	acquireMap(String uri, Class<K> kClass, Class<V> vClass) Acquire a map view for a URI.
default <E> Publisher<E>	acquirePublisher(String uri, Class<E> eClass) Acquire a publisher to a single URI.
default <E> Reference<E>	acquireReference(String uri, Class<E> eClass) Acquire a reference to a single URI
default <S> S	acquireService(String uri, Class<S> serviceType) Acquire a generic service by URI and serviceType.
default <E> Set<E>	acquireSet(String uri, Class<E> eClass) Acquire a set view for a URI.
default Subscription	acquireSubscription(RequestContext requestContext) Acquire the Subscription view for a URI.
default <T,E> TopicPublisher<T,E>	acquireTopicPublisher(String uri, Class<T> topicClass, Class<E> messageClass) Acquire a Topic Publisher view for a URI.
default <E> E	acquireView(RequestContext requestContext) Acquire a generic view by ResourceContext.
default AssetTree	disableManagement() Disable JMX management of this Asset Tree
default AssetTree	enableManagement() Enable JMX management of this Asset Tree
default AssetTree	enableManagement(int port) Enable JMX management of this Asset Tree
Asset	getAsset(String fullName) Get an existing Asset by fullName or return null.
default Subscription	getSubscription(RequestContext requestContext) Get a Subscription view for a URI if ti exists.
default <E> void	registerSubscriber(String uri, Class<E> eClass, Subscriber<E> subscriber) Register a subscriber to a URI with an expected type of message by class.
default <T,E> void	registerTopicSubscriber(String uri, Class<T> topicClass, Class<E> messageClass, TopicSubscriber<T,E> subscriber) Register a topic subscriber to a URI with an expected type of message by topic class and message class
Asset	root() Get the root asset.
default <E> void	unregisterSubscriber(String uri, Subscriber<E> subscriber) Remove a subscription.
default <T,E> void	unregisterTopicSubscriber(String uri, TopicSubscriber<T,E> subscriber) Remove a topic subscription.

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

close, closeQuietly

Method Detail

root

Asset root()

Get the root asset. This is useful for adding global rules for constructing views.

Returns:

the root Asset.

getAsset

@Nullable
Asset getAsset(String fullName)

Get an existing Asset by fullName or return null.

Parameters:

fullName - of the Asset

Returns:

the Asset or null if it doesn't exist.

acquireAsset

@NotNull
Asset acquireAsset(@NotNull
                            String fullName)
                     throws AssetNotFoundException

Get or create an asset

Parameters:

fullName - of the asset to obtain

Returns:

the asset obtained.

Throws:

AssetNotFoundException

acquireSet

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

Acquire a set view for a URI.

Parameters:

uri - to search for

eClass - element class.

Returns:

the Set.

Throws:

AssetNotFoundException - the view could not be constructed.

acquireMap

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

Acquire a map view for a URI.

Parameters:

uri - to search for

kClass - key class of the map.

vClass - value class of the map.

Returns:

the Map.

Throws:

AssetNotFoundException - the view could not be constructed.

acquirePublisher

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

Acquire a publisher to a single URI.

Parameters:

uri - to search for

eClass - element class.

Returns:

the Set.

Throws:

AssetNotFoundException - the view could not be constructed.

acquireReference

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

Acquire a reference to a single URI

Parameters:

uri - to search for

eClass - type of the state referenced

Returns:

a reference to that state.

Throws:

AssetNotFoundException - the view could not be constructed.

acquireTopicPublisher

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

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.

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.

registerSubscriber

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

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.

Parameters:

uri - of the asset to subscribe to.

eClass - 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,E> void registerTopicSubscriber(@NotNull
                                           String uri,
                                           Class<T> topicClass,
                                           Class<E> messageClass,
                                           TopicSubscriber<T,E> subscriber)
                                    throws AssetNotFoundException

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

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.

acquireSubscription

@NotNull
default Subscription acquireSubscription(@NotNull
                                                  RequestContext requestContext)
                                           throws AssetNotFoundException

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
                                      String uri,
                                      Subscriber<E> subscriber)

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

Parameters:

uri - of the asset subscribed to.

subscriber - to remove

unregisterTopicSubscriber

default <T,E> void unregisterTopicSubscriber(@NotNull
                                             String uri,
                                             TopicSubscriber<T,E> subscriber)
                                      throws AssetNotFoundException

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

Parameters:

uri - of the asset subscribed to.

subscriber - to remove

Throws:

AssetNotFoundException

getSubscription

@Nullable
default Subscription getSubscription(@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
                                      String uri,
                                      Class<S> serviceType)
                               throws AssetNotFoundException

Acquire a generic service by URI and serviceType.

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 <E> E acquireView(@NotNull
                                   RequestContext requestContext)
                            throws AssetNotFoundException

Acquire a generic view by ResourceContext.

Parameters:

requestContext - to use to search or create the view.

Returns:

the view obtained

Throws:

AssetNotFoundException - if the view could not be created.

enableManagement

default AssetTree enableManagement()

Enable JMX management of this Asset Tree

enableManagement

default AssetTree enableManagement(int port)

Enable JMX management of this Asset Tree

Parameters:

port - to enable a simple web service on

disableManagement

default AssetTree disableManagement()

Disable JMX management of this Asset Tree