Create a new HTTP instance.
A server object for immediate configuration.
How long to wait until timing out requests.
Whether this plugin is valid and can be initialized.
Implementations can use this to signal whether any optional dependencies or other conditions have been met for the plugin to work.
The default set of HTTP options associated with this ReST client.
The default set of HTTP options associated with this ReST client.
The server associated with this HTTP implementation.
The server associated with this HTTP implementation.
The default amount of time to wait before giving up on a request.
The default amount of time to wait before giving up on a request.
Make an HTTP GET call. This must be implemented by the concrete implementation.
Attempt to extract the data from a response.
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.
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.
Make an HTTP HEAD call. This must be implemented by the concrete implementation.
Make an HTTP DELETE call. This must be overridden by the concrete implementation.
Keep the basic auth string in sync when username/password changes.
The username
The user's password
The newly-computed hash of username + password
The previous hash
Implementers should override this method if they have actions that need to be performed (like clearing a cache) when server settings change.
Make an HTTP POST call. This must be overridden by the concrete implementation.
Make an HTTP PUT call. This must be overridden by the concrete implementation.
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.
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.
Set or update the basic auth credentials to be used in making connections.
The username to connect with
The password to connect with
Generated using TypeDoc
Abstract implementation of the OnmsHTTP interface meant to be extended by a concrete class.
IOnmsHTTP