Class Client

The OpenNMS client. This is the primary interface to OpenNMS servers.

Hierarchy

Client

Implements

IHasHTTP

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Client(httpImpl?: IOnmsHTTP): Client

- Defined in Client.ts:106
Construct a new OpenNMS client.

If no httpImpl parameter is provided, the class in Client.defaultHttp will be used by default. Unless overridden, this defaults to AxiosHTTP.

constructor

Parameters
- Optional httpImpl: IOnmsHTTP
  
  The IOnmsHTTP implementation to use.
Returns Client

Properties

http

http: IOnmsHTTP

the OnmsHTTP implementation that will be used when making requests

Static Private defaultHttp

defaultHttp: AxiosHTTP = AxiosHTTP

The default OnmsHTTP implementation to be used when making requests

Methods

alarms

alarms(): AlarmDAO

- Defined in Client.ts:147
Get an alarm DAO for querying alarms.

Returns AlarmDAO

connect

connect(name: string, url: string, username: string, password: string, timeout?: number): Promise<this>

- Defined in Client.ts:129
Connect to an OpenNMS server.

NOTE: This method will connect to the server using the provided information, get the server metadata, and then assign that server to the existing IOnmsHTTP implementation associated with this client (or the default impl, if one has not yet been provided).

Parameters
- name: string
- url: string
- username: string
- password: string
- Optional timeout: number
Returns Promise<this>

events

events(): EventDAO

- Defined in Client.ts:152
Get an event DAO for querying events.

Returns EventDAO

flows

flows(): FlowDAO

- Defined in Client.ts:162
Get a flow DAO for querying flows.

Returns FlowDAO

nodes

nodes(): NodeDAO

- Defined in Client.ts:157
Get a node DAO for querying nodes.

Returns NodeDAO

situationfeedback

situationfeedback(): SituationFeedbackDAO

- Defined in Client.ts:167
Get a situationFeedback DAO for submitting and querying correlation feedback.

Returns SituationFeedbackDAO

Static checkServer

checkServer(server: OnmsServer, httpImpl?: IOnmsHTTP, timeout?: number): Promise<boolean>

- Defined in Client.ts:35
Given an OnmsServer object, check that it can be connected to.

Parameters
- server: OnmsServer
  
  the server to check
- Optional httpImpl: IOnmsHTTP
  
  the IOnmsHTTP implementation to use
- Optional timeout: number
  
  how long to wait before giving up when making ReST calls
Returns Promise<boolean>

Static getMetadata

getMetadata(server: OnmsServer, httpImpl?: IOnmsHTTP, timeout?: number): Promise<ServerMetadata>

- Defined in Client.ts:61
Given an OnmsServer object, query what capabilities it has, and return the capabilities associated with that server.

Parameters
- server: OnmsServer
  
  the server to check
- Optional httpImpl: IOnmsHTTP
  
  the IOnmsHTTP implementation to use
- Optional timeout: number
  
  how long to wait before giving up when making ReST calls
Returns Promise<ServerMetadata>

Generated using TypeDoc