Class AbstractHTTP

Hierarchy

AbstractHTTP
- AxiosHTTP
- GrafanaHTTP

Implements

IOnmsHTTP

Index

Constructors

constructor

Properties

Accessors

server

Methods

Constructors

constructor

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

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

constructor

Parameters
- Optional server: OnmsServer
  
  a server object for immediate configuration
- Default value timeout: number = 10000
  
  how long to wait until timing out requests
Returns AbstractHTTP

Properties

options

options: OnmsHTTPOptions

the authorization config associated with this ReST client

Private serverObj

serverObj: OnmsServer

the server metadata we'll use for constructing ReST calls

timeout

timeout: number = 10000

how long to wait before giving up on a given request

Accessors

server

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

- Defined in rest/AbstractHTTP.ts:34
the server associated with this HTTP implementation

Returns OnmsServer
- Defined in rest/AbstractHTTP.ts:38
the server associated with this HTTP implementation

Parameters
- server: OnmsServer
Returns void

Methods

get

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

Implementation of IOnmsHTTP.get
- Defined in rest/AbstractHTTP.ts:55
make an HTTP GET call -- this should be overridden by the implementation

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

Protected getOptions

getOptions(options?: OnmsHTTPOptions): any

- Defined in rest/AbstractHTTP.ts:90
combine all options from the given options, the current server, and the default options

Parameters
- Optional options: OnmsHTTPOptions
Returns any

Protected getServer

getServer(options?: OnmsHTTPOptions): OnmsServer

- Defined in rest/AbstractHTTP.ts:85
get the server in the options object, or fall back to the one assigned to the HTTP impl

Parameters
- Optional options: OnmsHTTPOptions
Returns OnmsServer

Protected onSetServer

onSetServer(): void

- Defined in rest/AbstractHTTP.ts:104
useful for performing an action (like clearing caches) when the server is set

Returns void

put

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

Implementation of IOnmsHTTP.put
- Defined in rest/AbstractHTTP.ts:58
make an HTTP PUT call -- this should be overridden by the implementation

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

Protected transformJSON

transformJSON(data: any): any

- Defined in rest/AbstractHTTP.ts:61
a convenience method for implementers to use to turn JSON into a javascript object

Parameters
- data: any
Returns any

Protected transformXML

transformXML(data: any): any

- Defined in rest/AbstractHTTP.ts:75
a convenience method for implementers to use to turn XML into a javascript object

Parameters
- data: any
Returns any

Generated using TypeDoc