PingTest

All Known Implementing Classes:: DataSourcePingTest

public interface PingTest

API for a service that be used to verify the status of some specific part of the SolarNetwork system.

Since:: 1.52
Version:: 1.0
Author:: matt

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static interface

PingTest.Result

Ping test result API.
Method Summary

Modifier and Type

Method

Description

String

getPingTestId()

Get some globally-unique ID for this test instance.

long

getPingTestMaximumExecutionMilliseconds()

Get the maximum number of milliseconds to wait for the ping test to execute before considering the test a failure.

String

getPingTestName()

Get display name for this test.

PingTest.Result

performPingTest()

Perform the test, and return the results of the test.

Method Details
- getPingTestId
  
  String getPingTestId()
  
  Get some globally-unique ID for this test instance.
  
  Returns:
  
  The globally-unique ID of this test instance.
- getPingTestName
  
  String getPingTestName()
  
  Get display name for this test.
  
  Returns:
  
  The name of the test.
- getPingTestMaximumExecutionMilliseconds
  
  long getPingTestMaximumExecutionMilliseconds()
  
  Get the maximum number of milliseconds to wait for the ping test to execute before considering the test a failure.
  
  Returns:
  
  The maximum execution milliseconds.
- performPingTest
  
  PingTest.Result performPingTest() throws Exception
  
  Perform the test, and return the results of the test.
  
  Returns:
  
  The test results.
  
  Throws:
  
  Exception - if any error occurs