Abstract
Create a new HTTP instance.
Optional
server: API.OnmsServerA server object for immediate configuration.
Optional
timeout: numberHow long to wait until timing out requests.
The default set of HTTP options associated with this ReST client.
The default options used when making requests with this instance.
The server associated with this HTTP implementation.
Abstract
getMake an HTTP GET call. This must be implemented by the concrete implementation.
Optional
options: API.OnmsHTTPOptionsProtected
getAttempt to extract the data from a response.
Protected
getGet 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.
Optional
options: API.OnmsHTTPOptionsProtected
getGet 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.
Optional
options: API.OnmsHTTPOptionsAbstract
headMake an HTTP HEAD call. This must be implemented by the concrete implementation.
Optional
options: API.OnmsHTTPOptionsAbstract
httpMake an HTTP DELETE call. This must be overridden by the concrete implementation.
Optional
options: API.OnmsHTTPOptionsProtected
onImplementers should override this method if they have actions that need to be performed (like clearing a cache) when server settings change.
Abstract
postMake an HTTP POST call. This must be overridden by the concrete implementation.
Optional
options: API.OnmsHTTPOptionsAbstract
putMake an HTTP PUT call. This must be overridden by the concrete implementation.
Optional
options: API.OnmsHTTPOptionsProtected
transformJSONA 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.
Protected
transformXMLA 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.
Abstract implementation of the OnmsHTTP interface meant to be extended by a concrete class.
Implements
IOnmsHTTP