8323215cbde86e65343d6c0f17fd10f1d9427da2
[mdsal.git] / dom / mdsal-dom-api / src / main / java / org / opendaylight / mdsal / dom / api / DOMDataTreeCommitCohortRegistry.java
1 /*
2  * Copyright (c) 2015 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 package org.opendaylight.mdsal.dom.api;
9
10 /**
11  * Commit Cohort registry for {@link DOMDataTreeWriteTransaction}. See {@link DOMDataTreeCommitCohort} for more details.
12  */
13 public interface DOMDataTreeCommitCohortRegistry extends DOMDataBroker.Extension {
14     /**
15      * Register commit cohort which will participate in three-phase commit protocols of
16      * {@link DOMDataTreeWriteTransaction}in data broker associated with this instance of extension.
17      *
18      * @param path Subtree path on which commit cohort operates.
19      * @param cohort Commit cohort
20      * @param <T> Cohort subclass
21      * @return Registaration object for DOM Data Three Commit cohort.
22      */
23     <T extends DOMDataTreeCommitCohort> DOMDataTreeCommitCohortRegistration<T> registerCommitCohort(
24             DOMDataTreeIdentifier path, T cohort);
25 }