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  * <b><u>IRemoteSystemProxy</u></b>
  24  * <p>
  25  * Remote System Proxy interface.
  26  * </p>
  27  */
  28 public interface IRemoteSystemProxy {
  29
  30     // ------------------------------------------------------------------------
  31     // Operations
  32     // ------------------------------------------------------------------------
  33     /**
  34      * Find the first shell service.
  35      *
  36      * @return shell service object, or <code>null</code> if not found.
  37      */
  38     public IShellService getShellService();
  39
  40     /**
  41      * Find the first terminal service.
  42      *
  43      * @return shell service object, or <code>null</code> if not found.
  44      */
  45     public ITerminalService getTerminalService();
  46
  47     /**
  48      * Find the first IShellServiceSubSystem service.
  49      *
  50      * @return shell service subsystem, or <code>null</code> if not found.
  51      */
  52     public ISubSystem getShellServiceSubSystem();
  53
  54     /**
  55      * Find the first ITerminalServiceSubSystem service.
  56      *
  57      * @param host the connection
  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      * @return file service subsystem, or <code>null</code> if not found.
  65      */
  66     public IFileServiceSubSystem getFileServiceSubSystem();
  67
  68     /**
  69      * Connects the shell service sub system.
  70      *
  71      * @param callback - call-back method being called when connection was finished
  72      * @throws Exception
  73      */
  74     public void connect(IRSECallback callback) throws ExecutionException;
  75
  76     /**
  77      * Disconnects from the shell service sub system.
  78      *
  79      * @throws Exception
  80      */
  81     public void disconnect() throws ExecutionException;
  82
  83     /**
  84      * Creates a command shell.
  85      *
  86      * @return the command shell implementation
  87      * @throws Exception
  88      */
  89     public ICommandShell createCommandShell() throws ExecutionException;
  90
  91     /**
  92      * Method to add a communication listener to the connector service defined for
  93      * the given connection.
  94      *
  95      * @param listener - listener to add
  96      * @throws Exception
  97      */
  98     public void addCommunicationListener(ICommunicationsListener listener);
  99
 100     /**
 101      * Method to remove a communication listener from the connector service defined for
 102      * the given connection.
 103      *
 104      * @param listener - listener to remove
 105      * @throws Exception
 106      */
 107     public void removeCommunicationListener(ICommunicationsListener listener);
 108
 109 }