opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncTransaction.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.Identifiable;
  11 import org.opendaylight.yangtools.concepts.Path;
  12
  13
  14 /**
  15  *
  16  * A common parent for all transactions which operate on a conceptual data tree.
  17  *
  18  * See derived transaction types for more concrete behavior:
  19  * <ul>
  20  * <li>{@link AsyncReadTransaction} - Read capabilities, user is able to read data from data tree</li>
  21  * <li>{@link AsyncWriteTransaction} - Write capabilities, user is able to propose changes to data tree</li>
  22  * <li>{@link AsyncReadWriteTransaction} - Read and Write capabilities, user is able to read state and to propose changes of state.</li>
  23  * </ul>
  24  *
  25  * <b>Implementation Note:</b> This interface is not intended to be implemented
  26  * by users of MD-SAL.
  27  *
  28  * @param <P> Type of path (subtree identifier), which represents location in tree
  29  * @param <D> Type of data (payload), which represents data payload
  30  */
  31 public interface AsyncTransaction<P extends Path<P>,D> extends //
  32     Identifiable<Object> {
  33
  34     @Override
  35     Object getIdentifier();
  36
  37
  38 }