Package org.opendaylight.controller.eos.akka

Class AkkaEntityOwnershipService

java.lang.Object

org.opendaylight.controller.eos.akka.AkkaEntityOwnershipService

All Implemented Interfaces:

AutoCloseable, DataCenterControl, GenericEntityOwnershipService<YangInstanceIdentifier,DOMEntity,DOMEntityOwnershipListener>, DOMEntityOwnershipService, OdlEntityOwnersService, RpcService

@Singleton
public class AkkaEntityOwnershipService
extends Object
implements DOMEntityOwnershipService, DataCenterControl, AutoCloseable, OdlEntityOwnersService

DOMEntityOwnershipService implementation backed by native Akka clustering constructs. We use distributed-data to track all registered candidates and cluster-singleton to maintain a single cluster-wide authority which selects the appropriate owners.

Field Summary

Fields

Modifier and Type	Field	Description
protected ActorRef<OwnerSupervisorCommand>	ownerSupervisor

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AkkaEntityOwnershipService(ActorSystem actorSystem, BindingCodecTree codecTree)
	AkkaEntityOwnershipService(ActorSystemProvider actorProvider, RpcProviderService rpcProvider, BindingCodecTree codecTree)

Method Summary

Modifier and Type	Method	Description
ListenableFuture<Empty>	activateDataCenter()	Activates the Entity Ownership Service in the datacenter that this method is called.
void	close()
ListenableFuture<Empty>	deactivateDataCenter()	Deactivates the Entity Ownership Service in the datacenter that this method is called.
ListenableFuture<RpcResult<GetEntitiesOutput>>	getEntities(GetEntitiesInput input)	Invoke get-entities RPC.
ListenableFuture<RpcResult<GetEntityOutput>>	getEntity(GetEntityInput input)	Invoke get-entity RPC.
ListenableFuture<RpcResult<GetEntityOwnerOutput>>	getEntityOwner(GetEntityOwnerInput input)	Invoke get-entity-owner RPC.
Optional<EntityOwnershipState>	getOwnershipState(DOMEntity entity)
boolean	isCandidateRegistered(DOMEntity forEntity)
DOMEntityOwnershipCandidateRegistration	registerCandidate(DOMEntity entity)
DOMEntityOwnershipListenerRegistration	registerListener(String entityType, DOMEntityOwnershipListener listener)

Methods inherited from class java.lang.Object

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

Field Detail

ownerSupervisor

protected final ActorRef<OwnerSupervisorCommand> ownerSupervisor

Constructor Detail

AkkaEntityOwnershipService

protected AkkaEntityOwnershipService(ActorSystem actorSystem,
                                     BindingCodecTree codecTree)
                              throws ExecutionException,
                                     InterruptedException

Throws:

ExecutionException

InterruptedException

AkkaEntityOwnershipService

@Inject
public AkkaEntityOwnershipService(ActorSystemProvider actorProvider,
                                  RpcProviderService rpcProvider,
                                  BindingCodecTree codecTree)
                           throws ExecutionException,
                                  InterruptedException

Throws:

ExecutionException

InterruptedException

Method Detail

close

@PreDestroy
public void close()
           throws InterruptedException,
                  ExecutionException

Specified by:

close in interface AutoCloseable

Throws:

InterruptedException

ExecutionException

registerCandidate

public DOMEntityOwnershipCandidateRegistration registerCandidate(DOMEntity entity)
                                                          throws CandidateAlreadyRegisteredException

Specified by:

registerCandidate in interface DOMEntityOwnershipService

Specified by:

registerCandidate in interface GenericEntityOwnershipService<YangInstanceIdentifier,DOMEntity,DOMEntityOwnershipListener>

Throws:

CandidateAlreadyRegisteredException

registerListener

public DOMEntityOwnershipListenerRegistration registerListener(String entityType,
                                                               DOMEntityOwnershipListener listener)

Specified by:

registerListener in interface DOMEntityOwnershipService

Specified by:

registerListener in interface GenericEntityOwnershipService<YangInstanceIdentifier,DOMEntity,DOMEntityOwnershipListener>

getOwnershipState

public Optional<EntityOwnershipState> getOwnershipState(DOMEntity entity)

Specified by:

getOwnershipState in interface DOMEntityOwnershipService

Specified by:

getOwnershipState in interface GenericEntityOwnershipService<YangInstanceIdentifier,DOMEntity,DOMEntityOwnershipListener>

isCandidateRegistered

public boolean isCandidateRegistered(DOMEntity forEntity)

Specified by:

isCandidateRegistered in interface DOMEntityOwnershipService

Specified by:

isCandidateRegistered in interface GenericEntityOwnershipService<YangInstanceIdentifier,DOMEntity,DOMEntityOwnershipListener>

activateDataCenter

public ListenableFuture<Empty> activateDataCenter()

Description copied from interface: DataCenterControl

Activates the Entity Ownership Service in the datacenter that this method is called.

Specified by:

activateDataCenter in interface DataCenterControl

Returns:

Completion future

deactivateDataCenter

public ListenableFuture<Empty> deactivateDataCenter()

Description copied from interface: DataCenterControl

Deactivates the Entity Ownership Service in the datacenter that this method is called.

Specified by:

deactivateDataCenter in interface DataCenterControl

Returns:

Completion future

getEntities

public ListenableFuture<RpcResult<GetEntitiesOutput>> getEntities(GetEntitiesInput input)

Description copied from interface: OdlEntityOwnersService

Invoke get-entities RPC.

Specified by:

getEntities in interface OdlEntityOwnersService

Parameters:

input - of get-entities

Returns:

output of get-entities

getEntity

public ListenableFuture<RpcResult<GetEntityOutput>> getEntity(GetEntityInput input)

Description copied from interface: OdlEntityOwnersService

Invoke get-entity RPC.

Specified by:

getEntity in interface OdlEntityOwnersService

Parameters:

input - of get-entity

Returns:

output of get-entity

getEntityOwner

public ListenableFuture<RpcResult<GetEntityOwnerOutput>> getEntityOwner(GetEntityOwnerInput input)

Description copied from interface: OdlEntityOwnersService

Invoke get-entity-owner RPC.

Specified by:

getEntityOwner in interface OdlEntityOwnersService

Parameters:

input - of get-entity-owner

Returns:

output of get-entity-owner