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
   9 package org.opendaylight.mdsal.dom.api;
  10
  11 /**
  12  *
  13  * Commit Cohort registry for {@link DOMDataTreeWriteTransaction}.
  14  *
  15  * See {@link DOMDataTreeCommitCohort} for more details.
  16  *
  17  * @author Tony Tkacik &lt;ttkacik@cisco.com&gt;
  18  *
  19  */
  20 public interface DOMDataTreeCommitCohortRegistry extends DOMDataBrokerExtension {
  21
  22     /**
  23      * Register commit cohort which will participate in three-phase commit protocols of
  24      * {@link DOMDataTreeWriteTransaction}in data broker associated with this instance of extension.
  25      *
  26      * @param path Subtree path on which commit cohort operates.
  27      * @param cohort Commit cohort
  28      * @return Registaration object for DOM Data Three Commit cohort.
  29      */
  30     <T extends DOMDataTreeCommitCohort> DOMDataTreeCommitCohortRegistration<T> registerCommitCohort(
  31             DOMDataTreeIdentifier path, T cohort);
  32 }