Introduce EntityOwnerSelectionStrategy

[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / entityownership / selectionstrategy / EntityOwnerSelectionStrategy.java

diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/entityownership/selectionstrategy/EntityOwnerSelectionStrategy.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/entityownership/selectionstrategy/EntityOwnerSelectionStrategy.java
new file mode 100644 (file)
index 0000000..dffbac5
--- /dev/null
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/entityownership/selectionstrategy/EntityOwnerSelectionStrategy.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
+package org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy;
+
+import java.util.Collection;
+
+/**
+ * An EntityOwnerSelectionStrategy is to be used by the EntityOwnershipShard to select a new owner from a collection
+ * of candidates
+ */
+public interface EntityOwnerSelectionStrategy {
+    /**
+     *
+     * @return the time in millis owner selection should be delayed
+     */
+    long selectionDelayInMillis();
+
+
+    /**
+     *
+     * @param viableCandidates the available candidates from which to choose the new owner
+     * @return the new owner
+     */
+    String newOwner(Collection<String> viableCandidates);
+}