48be277b7efccf96fbd84757b35b1358fbbc1dc0
[controller.git] / opendaylight / md-sal / sal-common-api / src / main / java / org / opendaylight / controller / md / sal / common / api / data / AsyncConfigurationCommitCoordinator.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 package org.opendaylight.controller.md.sal.common.api.data;
9
10 import org.opendaylight.yangtools.concepts.ObjectRegistration;
11 import org.opendaylight.yangtools.concepts.Path;
12
13 /**
14  * Three Phase Commit Coordinator with support of user-supplied commit cohorts
15  * which participates in three-phase commit protocols.
16  *
17  * @param <P>
18  *            Type of path (subtree identifier), which represents location in
19  *            tree
20  * @param <D>
21  *            Type of data (payload), which represents data payload
22  */
23 @Deprecated
24 public interface AsyncConfigurationCommitCoordinator<P extends Path<P>, D> {
25     /**
26      * Register configuration commit handler for particular subtree. Configuration commit handler is invoked for all
27      * write transactions which modifies <code>subtree</code>
28      *
29      * @param subtree Subtree which configuration commit handler is interested it
30      * @param commitHandler Instance of user-provided commit handler
31      * @return Registration object representing this registration. Invoking {@link ObjectRegistration#close()}
32      *         will unregister configuration commit handler.
33      */
34     <C extends AsyncConfigurationCommitCohort<P, D>> ObjectRegistration<C> registerConfigurationCommitHandler(
35             P subtree, C commitHandler);
36 }

©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.