org.opendaylight.infrautils.diagstatus

Interface DiagStatusService

All Known Implementing Classes:

DiagStatusServiceImpl

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

Implementations of this interface are expected to be thread-safe.

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.
ServiceDescriptor	getServiceDescriptor(String serviceIdentifier) Retrieve the status of a service specified by the identifier.
ServiceStatusSummary	getServiceStatusSummary() Retrieve the status of all services registered so far.
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

getServiceStatusSummary

ServiceStatusSummary getServiceStatusSummary()

Retrieve the status of all services registered so far.

Returns:

status as a ServiceStatusSummary