dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMActionImplementation.java

   1 /*
   2  * Copyright (c) 2018 Pantheon Technologies, s.r.o. 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 import com.google.common.annotations.Beta;
  11 import com.google.common.util.concurrent.FluentFuture;
  12 import org.eclipse.jdt.annotation.NonNullByDefault;
  13 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  14 import org.opendaylight.yangtools.yang.data.api.schema.tree.StoreTreeNode;
  15 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  16
  17 /**
  18  * Interface implemented by an individual operation implementation. This API allows for dispatch implementations, e.g.
  19  * an individual object handling a multitude of operations.
  20  *
  21  * @author Robert Varga
  22  */
  23 @Beta
  24 @FunctionalInterface
  25 @NonNullByDefault
  26 public interface DOMActionImplementation {
  27     /**
  28      * Initiate invocation of the action. Implementations of this method are expected to not block.
  29      *
  30      * @param type SchemaPath of the action to be invoked. This path refers to an effective action instantiated on top
  31      *             of the conceptual {@link StoreTreeNode}.
  32      * @param path {@link DOMDataTreeIdentifier} of parent data node which action attached to.
  33      * @param input Input arguments
  34      * @return A FluentFuture which completes with the result of invocation
  35      * @throws NullPointerException if any of the arguments is null
  36      */
  37     FluentFuture<? extends DOMActionResult> invokeAction(SchemaPath type, DOMDataTreeIdentifier path,
  38             ContainerNode input);
  39
  40     /**
  41      * Return the relative invocation cost of this implementation. Default implementation returns 0.
  42      *
  43      * @return Non-negative cost of invoking this implementation.
  44      */
  45     default long invocationCost() {
  46         return 0;
  47     }
  48 }