Package org.opendaylight.openflowplugin.api.openflow.mastership

Interface MastershipChangeServiceManager

All Superinterfaces:

AutoCloseable, OwnershipChangeListener, ReconciliationFrameworkRegistrar

All Known Implementing Classes:

MastershipChangeServiceManagerImpl

public interface MastershipChangeServiceManager
extends OwnershipChangeListener, AutoCloseable

Provider to register mastership change listener. Provider to set mastership reconciliation framework.

Since:

0.5.0 Nitrogen

Method Summary

Modifier and Type	Method	Description
void	close()
ReconciliationFrameworkRegistration	reconciliationFrameworkRegistration(@NonNull ReconciliationFrameworkEvent mastershipRFRegistration)	Setter for reconciliation framework event listener.
@NonNull MastershipChangeRegistration	register(@NonNull MastershipChangeService service)	Register of mastership change listener.

Methods inherited from interface org.opendaylight.openflowplugin.api.openflow.lifecycle.OwnershipChangeListener

becomeMaster, becomeMasterBeforeSubmittedDS, becomeSlaveOrDisconnect, setMasterChecker

Methods inherited from interface org.opendaylight.openflowplugin.api.openflow.lifecycle.ReconciliationFrameworkRegistrar

isReconciliationFrameworkRegistered

Method Detail

register

@NonNull MastershipChangeRegistration register(@NonNull MastershipChangeService service)

Register of mastership change listener. Returned registration need to be closed by client. It doesn't contain event for reconciliation framework event.

Parameters:

service - implementation of MastershipChangeService

Returns:

registration

See Also:

ReconciliationFrameworkEvent

reconciliationFrameworkRegistration

ReconciliationFrameworkRegistration reconciliationFrameworkRegistration(@NonNull ReconciliationFrameworkEvent mastershipRFRegistration)
                                                                 throws MastershipChangeException

Setter for reconciliation framework event listener. It can be registered only once. Another registrations will throw an exception

Parameters:

mastershipRFRegistration - reconciliation framework

Returns:

registration object, which can be closed to unregister

Throws:

MastershipChangeException - if already reconciliation framework registered

close

void close()

Specified by:

close in interface AutoCloseable