Package org.opendaylight.infrautils.diagstatus.internal

Class OSGiDiagStatusService

java.lang.Object

org.opendaylight.infrautils.diagstatus.internal.OSGiDiagStatusService

All Implemented Interfaces:

DiagStatusService

@Beta
public final class OSGiDiagStatusService
extends Object

Constructor Summary

Constructors

Constructor	Description
OSGiDiagStatusService()

Method Summary

Modifier and Type	Method	Description
com.google.common.collect.ImmutableList<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.

Methods inherited from class java.lang.Object

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

Constructor Detail

OSGiDiagStatusService

public OSGiDiagStatusService()

Method Detail

register

public final 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 final 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 final 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 final com.google.common.collect.ImmutableList<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

getServiceStatusSummary

public final ServiceStatusSummary getServiceStatusSummary()

Description copied from interface: DiagStatusService

Retrieve the status of all services registered so far.

Specified by:

getServiceStatusSummary in interface DiagStatusService

Returns:

status as a ServiceStatusSummary