org.hawkular.inventory.base

Class BaseInventory<E>

java.lang.Object

org.hawkular.inventory.base.BaseInventory<E>

Type Parameters:

E - the type of the backend-specific class representing entities and relationships.

All Implemented Interfaces:

AutoCloseable, Inventory

public abstract class BaseInventory<E>
extends Object
implements Inventory

An implementation of the Inventory that converts the API traversals into trees of filters that it then passes for evaluation to a backend.

This class is meant to be inherited by the implementation that should provide the initialization and cleanup logic.

Since:

0.1.0

Author:

Lukas Krejci

Field Summary

Fields

Modifier and Type	Field and Description
static Configuration.Property	TRANSACTION_RETRIES

Constructor Summary

Constructors

Constructor and Description
BaseInventory()

Method Summary

Modifier and Type	Method and Description
void	close()
protected abstract InventoryBackend<E>	doInitialize(Configuration configuration) This method is called during initialize(Configuration) and provides the instance of the backend initialized from the configuration.
InventoryBackend<E>	getBackend() WARNING: This is not meant for general consumption but primarily for testing purposes.
boolean	hasObservers(Interest<?,?> interest) This method is mainly useful for testing.
void	initialize(Configuration configuration) Initializes the inventory from the provided configuration object.
<C,V> rx.Observable<C>	observable(Interest<C,V> interest) NOTE: The subscribers will receive the notifications even after they failed.
Relationships.Read	relationships() Global access to all relationships.
Tenants.ReadWrite	tenants() Entry point into the inventory.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hawkular.inventory.api.Inventory

inspect, inspect, inspect, inspect, inspect, inspect, inspect, inspect, inspect, inspect

Field Detail

TRANSACTION_RETRIES

public static final Configuration.Property TRANSACTION_RETRIES

Constructor Detail

BaseInventory

public BaseInventory()

Method Detail

initialize

public final void initialize(Configuration configuration)

Description copied from interface: Inventory

Initializes the inventory from the provided configuration object.

Specified by:

initialize in interface Inventory

Parameters:

configuration - the configuration to use.

doInitialize

protected abstract InventoryBackend<E> doInitialize(Configuration configuration)

This method is called during initialize(Configuration) and provides the instance of the backend initialized from the configuration.

Parameters:

configuration - the configuration provided by the user

Returns:

a backend implementation that will be used to access the backend store of the inventory

close

public final void close()
                 throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

tenants

public Tenants.ReadWrite tenants()

Description copied from interface: Inventory

Entry point into the inventory. Select one (ResolvingToSingle.get(Object)) or more (ResolvingToMultiple.getAll(org.hawkular.inventory.api.filters.Filter...)) tenants and navigate further to the entities of interest.

Specified by:

tenants in interface Inventory

Returns:

full CRUD and navigation interface to tenants

relationships

public Relationships.Read relationships()

Description copied from interface: Inventory

Global access to all relationships. Use this with caution as it may result in scanning across the potentially very large number of relationships present in the inventory.

To create relationships, first navigate to one of its endpoint entities and create it from there using the API calls.

Specified by:

relationships in interface Inventory

Returns:

the read access to relationships.

getBackend

public InventoryBackend<E> getBackend()

WARNING: This is not meant for general consumption but primarily for testing purposes. You can render the inventory inconsistent and/or unusable with unwise modifications done directly through the backend.

Returns:

the backend this inventory is using for persistence and querying.

hasObservers

public boolean hasObservers(Interest<?,?> interest)

Description copied from interface: Inventory

This method is mainly useful for testing.

Specified by:

hasObservers in interface Inventory

Parameters:

interest - the interest in changes of some inventory entity type

Returns:

true if the interest has some observers or not

observable

public <C,V> rx.Observable<C> observable(Interest<C,V> interest)

Description copied from interface: Inventory

NOTE: The subscribers will receive the notifications even after they failed. I.e. it is the subscribers responsibility to unsubscribe on error

Specified by:

observable in interface Inventory

Type Parameters:

C - the type of object that will be passed to the subscribers of the returned observable

V - the type of the entity the interest is expressed on

Parameters:

interest - the interest in changes of some inventory entity type

Returns:

an observable to which the caller can subscribe to receive notifications about inventory mutation