@ThreadSafe public interface DiagStatusService
The term "service" in this context refers to a "higher-level functional service", not an OSGi Service interface. (It could map to an OSGi service interface, or several of them, or none.)
Modifier and Type | Method and Description |
---|---|
Collection<ServiceDescriptor> |
getAllServiceDescriptors()
Retrieve the status of all services registered so far.
|
String |
getAllServiceDescriptorsAsJSON()
Retrieve the status of all services registered so far as a JSON String with a
fixed format which external systems can rely on.
|
ServiceDescriptor |
getServiceDescriptor(String serviceIdentifier)
Retrieve the status of a service specified by the identifier.
|
boolean |
isOperational()
Retrieve single true/false boolean indicating if the system is operational to
the best of diagstatus' knowledge.
|
ServiceRegistration |
register(String serviceIdentifier)
Register a service for status monitoring.
|
void |
report(ServiceDescriptor serviceDescriptor)
Report the status of a service specified by the identifier.
|
ServiceRegistration register(String serviceIdentifier)
serviceIdentifier
- unique identifier for the service being registeredvoid report(ServiceDescriptor serviceDescriptor)
serviceDescriptor
- description of the service stateServiceDescriptor getServiceDescriptor(String serviceIdentifier)
serviceIdentifier
- unique identifier for a serviceCollection<ServiceDescriptor> getAllServiceDescriptors()
String getAllServiceDescriptorsAsJSON()
boolean isOperational()
SystemReadyMonitorMXBean
's SystemState
being ACTIVE, and all of the currently reported ServiceDescriptor
's
ServiceState
being OPERATIONAL.Copyright © 2019 OpenDaylight. All rights reserved.