Class Client

Hierarchy

Client

Index

Constructors

constructor

Properties

server
http

Methods

Constructors

constructor

new Client(httpImpl?: IOnmsHTTP): Client

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

constructor

Parameters
- Optional httpImpl: IOnmsHTTP
  
  The OnmsHTTP implementation to use. Normally this will automatically choose the best implementation based on the environment.
Returns Client

Properties

Private server

server: OnmsServer

The remote server to connect to

Static Private http

http: IOnmsHTTP

The OnmsHTTP implementation to be used when making requests

Methods

Static checkServer

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

- Defined in Client.ts:37
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<OnmsResult<ServerMetadata>>

- Defined in Client.ts:62
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<OnmsResult<ServerMetadata>>

Generated using TypeDoc