Class AlarmDAO

Data access for OnmsAlarm objects.

Hierarchy

AbstractDAO<number, Model.OnmsAlarm>
- AlarmDAO

Constructors

constructor

new AlarmDAO(impl: API.IOnmsHTTP | API.IHasHTTP): DAO.AlarmDAO
Parameters
- impl: API.IOnmsHTTP | API.IHasHTTP
Returns DAO.AlarmDAO
Overrides AbstractDAO<number, OnmsAlarm>.constructor
- Defined in src/dao/AlarmDAO.ts:35

Accessors

http

get http(): API.IOnmsHTTP
The HTTP implementation to use internally when making DAO requests.

Returns API.IOnmsHTTP
Inherited from AbstractDAO.http
- Defined in src/dao/BaseDAO.ts:56
set http(impl: API.IOnmsHTTP): void
Parameters
- impl: API.IOnmsHTTP
Returns void
Inherited from AbstractDAO.http
- Defined in src/dao/BaseDAO.ts:61

server

get server(): API.OnmsServer
The OnmsServer being connected to by this DAO.

Returns API.OnmsServer
Inherited from AbstractDAO.server
- Defined in src/dao/BaseDAO.ts:68
set server(s: API.OnmsServer): void
Parameters
- s: API.OnmsServer
Returns void
Inherited from AbstractDAO.server
- Defined in src/dao/BaseDAO.ts:76

Methods

acknowledge

acknowledge(alarm: number | Model.OnmsAlarm, user?: string): Promise<void>
Acknowledge an alarm.

Version
ReST v1+
Parameters
- alarm: number | Model.OnmsAlarm
- Optional user: string
  
  The user to ack the alarm as. (Only administrators have the right to do this.)
Returns Promise<void>
- Defined in src/dao/AlarmDAO.ts:123

clear

clear(alarm: number | Model.OnmsAlarm): Promise<void>
Clear an alarm.

Version
ReST v1+
Parameters
- alarm: number | Model.OnmsAlarm
  
  The OnmsAlarm or alarm ID.
Returns Promise<void>
- Defined in src/dao/AlarmDAO.ts:168

closeTicket

closeTicket(alarm: number | Model.OnmsAlarm): Promise<void>
Close the ticket associated with the given alarm.

Version
ReST v2
Parameters
- alarm: number | Model.OnmsAlarm
  
  The OnmsAlarm or alarm ID.
Returns Promise<void>
- Defined in src/dao/AlarmDAO.ts:247

createTicket

createTicket(alarm: number | Model.OnmsAlarm): Promise<void>
Create a trouble ticket for the specified alarm.

Version
ReST v2
Parameters
- alarm: number | Model.OnmsAlarm
  
  The OnmsAlarm or alarm ID.
Returns Promise<void>
- Defined in src/dao/AlarmDAO.ts:209

deleteJournalMemo

deleteJournalMemo(alarm: number | Model.OnmsAlarm): Promise<void>
Delete the journal memo ticket associated with the given alarm.

Version
ReST v2
Parameters
- alarm: number | Model.OnmsAlarm
  
  The OnmsAlarm or alarm ID.
Returns Promise<void>
- Defined in src/dao/AlarmDAO.ts:302

deleteStickyMemo

deleteStickyMemo(alarm: number | Model.OnmsAlarm): Promise<void>
Delete the sticky memo ticket associated with the given alarm.

Version
ReST v2
Parameters
- alarm: number | Model.OnmsAlarm
  
  The OnmsAlarm or alarm ID.
Returns Promise<void>
- Defined in src/dao/AlarmDAO.ts:292

escalate

escalate(alarm: number | Model.OnmsAlarm): Promise<void>
Escalate an alarm.

Version
ReST v1+
Parameters
- alarm: number | Model.OnmsAlarm
  
  The OnmsAlarm or alarm ID.
Returns Promise<void>
- Defined in src/dao/AlarmDAO.ts:155

find

find(filter?: API.Filter): Promise<Model.OnmsAlarm[]>
Find matching alarms.

Version
ReST v1+

Returns
An array of OnmsAlarm objects.
Parameters
- Optional filter: API.Filter
  
  The filter to use when querying.
Returns Promise<Model.OnmsAlarm[]>
Overrides AbstractDAO.find
- Defined in src/dao/AlarmDAO.ts:66

findValues

findValues(propertyId: string, options?: any): Promise<any>
Finds the values for the given propertyId, if it exists.

Returns
A promise containing the values.
Parameters
- propertyId: string
  
  The propertyId to find the values for
- Optional options: any
  
  Some additional options. May be implementer dependent, such as limit, or value restrictions
Returns Promise<any>
Inherited from AbstractDAO.findValues
- Defined in src/dao/AbstractDAO.ts:107

get

get(id: number): Promise<Model.OnmsAlarm>
Fetch an alarm.

Version
ReST v1+

Returns
An OnmsAlarm.
Parameters
- id: number
  
  The alarm's ID.
Returns Promise<Model.OnmsAlarm>
Overrides AbstractDAO.get
- Defined in src/dao/AlarmDAO.ts:47

`Protected` getApiVersion

getApiVersion(): number
Retrieve the API version from the currently configured server.

Returns number
Inherited from AbstractDAO.getApiVersion
- Defined in src/dao/AbstractDAO.ts:240

`Protected` getCount

getCount(data: any, status?: number): number
A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.
Parameters
- data: any
- Optional status: number
Returns number
Inherited from AbstractDAO.getCount
- Defined in src/dao/BaseDAO.ts:139

getData

getData(result: API.OnmsResult<any>): Model.OnmsAlarm[]
Extracts the data from an HTTP Request result.

Returns
An array of OnmsAlarm objects.
Parameters
- result: API.OnmsResult<any>
  
  the HTTP Request result.
Returns Model.OnmsAlarm[]
- Defined in src/dao/AlarmDAO.ts:96

`Private` getDetailsPage

getDetailsPage(alarm: number | Model.OnmsAlarm): string
Retrieves the URL to the details page for the given alarm.

Returns
URL on the associated OpenNMS server for the alarm details page.
Parameters
- alarm: number | Model.OnmsAlarm
  
  The OnmsAlarm or alarm ID.
Returns string
- Defined in src/dao/AlarmDAO.ts:541

getFilterProcessor

getFilterProcessor(): Promise<API.IFilterProcessor>
Returns the Promise for a IFilterProcessor.

Returns

Returns Promise<API.IFilterProcessor>
Inherited from AbstractDAO.getFilterProcessor
- Defined in src/dao/AbstractDAO.ts:39

getPropertiesCache

getPropertiesCache(): Promise<any>
Returns or creates a cache of properties for this dao.

Returns
the cache for this dao. It is created if it does not exist.

Returns Promise<any>
Inherited from AbstractDAO.getPropertiesCache
- Defined in src/dao/AbstractDAO.ts:84

`Private` handleError

handleError(err: API.OnmsResult<Model.OnmsAlarm>): void
Handle response errors and automatically log "ticketing not enabled" responses.
Parameters
- err: API.OnmsResult<Model.OnmsAlarm>
  
  the HTTP result error
Returns void
- Defined in src/dao/AlarmDAO.ts:550

`Protected` onSetServer

onSetServer(server: API.OnmsServer): void
Inherit Doc
Parameters
- server: API.OnmsServer
Returns void
Inherited from AbstractDAO.onSetServer
- Defined in src/dao/AbstractDAO.ts:123

`Protected` parseResultList

parseResultList(result: any, dataFieldName: string, path: string, mapCallbackFunction: any): any[]
Fetches the data from the result and verfifes that the dataFieldName exists in the data property. If it does not exist, an exception is thrown.
Parameters
- result: any
  
  The result to fetch the data from
- dataFieldName: string
  
  The property name (basically result.data[dataFieldName].
- path: string
  
  The path where the result was fetched from. This is for error handling
- mapCallbackFunction: any
  
  Callback function to convert each entry from result.data[dataFieldName].
Returns any[]
Inherited from AbstractDAO.parseResultList
- Defined in src/dao/AbstractDAO.ts:142

saveJournalMemo

saveJournalMemo(alarm: number | Model.OnmsAlarm, body: string, user?: string): Promise<void>
Create or update the journal memo associated with the alarm.

Version
ReST v2
Parameters
- alarm: number | Model.OnmsAlarm
  
  The OnmsAlarm or alarm ID.
- body: string
  
  The memo body
- Optional user: string
  
  The user to update the memo as. (Only administrators have the right to do this.)
Returns Promise<void>
- Defined in src/dao/AlarmDAO.ts:282

saveStickyMemo

saveStickyMemo(alarm: number | Model.OnmsAlarm, body: string, user?: string): Promise<void>
Create or update the sticky memo associated with the alarm.

Version
ReST v2
Parameters
- alarm: number | Model.OnmsAlarm
  
  The OnmsAlarm or alarm ID.
- body: string
  
  The memo body
- Optional user: string
  
  The user to update the memo as. (Only administrators have the right to do this.)
Returns Promise<void>
- Defined in src/dao/AlarmDAO.ts:269

searchProperties

searchProperties(): Promise<API.SearchProperty[]>
Get the list properties that can be used in queries.

Version
ReST v2

Returns Promise<API.SearchProperty[]>
Inherited from AbstractDAO.searchProperties
- Defined in src/dao/AbstractDAO.ts:65

searchProperty

searchProperty(id: string): Promise<API.SearchProperty>
Gets the property identified by the id if it exists.
Parameters
- id: string
  
  The id to search the property by.
Returns Promise<API.SearchProperty>
Inherited from AbstractDAO.searchProperty
- Defined in src/dao/AbstractDAO.ts:74

`Protected` searchPropertyPath

searchPropertyPath(): string
The path to the alarm search properties endpoint.

Returns string
Overrides AbstractDAO.searchPropertyPath
- Defined in src/dao/AlarmDAO.ts:425

setTTicketId

setTTicketId(alarm: number | Model.OnmsAlarm, ticketId: string): Promise<void>
Associate a ticket ID with the alarm.

Version
ReST v1+
Parameters
- alarm: number | Model.OnmsAlarm
  
  The OnmsAlarm or alarm ID.
- ticketId: string
  
  The ticket ID.
Returns Promise<void>
- Defined in src/dao/AlarmDAO.ts:182

setTTicketState

setTTicketState(alarm: number | Model.OnmsAlarm, state: Model.OnmsTroubleTicketState): Promise<void>
Update the state of the ticket associated with the alarm.

Version
ReST v1+
Parameters
- alarm: number | Model.OnmsAlarm
  
  The OnmsAlarm or alarm ID.
- state: Model.OnmsTroubleTicketState
  
  The ticket state.
Returns Promise<void>
- Defined in src/dao/AlarmDAO.ts:196

`Protected` toDate

toDate(from: any): Moment
Convert the given value to a date, or undefined if it cannot be converted.

Deprecated
use Util.toDate instead.
Parameters
- from: any
Returns Moment
Inherited from AbstractDAO.toDate
- Defined in src/dao/BaseDAO.ts:161

`Protected` toNumber

toNumber(from: any): number
Convert the given value to a number, or undefined if it cannot be converted.

Deprecated
use Util.toNumber instead.
Parameters
- from: any
Returns number
Inherited from AbstractDAO.toNumber
- Defined in src/dao/BaseDAO.ts:169

triggerTicketUpdate

triggerTicketUpdate(alarm: number | Model.OnmsAlarm): Promise<void>
Notify OpenNMS it should fetch updated ticket state for an alarm from the remote ticketing system.

Version
ReST v2
Parameters
- alarm: number | Model.OnmsAlarm
  
  The OnmsAlarm or alarm ID.
Returns Promise<void>
- Defined in src/dao/AlarmDAO.ts:228

unacknowledge

unacknowledge(alarm: number | Model.OnmsAlarm, user?: string): Promise<void>
Un-acknowledge an alarm.

Version
ReST v1+
Parameters
- alarm: number | Model.OnmsAlarm
  
  The OnmsAlarm or alarm ID.
- Optional user: string
Returns Promise<void>
- Defined in src/dao/AlarmDAO.ts:139

`Protected` useJson

useJson(): boolean
Whether or not to use JSON when making ReST requests.

Returns boolean
Inherited from AbstractDAO.useJson
- Defined in src/dao/BaseDAO.ts:128

`Protected` visitClause

visitClause(clause: API.Clause, visitor: API.IFilterVisitor): void
"visits" a filter clause, applying it to the filter visitor
Parameters
- clause: API.Clause
  
  the clause to visit
- visitor: API.IFilterVisitor
  
  the visitor impl to invoke
Returns void
Inherited from AbstractDAO.visitClause
- Defined in src/dao/AbstractDAO.ts:164

`Protected` visitFilter

visitFilter(filter: API.Filter, visitor: API.IFilterVisitor): void
Iterate over a Filter object and its children.
Parameters
- filter: API.Filter
  
  the filter to visit
- visitor: API.IFilterVisitor
  
  the class to invoke while visiting the filter
Returns void
Inherited from AbstractDAO.visitFilter
- Defined in src/dao/AbstractDAO.ts:187

Class AlarmDAO

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

impl: API.IOnmsHTTP | API.IHasHTTP

Returns DAO.AlarmDAO

Accessors

http

Returns API.IOnmsHTTP

Parameters

impl: API.IOnmsHTTP

Returns void

server

Returns API.OnmsServer

Parameters

s: API.OnmsServer

Returns void

Methods

acknowledge

Version

Parameters

alarm: number | Model.OnmsAlarm

Optional user: string

Returns Promise<void>

clear

Version

Parameters

alarm: number | Model.OnmsAlarm

Returns Promise<void>

closeTicket

Version

Parameters

alarm: number | Model.OnmsAlarm

Returns Promise<void>

createTicket

Version

Parameters

alarm: number | Model.OnmsAlarm

Returns Promise<void>

deleteJournalMemo

Version

Parameters

alarm: number | Model.OnmsAlarm

Returns Promise<void>

deleteStickyMemo

Version

Parameters

alarm: number | Model.OnmsAlarm

Returns Promise<void>

escalate

Version

Parameters

alarm: number | Model.OnmsAlarm

Returns Promise<void>

find

Version

Returns

Parameters

Optional filter: API.Filter

Returns Promise<Model.OnmsAlarm[]>

findValues

Returns

Parameters

propertyId: string

Optional options: any

Returns Promise<any>

get

Version

Returns

Parameters

id: number

Returns Promise<Model.OnmsAlarm>

Protected getApiVersion

Returns number

Protected getCount

`Optional` user: string

`Optional` filter: API.Filter

`Optional` options: any

`Protected` getApiVersion

`Protected` getCount

`Optional` status: number

`Private` getDetailsPage

`Private` handleError

`Protected` onSetServer

`Protected` parseResultList

`Optional` user: string

`Optional` user: string

`Protected` searchPropertyPath