Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OnmsServer

Represents a remote OpenNMS server.

Hierarchy

  • OnmsServer

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Construct a new OnmsServer object representing a remote server.

    example
    provide a pre-existing OnmsAuthConfig for auth ```javascript const server = new OnmsServer('Test', 'https://myserver/opennms/', auth); ```
    constructor

    Parameters

    Returns OnmsServer

Properties

auth

auth: OnmsAuthConfig | null

The authorization configuration associated with the server.

id

id: string

A unique identifier for this server.

metadata

metadata: ServerMetadata | null

The capabilities of the server

Optional name

name: string

An optional name associated with this server.

url

url: string

The base URL to the server.

Accessors

host

  • get host(): any

  • Get the hostname portion of the URL associated with this server.

    Returns any

Methods

clone

equals

  • Check whether the provided server has the same settings as this one.

    Parameters

    Returns boolean

resolveURL

  • resolveURL(forFragment?: string, withQuery?: any): any

  • Given a relative URL fragment, construct a URL for that fragment on the server.

    parm

    withQuery - Query parameters to be appended to the URL.

    Parameters

    • Optional forFragment: string

      The URL fragment to append to the server URL.

    • Optional withQuery: any

    Returns any

    A complete URL.

toString

  • toString(): string

  • A string representation of this server suitable for display.

    Returns string

Static newBuilder

Generated using TypeDoc