org.eclipse.tracecompass.lttng2.control.ui/src/org/eclipse/tracecompass/internal/lttng2/control/ui/views/remote/ICommandShell.java

   1 /**********************************************************************
   2  * Copyright (c) 2012, 2015 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Bernd Hufmann - Initial API and implementation
  11  *   Markus Schorn - Bug 448058: Use org.eclipse.remote in favor of RSE
  12  **********************************************************************/
  13 package org.eclipse.tracecompass.internal.lttng2.control.ui.views.remote;
  14
  15 import java.util.List;
  16
  17 import org.eclipse.core.commands.ExecutionException;
  18 import org.eclipse.core.runtime.IProgressMonitor;
  19
  20 /**
  21  * <p>
  22  * Interface for a command shell implementation
  23  * </p>
  24  *
  25  * @author Bernd Hufmann
  26  */
  27 public interface ICommandShell {
  28
  29     /**
  30      * Method to connect the command shell.
  31      *
  32      * @throws ExecutionException
  33      *             If the command fails
  34      */
  35     void connect() throws ExecutionException;
  36
  37     /**
  38      * Method to disconnect the command shell.
  39      */
  40     void disconnect();
  41
  42     /**
  43      * Method to execute a command on the command shell.
  44      *
  45      * @param command
  46      *            - the command to executed
  47      * @param monitor
  48      *            - a progress monitor
  49      * @return the command result
  50      * @throws ExecutionException
  51      *             If the command fails
  52      */
  53     ICommandResult executeCommand(List<String> command,
  54             IProgressMonitor monitor) throws ExecutionException;
  55 }