org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/remote/IRemoteSystemProxy.java

   1 /**********************************************************************
   2  * Copyright (c) 2012 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  **********************************************************************/
  12 package org.eclipse.linuxtools.internal.lttng2.ui.views.control.remote;
  13
  14 import org.eclipse.core.commands.ExecutionException;
  15 import org.eclipse.rse.core.model.IRSECallback;
  16 import org.eclipse.rse.core.subsystems.ICommunicationsListener;
  17 import org.eclipse.rse.core.subsystems.ISubSystem;
  18 import org.eclipse.rse.services.shells.IShellService;
  19 import org.eclipse.rse.services.terminals.ITerminalService;
  20 import org.eclipse.rse.subsystems.files.core.servicesubsystem.IFileServiceSubSystem;
  21
  22 /**
  23  * <p>
  24  * Remote System Proxy interface.
  25  * </p>
  26  *
  27  * @author Bernd Hufmann
  28  */
  29 public interface IRemoteSystemProxy {
  30
  31     // ------------------------------------------------------------------------
  32     // Operations
  33     // ------------------------------------------------------------------------
  34     /**
  35      * Find the first shell service.
  36      *
  37      * @return shell service object, or <code>null</code> if not found.
  38      */
  39     public IShellService getShellService();
  40
  41     /**
  42      * Find the first terminal service.
  43      *
  44      * @return shell service object, or <code>null</code> if not found.
  45      */
  46     public ITerminalService getTerminalService();
  47
  48     /**
  49      * Find the first IShellServiceSubSystem service.
  50      *
  51      * @return shell service subsystem, or <code>null</code> if not found.
  52      */
  53     public ISubSystem getShellServiceSubSystem();
  54
  55     /**
  56      * Find the first ITerminalServiceSubSystem service.
  57      *
  58      * @return shell service subsystem, or <code>null</code> if not found.
  59      */
  60     public ISubSystem getTerminalServiceSubSystem();
  61
  62     /**
  63      * Finds the File Service Subsystem.
  64      *
  65      * @return file service subsystem, or <code>null</code> if not found.
  66      */
  67     public IFileServiceSubSystem getFileServiceSubSystem();
  68
  69     /**
  70      * Connects the shell service sub system.
  71      *
  72      * @param callback
  73      *            - call-back method being called when connection was finished
  74      * @throws ExecutionException
  75      *             If the connection fails
  76      */
  77     public void connect(IRSECallback callback) throws ExecutionException;
  78
  79     /**
  80      * Disconnects from the shell service sub system.
  81      *
  82      * @throws ExecutionException
  83      *             If the disconnect command fails
  84      */
  85     public void disconnect() throws ExecutionException;
  86
  87     /**
  88      * Creates a command shell.
  89      *
  90      * @return the command shell implementation
  91      * @throws ExecutionException
  92      *             If the command fails
  93      */
  94     public ICommandShell createCommandShell() throws ExecutionException;
  95
  96     /**
  97      * Method to add a communication listener to the connector service defined
  98      * for the given connection.
  99      *
 100      * @param listener
 101      *            - listener to add
 102      */
 103     public void addCommunicationListener(ICommunicationsListener listener);
 104
 105     /**
 106      * Method to remove a communication listener from the connector service
 107      * defined for the given connection.
 108      *
 109      * @param listener
 110      *            - listener to remove
 111      */
 112     public void removeCommunicationListener(ICommunicationsListener listener);
 113
 114 }