dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMActionService.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.ListenableFuture;
  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.stmt.SchemaNodeIdentifier.Absolute;
  16
  17 /**
  18  * A {@link DOMService} which allows clients to invoke Actions. The conceptual model of this service is that
  19  * of a dynamic router, where the set of available Action services can change dynamically.
  20  */
  21 @Beta
  22 @NonNullByDefault
  23 public interface DOMActionService extends DOMService<DOMActionService, DOMActionService.Extension> {
  24     /**
  25      * Marker interface for extensions of {@link DOMActionService}.
  26      */
  27     interface Extension extends DOMService.Extension<DOMActionService, Extension> {
  28         // Marker interface
  29     }
  30
  31     /**
  32      * Initiate invocation of an Action. This method is guaranteed to not block on any external resources.
  33      *
  34      * @param type Absolute schema node identifier of the action to be invoked. This path refers to an effective action
  35      *             instantiated on top of the conceptual {@link StoreTreeNode}.
  36      * @param path {@link DOMDataTreeIdentifier} of parent data node which action attached to.
  37      * @param input Input argument
  38      * @return A FluentFuture which completes with the result of invocation
  39      * @throws NullPointerException if any of the arguments is null
  40      * @throws IllegalArgumentException if {@code path} is empty
  41      */
  42     ListenableFuture<? extends DOMActionResult> invokeAction(Absolute type, DOMDataTreeIdentifier path,
  43             ContainerNode input);
  44 }