opendaylight/netconf/netconf-cli/src/main/java/org/opendaylight/controller/netconf/cli/commands/Command.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.netconf.cli.commands;
   9
  10 import com.google.common.base.Optional;
  11 import org.opendaylight.controller.netconf.cli.commands.input.Input;
  12 import org.opendaylight.controller.netconf.cli.commands.input.InputDefinition;
  13 import org.opendaylight.controller.netconf.cli.commands.output.Output;
  14 import org.opendaylight.controller.netconf.cli.commands.output.OutputDefinition;
  15 import org.opendaylight.controller.netconf.cli.io.ConsoleContext;
  16 import org.opendaylight.yangtools.yang.common.QName;
  17
  18 /**
  19  * Local command e.g. help or remote rpc e.g. get-config must conform to this interface
  20  */
  21 public interface Command {
  22
  23     Output invoke(Input inputArgs) throws CommandInvocationException;
  24
  25     InputDefinition getInputDefinition();
  26
  27     OutputDefinition getOutputDefinition();
  28
  29     QName getCommandId();
  30
  31     Optional<String> getCommandDescription();
  32
  33     ConsoleContext getConsoleContext();
  34 }