org.opendaylight.controller.cluster.dom.api

Interface CDSShardAccess

@Beta
public interface CDSShardAccess

Unprivileged access interface to shard information. Provides read-only access to operational details about a CDS shard.

Author:

Robert Varga

Method Summary

Modifier and Type	Method and Description
LeaderLocation	getLeaderLocation() Return the shard leader location relative to the local node.
org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier	getShardIdentifier() Return the shard identifier.
CompletionStage<Void>	makeLeaderLocal() Request the shard leader to be moved to the local node.
<L extends LeaderLocationListener> LeaderLocationListenerRegistration<L>	registerLeaderLocationListener(L listener) Register a listener to shard location changes.

Method Detail

getShardIdentifier

@Nonnull
org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier getShardIdentifier()

Return the shard identifier.

Returns:

Shard identifier.

Throws:

IllegalStateException - if the CDSDataTreeProducer from which the associated CDSDataTreeProducer is no longer valid.

getLeaderLocation

@Nonnull
LeaderLocation getLeaderLocation()

Return the shard leader location relative to the local node.

Returns:

Shard leader location.

Throws:

IllegalStateException - if the CDSDataTreeProducer from which the associated CDSDataTreeProducer is no longer valid.

makeLeaderLocal

@Nonnull
CompletionStage<Void> makeLeaderLocal()

Request the shard leader to be moved to the local node. The request will be evaluated against shard state and satisfied if leader movement is possible. If current shard policy or state prevents the movement from happening, the returned CompletionStage will report an exception.

This is a one-time operation, which does not prevent further movement happening in future. Even if this request succeeds, there is no guarantee that the leader will remain local in face of failures, shutdown or any future movement requests from other nodes.

Note that due to asynchronous nature of CDS, the leader may no longer be local by the time the returned CompletionStage reports success.

Returns:

A CompletionStage representing the request.

Throws:

IllegalStateException - if the CDSDataTreeProducer from which the associated CDSDataTreeProducer is no longer valid.

registerLeaderLocationListener

@Nonnull
<L extends LeaderLocationListener> LeaderLocationListenerRegistration<L> registerLeaderLocationListener(@Nonnull
                                                                                                                 L listener)

Register a listener to shard location changes. Each listener object can be registered at most once.

Parameters:

listener - Listener object

Returns:

A LeaderLocationListenerRegistration for the listener.

Throws:

IllegalArgumentException - if the specified listener is already registered.

IllegalStateException - if the CDSDataTreeProducer from which the associated CDSDataTreeProducer is no longer valid.

NullPointerException - if listener is null.