Class GrafanaHTTP

Implementation of the IOnmsHTTP interface for Grafana.

implements: IOnmsHTTP

Hierarchy

AbstractHTTP
- GrafanaHTTP

Implements

IOnmsHTTP

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new GrafanaHTTP(backendSrv: any, server?: OnmsServer, timeout?: number): GrafanaHTTP

Overrides AbstractHTTP.constructor
- Defined in rest/GrafanaHTTP.ts:32
Construct a new GrafanaHTTP implementation.

constructor

Parameters
- backendSrv: any
  
  The Grafana BackendSrv object to use for requests.
- Optional server: OnmsServer
  
  The OpenNMS server to make requests to.
- Optional timeout: number
Returns GrafanaHTTP

Accessors

options

get options(): OnmsHTTPOptions
set options(o: OnmsHTTPOptions): void

Inherited from AbstractHTTP.options
- Defined in rest/AbstractHTTP.ts:40
The default set of HTTP options associated with this ReST client.

Returns OnmsHTTPOptions
Inherited from AbstractHTTP.options
- Defined in rest/AbstractHTTP.ts:47
The default set of HTTP options associated with this ReST client.

Parameters
- o: OnmsHTTPOptions
Returns void

server

get server(): OnmsServer
set server(server: OnmsServer | null): void

Inherited from AbstractHTTP.server
- Defined in rest/AbstractHTTP.ts:73
The server associated with this HTTP implementation.

Returns OnmsServer
Inherited from AbstractHTTP.server
- Defined in rest/AbstractHTTP.ts:77
The server associated with this HTTP implementation.

Parameters
- server: OnmsServer | null
Returns void

timeout

get timeout(): number
set timeout(t: number): void

Inherited from AbstractHTTP.timeout
- Defined in rest/AbstractHTTP.ts:55
The default amount of time to wait before giving up on a request.

deprecated

Set timeout on the OnmsHTTPOptions object instead. This will go away in OpenNMS.js 2.0.

Returns number
Inherited from AbstractHTTP.timeout
- Defined in rest/AbstractHTTP.ts:59
The default amount of time to wait before giving up on a request.

Parameters
- t: number
Returns void

Methods

get

get(url: string, options?: OnmsHTTPOptions): any

Implementation of IOnmsHTTP.get

Overrides AbstractHTTP.get
- Defined in rest/GrafanaHTTP.ts:46
Make an HTTP GET call using the Grafana BackendSrv.

Parameters
- url: string
- Optional options: OnmsHTTPOptions
Returns any

Protected getData

getData(response: any): any

Inherited from AbstractHTTP.getData
- Defined in rest/AbstractHTTP.ts:129
Attempt to extract the data from a response.

Parameters
- response: any
Returns any

Protected getOptions

getOptions(options?: OnmsHTTPOptions): OnmsHTTPOptions

Inherited from AbstractHTTP.getOptions
- Defined in rest/AbstractHTTP.ts:181
Get the union of OnmsHTTPOptions based on the passed options, defaults, and options in the OnmsServer associated with this request. Order of precedence is passed options -> server options -> default options.

Parameters
- Optional options: OnmsHTTPOptions
Returns OnmsHTTPOptions

Protected getServer

getServer(options?: OnmsHTTPOptions): OnmsServer

Inherited from AbstractHTTP.getServer
- Defined in rest/AbstractHTTP.ts:166
Get the OnmsServer object that should be used for making requests. Favors the one passed in the OnmsHTTPOptions, otherwise it falls back to the default server associated with the HTTP implementation.

Parameters
- Optional options: OnmsHTTPOptions
Returns OnmsServer

head

head(url: string, options?: OnmsHTTPOptions): any

Implementation of IOnmsHTTP.head

Overrides AbstractHTTP.head
- Defined in rest/GrafanaHTTP.ts:67
Make an HTTP HEAD call using the Grafana BackendSrv.

Parameters
- url: string
- Optional options: OnmsHTTPOptions
Returns any

httpDelete

httpDelete(url: string, options?: OnmsHTTPOptions): any

Implementation of IOnmsHTTP.httpDelete

Overrides AbstractHTTP.httpDelete
- Defined in rest/GrafanaHTTP.ts:131
Make an HTTP DELETE call using the Grafana BackendSrv.

Parameters
- url: string
- Optional options: OnmsHTTPOptions
Returns any

Protected onBasicAuth

onBasicAuth(username: string, password: string, newHash: string, oldHash?: string): void

Overrides AbstractHTTP.onBasicAuth
- Defined in rest/GrafanaHTTP.ts:167
inheritdoc

Parameters
- username: string
- password: string
- newHash: string
- Optional oldHash: string
Returns void

Protected onSetServer

onSetServer(): void

Inherited from AbstractHTTP.onSetServer
- Defined in rest/AbstractHTTP.ts:240
Implementers should override this method if they have actions that need to be performed (like clearing a cache) when server settings change.

Returns void

post

post(url: string, options?: OnmsHTTPOptions): any

Implementation of IOnmsHTTP.post

Overrides AbstractHTTP.post
- Defined in rest/GrafanaHTTP.ts:110
Make an HTTP POST call using the Grafana BackendSrv.

Parameters
- url: string
- Optional options: OnmsHTTPOptions
Returns any

put

put(url: string, options?: OnmsHTTPOptions): any

Implementation of IOnmsHTTP.put

Overrides AbstractHTTP.put
- Defined in rest/GrafanaHTTP.ts:88
Make an HTTP PUT call using the Grafana BackendSrv.

Parameters
- url: string
- Optional options: OnmsHTTPOptions
Returns any

Protected transformJSON

transformJSON(data: any): any

Inherited from AbstractHTTP.transformJSON
- Defined in rest/AbstractHTTP.ts:116
A convenience method for implementers to use to turn JSON into a javascript object. Use this to process a JSON response before returning it in an OnmsResult object.

Parameters
- data: any
Returns any

Protected transformXML

transformXML(data: any): any

Inherited from AbstractHTTP.transformXML
- Defined in rest/AbstractHTTP.ts:124
A convenience method for implementers to use to turn XML into a javascript object. Use this to process an XML response before returning it in an OnmsResult object.

Parameters
- data: any
Returns any

Protected useBasicAuth

useBasicAuth(username?: string, password?: string): void

Inherited from AbstractHTTP.useBasicAuth
- Defined in rest/AbstractHTTP.ts:215
Set or update the basic auth credentials to be used in making connections.

Parameters
- Optional username: string
  
  The username to connect with
- Optional password: string
  
  The password to connect with
Returns void

Generated using TypeDoc