Interface RestClient

  • All Known Implementing Classes:
    ScvEnabledRestClientImpl

    public interface RestClient
    REST API client for OpenNMS.
    Author:
    jwhite
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getSnmpV3Users()
      Used to fetch snmpV3users from REST endpoint.
      java.lang.String getVersion()
      Retrieves the OpenNMS version.
      void ping()
      Used to verify connectivity with the REST endpoint.
    • Method Detail

      • getVersion

        java.lang.String getVersion()
                             throws java.lang.Exception
        Retrieves the OpenNMS version.
        Throws:
        java.lang.Exception - on failure
      • ping

        void ping()
           throws java.lang.Exception
        Used to verify connectivity with the REST endpoint.
        Throws:
        java.lang.Exception - on failure
      • getSnmpV3Users

        java.lang.String getSnmpV3Users()
                                 throws java.lang.Exception
        Used to fetch snmpV3users from REST endpoint.
        Throws:
        java.lang.Exception - on failure