org.opendaylight.infrautils.diagstatus.internal

Class DiagStatusServiceImpl

java.lang.Object

org.opendaylight.infrautils.diagstatus.internal.DiagStatusServiceImpl

All Implemented Interfaces:

DiagStatusService

@Singleton
 @OsgiServiceProvider(classes=DiagStatusService.class)
public class DiagStatusServiceImpl
extends Object
implements DiagStatusService

DiagStatusServiceImpl is the core class having the functionality for tracking the registered services and aggregating the status of the same.

Author:

Faseela K

Constructor Summary

Constructors

Constructor and Description
DiagStatusServiceImpl(List<ServiceStatusProvider> serviceStatusProviders, SystemReadyMonitor systemReadyMonitor)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DiagStatusServiceImpl

@Inject
public DiagStatusServiceImpl(List<ServiceStatusProvider> serviceStatusProviders,
                                     SystemReadyMonitor systemReadyMonitor)

Method Detail

register

public ServiceRegistration register(String serviceIdentifier)

Description copied from interface: DiagStatusService

Register a service for status monitoring.

Specified by:

register in interface DiagStatusService

Parameters:

serviceIdentifier - unique identifier for the service being registered

Returns:

Registration status

report

public void report(ServiceDescriptor serviceDescriptor)

Description copied from interface: DiagStatusService

Report the status of a service specified by the identifier.

Specified by:

report in interface DiagStatusService

Parameters:

serviceDescriptor - description of the service state

getServiceDescriptor

public ServiceDescriptor getServiceDescriptor(String serviceIdentifier)

Description copied from interface: DiagStatusService

Retrieve the status of a service specified by the identifier.

Specified by:

getServiceDescriptor in interface DiagStatusService

Parameters:

serviceIdentifier - unique identifier for a service

getAllServiceDescriptors

public Collection<ServiceDescriptor> getAllServiceDescriptors()

Description copied from interface: DiagStatusService

Retrieve the status of all services registered so far.

Specified by:

getAllServiceDescriptors in interface DiagStatusService

Returns:

status set for all registered services

isOperational

public boolean isOperational()

Description copied from interface: DiagStatusService

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.

Specified by:

isOperational in interface DiagStatusService

Returns:

true if system is operational, false if not

getAllServiceDescriptorsAsJSON

public String getAllServiceDescriptorsAsJSON()

Description copied from interface: DiagStatusService

Retrieve the status of all services registered so far as a JSON String with a fixed format which external systems can rely on.

Specified by:

getAllServiceDescriptorsAsJSON in interface DiagStatusService

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