Class AbstractHTTP

Abstract implementation of the OnmsHTTP interface meant to be extended by a concrete class.

implements: IOnmsHTTP

Hierarchy

AbstractHTTP
- AxiosHTTP
- GrafanaHTTP

Implements

IOnmsHTTP

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new AbstractHTTP(server?: OnmsServer, timeout?: number): AbstractHTTP

- Defined in rest/AbstractHTTP.ts:80
Create a new HTTP instance.

constructor

Parameters
- Optional server: OnmsServer
  
  A server object for immediate configuration.
- Optional timeout: number
  
  How long to wait until timing out requests.
Returns AbstractHTTP

Accessors

options

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

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

Returns OnmsHTTPOptions
- 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

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

Returns OnmsServer
- 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

- 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
- 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

Abstract get

get(url: string, options?: OnmsHTTPOptions): Promise<OnmsResult<any>>

Implementation of IOnmsHTTP.get
- Defined in rest/AbstractHTTP.ts:98
Make an HTTP GET call. This must be implemented by the concrete implementation.

Parameters
- url: string
- Optional options: OnmsHTTPOptions
Returns Promise<OnmsResult<any>>

Protected getData

getData(response: any): any

- 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

- 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

- 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

Abstract head

head(url: string, options?: OnmsHTTPOptions): Promise<OnmsResult<any>>

Implementation of IOnmsHTTP.head
- Defined in rest/AbstractHTTP.ts:101
Make an HTTP HEAD call. This must be implemented by the concrete implementation.

Parameters
- url: string
- Optional options: OnmsHTTPOptions
Returns Promise<OnmsResult<any>>

Abstract httpDelete

httpDelete(url: string, options?: OnmsHTTPOptions): Promise<OnmsResult<any>>

Implementation of IOnmsHTTP.httpDelete
- Defined in rest/AbstractHTTP.ts:110
Make an HTTP DELETE call. This must be overridden by the concrete implementation.

Parameters
- url: string
- Optional options: OnmsHTTPOptions
Returns Promise<OnmsResult<any>>

Protected onBasicAuth

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

- Defined in rest/AbstractHTTP.ts:232
Keep the basic auth string in sync when username/password changes.

Parameters
- username: string
  
  The username
- password: string
  
  The user's password
- newHash: string
  
  The newly-computed hash of username + password
- Optional oldHash: string
  
  The previous hash
Returns void

Protected onSetServer

onSetServer(): void

- 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

Abstract post

post(url: string, options?: OnmsHTTPOptions): Promise<OnmsResult<any>>

Implementation of IOnmsHTTP.post
- Defined in rest/AbstractHTTP.ts:107
Make an HTTP POST call. This must be overridden by the concrete implementation.

Parameters
- url: string
- Optional options: OnmsHTTPOptions
Returns Promise<OnmsResult<any>>

Abstract put

put(url: string, options?: OnmsHTTPOptions): Promise<OnmsResult<any>>

Implementation of IOnmsHTTP.put
- Defined in rest/AbstractHTTP.ts:104
Make an HTTP PUT call. This must be overridden by the concrete implementation.

Parameters
- url: string
- Optional options: OnmsHTTPOptions
Returns Promise<OnmsResult<any>>

Protected transformJSON

transformJSON(data: any): any

- 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

- 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

- 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