Class AbstractDAO<K, T>

An abstract data access layer API, meant to (somewhat) mirror the DAO interfaces inside OpenNMS. Used to retrieve model data like alarms, events, etc. from the OpenNMS ReST API in a consistent way.

Type parameters

K

the ID/key type (number, string, etc.)
T

the model type (OnmsAlarm, OnmsEvent, etc.)

Hierarchy

AbstractDAO

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new AbstractDAO(impl: IOnmsHTTP | IHasHTTP): AbstractDAO

- Defined in dao/AbstractDAO.ts:42
Construct a DAO instance.

Parameters
- impl: IOnmsHTTP | IHasHTTP
  
  The HTTP implementation to use. It is also legal to pass any object conforming to the IHasHTTP interface (like a Client).
Returns AbstractDAO

Accessors

filterProcessor

get filterProcessor(): IFilterProcessor
set filterProcessor(impl: IFilterProcessor): void

- Defined in dao/AbstractDAO.ts:68
Returns IFilterProcessor
- Defined in dao/AbstractDAO.ts:81
Parameters
- impl: IFilterProcessor
Returns void

http

get http(): IOnmsHTTP
set http(impl: IOnmsHTTP): void

- Defined in dao/AbstractDAO.ts:60
The HTTP implementation to use internally when making DAO requests.

Returns IOnmsHTTP
- Defined in dao/AbstractDAO.ts:64
The HTTP implementation to use internally when making DAO requests.

Parameters
- impl: IOnmsHTTP
Returns void

Methods

find

find(filter?: Filter): Promise<T[]>

- Defined in dao/AbstractDAO.ts:95
Find all model objects given an optional filter.

Parameters
- Optional filter: Filter
  
  the filter to use when retrieving a list of model objects
Returns Promise<T[]>

get

get(id: K): Promise<T>

- Defined in dao/AbstractDAO.ts:89
Retrieve a model object.

Parameters
- id: K
  
  the ID of the object
Returns Promise<T>

Protected getApiVersion

getApiVersion(): number

- Defined in dao/AbstractDAO.ts:150
Retrieve the API version from the currently configured server.

Returns number

Protected getCount

getCount(data: any): number

- Defined in dao/AbstractDAO.ts:101
A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.

Parameters
- data: any
Returns number

Protected getOptions

getOptions(filter?: Filter): OnmsHTTPOptions

- Defined in dao/AbstractDAO.ts:119
Create an OnmsHTTPOptions object for DAO calls given an optional filter.

Parameters
- Optional filter: Filter
  
  the filter to use
Returns OnmsHTTPOptions

Protected toDate

toDate(from: any): Moment | undefined

- Defined in dao/AbstractDAO.ts:132
Convert the given value to a date, or undefined if it cannot be converted.

Parameters
- from: any
Returns Moment | undefined

Protected toNumber

toNumber(from: any): number | undefined

- Defined in dao/AbstractDAO.ts:142
Convert the given value to a number, or undefined if it cannot be converted.

Parameters
- from: any
Returns number | undefined

Generated using TypeDoc