NewtsResourceStorageDao (OpenNMS 2021.1.17 API)

java.lang.Object
- org.opennms.netmgt.dao.support.NewtsResourceStorageDao

All Implemented Interfaces:

ResourceStorageDao
```
public class NewtsResourceStorageDao
extends Object
implements ResourceStorageDao
```
Resource Storage Dao implementation for Newts that leverages the Search API for walking the resource tree. In Newts, samples are associated with metrics, which are in turn associated with resources. Here we split the resource id into two parts: bucket: last element of the resource id resource path: all the elements before the bucket Relating this to .rrd file on disk, the bucket would be the filename, and the resource path would be its folder.

Author:

jwhite

Constructor Summary

Constructors
Constructor and Description

NewtsResourceStorageDao()

Constructors
Constructor and Description
`NewtsResourceStorageDao()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Set<ResourcePath>`	`children(ResourcePath path, int depth)` Retrieves the set of child paths one level bellow the given path which contain one or more metrics at the given depth.
`boolean`	`delete(ResourcePath path)` Deletes all of the resources and metric bellow the given path.
`boolean`	`exists(ResourcePath path, int depth)` Verifies if a path contains one or more metrics at the given depth.
`boolean`	`existsWithin(ResourcePath path, int depth)` Verifies if a path contains one or more metrics within the given depth.
`Set<OnmsAttribute>`	`getAttributes(ResourcePath path)` Retrieves the set of (resource-level) attributes stored at the given path.
`Map<String,String>`	`getMetaData(ResourcePath path)` Retrieves the meta-data stored at the given path.
`String`	`getStringAttribute(ResourcePath path, String key)` Returns the value for the given (resource-level) attribute, or null if it does not exist.
`Map<String,String>`	`getStringAttributes(ResourcePath path)` Returns the value for the given (resource-level) attribute, or null if it does not exist.
`void`	`setContext(org.opennms.newts.api.Context context)`
`void`	`setIndexer(org.opennms.newts.cassandra.search.CassandraIndexer indexer)`
`void`	`setNewtsWriter(NewtsWriter newtsWriter)`
`void`	`setSampleRepository(org.opennms.newts.persistence.cassandra.CassandraSampleRepository sampleRepository)`
`void`	`setSearchableCache(SearchableResourceMetadataCache searchableCache)`
`void`	`setSearcher(org.opennms.newts.cassandra.search.CassandraSearcher searcher)`
`void`	`setStringAttribute(ResourcePath path, String key, String value)` Sets the specified (resource-level) attribute at the given path.
`protected static ResourcePath`	`toChildResourcePath(ResourcePath parent, String resourceId)`
`void`	`updateMetricToResourceMappings(ResourcePath path, Map<String,String> metricsNameToResourceNames)` Maps the given metric names to the their associated resources names.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NewtsResourceStorageDao
```
public NewtsResourceStorageDao()
```
- Method Detail
  - exists
```
public boolean exists(ResourcePath path,
                      int depth)
```
    Description copied from interface: ResourceStorageDao
    Verifies if a path contains one or more metrics at the given depth.
    For example, assume we are working with file-system paths, and we have the following file on disk /a/b/c/some.metric. The function should behave as follows:
    - exists('/a/b/c', 0) -> true
    - exists('/a/b', 1) -> true
    - exists('/a/b', 2) -> false
    Specified by:
    
    exists in interface ResourceStorageDao
    
    Parameters:
    
    path - resource path used as the root of the check
    
    depth - a non-negative integer
    
    Returns:
    
    true if one or more metrics exist, false otherwise
  - existsWithin
```
public boolean existsWithin(ResourcePath path,
                            int depth)
```
    Description copied from interface: ResourceStorageDao
    Verifies if a path contains one or more metrics within the given depth.
    For example, assume we are working with file-system paths, and we have the following file on disk /a/b/c/some.metric. The function should behave as follows:
    - exists('/a/b/c', 0) -> true
    - exists('/a/b', 1) -> true
    - exists('/a/b', 2) -> true
    - exists('/a', 1) -> false
    Specified by:
    
    existsWithin in interface ResourceStorageDao
    
    Parameters:
    
    path - resource path used as the root of the check
    
    depth - a non-negative integer
    
    Returns:
    
    true if one or more metrics exist, false otherwise
  - children
```
public Set<ResourcePath> children(ResourcePath path,
                                  int depth)
```
    Description copied from interface: ResourceStorageDao
    Retrieves the set of child paths one level bellow the given path which contain one or more metrics at the given depth.
    For example, assume we are working with file-system paths, and we have the following file on disk /a/b/c/some.metric. The function should behave as follows:
    - children('/a/b', 1) -> {'/a/b/c'}
    - children('/a/b', 2) -> {}
    - children('/a', 2) -> {'b'}
    Specified by:
    
    children in interface ResourceStorageDao
    
    Parameters:
    
    path - resource path used as the root of the check
    
    depth - a positive integer
    
    Returns:
    
    the set of child paths containing metrics
  - delete
```
public boolean delete(ResourcePath path)
```
    Description copied from interface: ResourceStorageDao
    
    Deletes all of the resources and metric bellow the given path. Returns true if the operation succeeded.
    
    Specified by:
    
    delete in interface ResourceStorageDao
  - getAttributes
```
public Set<OnmsAttribute> getAttributes(ResourcePath path)
```
    Description copied from interface: ResourceStorageDao
    
    Retrieves the set of (resource-level) attributes stored at the given path.
    
    Specified by:
    
    getAttributes in interface ResourceStorageDao
  - setStringAttribute
```
public void setStringAttribute(ResourcePath path,
                               String key,
                               String value)
```
    Description copied from interface: ResourceStorageDao
    
    Sets the specified (resource-level) attribute at the given path.
    
    Specified by:
    
    setStringAttribute in interface ResourceStorageDao
  - getStringAttribute
```
public String getStringAttribute(ResourcePath path,
                                 String key)
```
    Description copied from interface: ResourceStorageDao
    
    Returns the value for the given (resource-level) attribute, or null if it does not exist.
    
    Specified by:
    
    getStringAttribute in interface ResourceStorageDao
  - getStringAttributes
```
public Map<String,String> getStringAttributes(ResourcePath path)
```
    Description copied from interface: ResourceStorageDao
    
    Returns the value for the given (resource-level) attribute, or null if it does not exist.
    
    Specified by:
    
    getStringAttributes in interface ResourceStorageDao
  - getMetaData
```
public Map<String,String> getMetaData(ResourcePath path)
```
    Description copied from interface: ResourceStorageDao
    
    Retrieves the meta-data stored at the given path.
    
    Specified by:
    
    getMetaData in interface ResourceStorageDao
  - updateMetricToResourceMappings
```
public void updateMetricToResourceMappings(ResourcePath path,
                                           Map<String,String> metricsNameToResourceNames)
```
    Description copied from interface: ResourceStorageDao
    
    Maps the given metric names to the their associated resources names. The resource names are relative to the given path. When persisting to .rrd of .jrb files with storeByGroup enabled, this is used to map the data sources names (metrics) to associated .rrd files (resource names). Other strategies that can infer this information at runtime may chose to ignore calls to this method.
    
    Specified by:
    
    updateMetricToResourceMappings in interface ResourceStorageDao
    
    Parameters:
    
    path - parent resource path
    
    metricsNameToResourceNames - metric to resource mappings
  - toChildResourcePath
```
protected static ResourcePath toChildResourcePath(ResourcePath parent,
                                                  String resourceId)
```
  - setSearchableCache
```
public void setSearchableCache(SearchableResourceMetadataCache searchableCache)
```
  - setSearcher
```
public void setSearcher(org.opennms.newts.cassandra.search.CassandraSearcher searcher)
```
  - setContext
```
public void setContext(org.opennms.newts.api.Context context)
```
  - setNewtsWriter
```
public void setNewtsWriter(NewtsWriter newtsWriter)
```
  - setIndexer
```
public void setIndexer(org.opennms.newts.cassandra.search.CassandraIndexer indexer)
```
  - setSampleRepository
```
public void setSampleRepository(org.opennms.newts.persistence.cassandra.CassandraSampleRepository sampleRepository)
```

Class NewtsResourceStorageDao

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NewtsResourceStorageDao

Method Detail

exists

existsWithin

children

delete

getAttributes

setStringAttribute

getStringAttribute

getStringAttributes

getMetaData

updateMetricToResourceMappings

toChildResourcePath

setSearchableCache

setSearcher

setContext

setNewtsWriter

setIndexer

setSampleRepository