Class GrafanaHTTP

Implementation of the [[IOnmsHTTP]] interface for Grafana.

Implements

IOnmsHTTP

Hierarchy (View Summary)

Rest.AbstractHTTP
- GrafanaHTTP

Index

Constructors

Accessors

Methods

get getData getOptions getServer head httpDelete onSetServer post put transformJSON transformXML

Constructors

constructor

new GrafanaHTTP(
    backendSrv: any,
    server?: API.OnmsServer,
    timeout?: number,
): Rest.GrafanaHTTP
Construct a new GrafanaHTTP implementation.
Parameters
- backendSrv: any
  The Grafana BackendSrv object to use for requests.
- Optionalserver: API.OnmsServer
  The OpenNMS server to make requests to.
- Optionaltimeout: number
Returns Rest.GrafanaHTTP
Overrides AbstractHTTP.constructor
- Defined in src/rest/GrafanaHTTP.ts:31

Accessors

options

get options(): API.OnmsHTTPOptions
The default set of HTTP options associated with this ReST client.

Returns API.OnmsHTTPOptions
Inherited from AbstractHTTP.options
- Defined in src/rest/AbstractHTTP.ts:38
set options(o: API.OnmsHTTPOptions): void
The default options used when making requests with this instance.
Parameters
- o: API.OnmsHTTPOptions
Returns void
Inherited from AbstractHTTP.options
- Defined in src/rest/AbstractHTTP.ts:45

server

get server(): API.OnmsServer
The server associated with this HTTP implementation.

Returns API.OnmsServer
Inherited from AbstractHTTP.server
- Defined in src/rest/AbstractHTTP.ts:56
set server(server: API.OnmsServer): void
The server associated with this instance.
Parameters
- server: API.OnmsServer
Returns void
Inherited from AbstractHTTP.server
- Defined in src/rest/AbstractHTTP.ts:60

Methods

get

get(url: string, options?: API.OnmsHTTPOptions): any
Make an HTTP GET call using the Grafana BackendSrv.
Parameters
- url: string
- Optionaloptions: API.OnmsHTTPOptions
Returns any
Overrides AbstractHTTP.get
- Defined in src/rest/GrafanaHTTP.ts:37

`Protected`getData

getData(response: any): any
Attempt to extract the data from a response.
Parameters
- response: any
Returns any
Inherited from AbstractHTTP.getData
- Defined in src/rest/AbstractHTTP.ts:112

`Protected`getOptions

getOptions(options?: API.OnmsHTTPOptions): API.OnmsHTTPOptions
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
- Optionaloptions: API.OnmsHTTPOptions
Returns API.OnmsHTTPOptions
Inherited from AbstractHTTP.getOptions
- Defined in src/rest/AbstractHTTP.ts:164

`Protected`getServer

getServer(options?: API.OnmsHTTPOptions): API.OnmsServer
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
- Optionaloptions: API.OnmsHTTPOptions
Returns API.OnmsServer
Inherited from AbstractHTTP.getServer
- Defined in src/rest/AbstractHTTP.ts:149

head

head(url: string, options?: API.OnmsHTTPOptions): any
Make an HTTP HEAD call using the Grafana BackendSrv.
Parameters
- url: string
- Optionaloptions: API.OnmsHTTPOptions
Returns any
Overrides AbstractHTTP.head
- Defined in src/rest/GrafanaHTTP.ts:58

httpDelete

httpDelete(url: string, options?: API.OnmsHTTPOptions): any
Make an HTTP DELETE call using the Grafana BackendSrv.
Parameters
- url: string
- Optionaloptions: API.OnmsHTTPOptions
Returns any
Overrides AbstractHTTP.httpDelete
- Defined in src/rest/GrafanaHTTP.ts:122

`Protected`onSetServer

onSetServer(): void
Implementers should override this method if they have actions that need to be performed (like clearing a cache) when server settings change.

Returns void
Inherited from AbstractHTTP.onSetServer
- Defined in src/rest/AbstractHTTP.ts:178

post

post(url: string, options?: API.OnmsHTTPOptions): any
Make an HTTP POST call using the Grafana BackendSrv.
Parameters
- url: string
- Optionaloptions: API.OnmsHTTPOptions
Returns any
Overrides AbstractHTTP.post
- Defined in src/rest/GrafanaHTTP.ts:101

put

put(url: string, options?: API.OnmsHTTPOptions): any
Make an HTTP PUT call using the Grafana BackendSrv.
Parameters
- url: string
- Optionaloptions: API.OnmsHTTPOptions
Returns any
Overrides AbstractHTTP.put
- Defined in src/rest/GrafanaHTTP.ts:79

`Protected`transformJSON

transformJSON(data: any): any
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
Inherited from AbstractHTTP.transformJSON
- Defined in src/rest/AbstractHTTP.ts:99

`Protected`transformXML

transformXML(data: any): any
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
Inherited from AbstractHTTP.transformXML
- Defined in src/rest/AbstractHTTP.ts:107