org.opendaylight.infrautils.diagstatus

Interface DiagStatusService

All Known Implementing Classes:

DiagStatusServiceImpl

@ThreadSafe
public interface DiagStatusService

DiagStatus ServiceDescriptor which lets users register/retrieve for particular service status details.

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.)

Author:

Faseela K, Michael Vorburger

Method Summary

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.

Method Detail

register

ServiceRegistration register(String serviceIdentifier)

Register a service for status monitoring.

Parameters:

serviceIdentifier - unique identifier for the service being registered

Returns:

Registration status

report

void report(ServiceDescriptor serviceDescriptor)

Report the status of a service specified by the identifier.

Parameters:

serviceDescriptor - description of the service state

getServiceDescriptor

ServiceDescriptor getServiceDescriptor(String serviceIdentifier)

Retrieve the status of a service specified by the identifier.

Parameters:

serviceIdentifier - unique identifier for a service

getAllServiceDescriptors

Collection<ServiceDescriptor> getAllServiceDescriptors()

Retrieve the status of all services registered so far.

Returns:

status set for all registered services

getAllServiceDescriptorsAsJSON

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.

Returns:

JSON formatted String with all service descriptions and all of the details available for each of them as well as the global system ready status

isOperational

boolean isOperational()

Retrieve single true/false boolean indicating if the system is operational to the best of diagstatus' knowledge. Being operational in this context is defined as the global SystemReadyMonitorMXBean's SystemState being ACTIVE, and all of the currently reported ServiceDescriptor's ServiceState being OPERATIONAL.

Returns:

true if system is operational, false if not