Package org.opendaylight.mdsal.singleton.dom.impl

Class OSGiClusterSingletonServiceProvider

java.lang.Object

org.opendaylight.mdsal.singleton.dom.impl.OSGiClusterSingletonServiceProvider

All Implemented Interfaces:

AutoCloseable, ClusterSingletonServiceProvider

@Beta
public final class OSGiClusterSingletonServiceProvider
extends Object
implements ClusterSingletonServiceProvider

Constructor Summary

Constructors

Constructor	Description
OSGiClusterSingletonServiceProvider()

Method Summary

Modifier and Type	Method	Description
void	close()
ClusterSingletonServiceRegistration	registerClusterSingletonService(ClusterSingletonService service)	Method registers ClusterSingletonService to Provider.

Methods inherited from class java.lang.Object

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

Constructor Details

OSGiClusterSingletonServiceProvider

public OSGiClusterSingletonServiceProvider()

Method Details

registerClusterSingletonService

public ClusterSingletonServiceRegistration registerClusterSingletonService(ClusterSingletonService service)

Description copied from interface: ClusterSingletonServiceProvider

Method registers ClusterSingletonService to Provider. Method returns RuntimeException for unexpected state, so be careful with implementation. Note: RuntimeException is implemented as a notification about some problems with registration and client has to implement some strategy for handling this issue. TODO: RuntimeException is not a transparent contract for handling unexpected state and it needs to be replaced with a specific documented Exception or it needs to add another contract definition for a client notification about the unexpected state reason in ClusterSingletonService. RuntimeException implementation is a hotfix for an unwanted API contract changes in boron release only.

Specified by:

registerClusterSingletonService in interface ClusterSingletonServiceProvider

Parameters:

service - ClusterSingletonService instance

Returns:

AutoCloseable registration

close

public void close()

Specified by:

close in interface AutoCloseable