496069d0a198b354ca8a671000366a229209ab97
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / shardstrategy / ShardStrategy.java
1 /*
2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8
9 package org.opendaylight.controller.cluster.datastore.shardstrategy;
10
11 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
12
13 /**
14  * The role of ShardStrategy is to figure out which shards a given piece of data belongs to.
15  */
16 public interface ShardStrategy {
17     /**
18      * Find the name of the shard in which the data pointed to by the specified path belongs in.
19      *
20      * <p>
21      * Should return the name of the default shard DefaultShardStrategy.DEFAULT_SHARD
22      * if no matching shard was found
23      *
24      * @param path the location of the data in the logical tree
25      * @return the corresponding shard name.
26      */
27     String findShard(YangInstanceIdentifier path);
28 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.