lttng: fix sonar warnings about redundant modifier in interfaces

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng2.ui / src / org / eclipse / linuxtools / internal / lttng2 / ui / views / control / remote / IRemoteSystemProxy.java

diff --git a/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/remote/IRemoteSystemProxy.java b/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/remote/IRemoteSystemProxy.java
index 697a5a1dd8d01ca98cb32cc9f2b934fcac115803..295a5cdf877a88d0e3692e29ebd55d5632375227 100644 (file)
--- a/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/remote/IRemoteSystemProxy.java
+++ b/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/remote/IRemoteSystemProxy.java
@@ -1,18 +1,17 @@
 /**********************************************************************
- * Copyright (c) 2012 Ericsson
- * 
+ * Copyright (c) 2012, 2013 Ericsson
+ *
  * All rights reserved. This program and the accompanying materials are
  * made available under the terms of the Eclipse Public License v1.0 which
  * accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
- * 
- * Contributors: 
+ *
+ * Contributors:
  *   Bernd Hufmann - Initial API and implementation
  **********************************************************************/
 package org.eclipse.linuxtools.internal.lttng2.ui.views.control.remote;
 
 import org.eclipse.core.commands.ExecutionException;
-import org.eclipse.linuxtools.internal.lttng2.ui.views.control.service.ICommandShell;
 import org.eclipse.rse.core.model.IRSECallback;
 import org.eclipse.rse.core.subsystems.ICommunicationsListener;
 import org.eclipse.rse.core.subsystems.ISubSystem;
@@ -21,90 +20,114 @@ import org.eclipse.rse.services.terminals.ITerminalService;
 import org.eclipse.rse.subsystems.files.core.servicesubsystem.IFileServiceSubSystem;
 
 /**
- * <b><u>IRemoteSystemProxy</u></b>
  * <p>
  * Remote System Proxy interface.
  * </p>
+ *
+ * @author Bernd Hufmann
  */
 public interface IRemoteSystemProxy {
 
+    // ------------------------------------------------------------------------
+    // Constants
+    // ------------------------------------------------------------------------
+    /**
+     * Invalid port number for IP based connections.
+     */
+    public final static int INVALID_PORT_NUMBER = -1;
+
     // ------------------------------------------------------------------------
     // Operations
     // ------------------------------------------------------------------------
     /**
      * Find the first shell service.
-     * 
+     *
      * @return shell service object, or <code>null</code> if not found.
      */
-    public IShellService getShellService();
+    IShellService getShellService();
 
     /**
      * Find the first terminal service.
-     * 
+     *
      * @return shell service object, or <code>null</code> if not found.
      */
-    public ITerminalService getTerminalService();
+    ITerminalService getTerminalService();
 
     /**
      * Find the first IShellServiceSubSystem service.
-     * 
+     *
      * @return shell service subsystem, or <code>null</code> if not found.
      */
-    public ISubSystem getShellServiceSubSystem();
+    ISubSystem getShellServiceSubSystem();
 
     /**
      * Find the first ITerminalServiceSubSystem service.
-     * 
-     * @param host the connection 
+     *
      * @return shell service subsystem, or <code>null</code> if not found.
      */
-    public ISubSystem getTerminalServiceSubSystem();
-    
+    ISubSystem getTerminalServiceSubSystem();
+
     /**
      * Finds the File Service Subsystem.
-     * @return file service subsystem, or <code>null</code> if not found. 
+     *
+     * @return file service subsystem, or <code>null</code> if not found.
      */
-    public IFileServiceSubSystem getFileServiceSubSystem();
-    
+    IFileServiceSubSystem getFileServiceSubSystem();
+
+    /**
+     * @return port of IP connection to be used
+     */
+    int getPort();
+
+    /**
+     * Sets the port of the IP connection.
+     * @param port - the IP port to set
+     */
+    void setPort(int port);
+
     /**
-     * Connects the shell service sub system. 
-     * 
-     * @param callback - call-back method being called when connection was finished
-     * @throws Exception
+     * Connects the shell service sub system.
+     *
+     * @param callback
+     *            - call-back method being called when connection was finished
+     * @throws ExecutionException
+     *             If the connection fails
      */
-    public void connect(IRSECallback callback) throws ExecutionException;
+    void connect(IRSECallback callback) throws ExecutionException;
 
     /**
-     * Disconnects from the shell service sub system. 
-     * 
-     * @throws Exception
+     * Disconnects from the shell service sub system.
+     *
+     * @throws ExecutionException
+     *             If the disconnect command fails
      */
-    public void disconnect() throws ExecutionException;
+    void disconnect() throws ExecutionException;
 
     /**
-     * Creates a command shell. 
-     * 
+     * Creates a command shell.
+     *
      * @return the command shell implementation
-     * @throws Exception
+     * @throws ExecutionException
+     *             If the command fails
      */
-    public ICommandShell createCommandShell() throws ExecutionException;
+    ICommandShell createCommandShell() throws ExecutionException;
 
     /**
-     * Method to add a communication listener to the connector service defined for 
-     * the given connection. 
-     * 
-     * @param listener - listener to add
-     * @throws Exception
+     * Method to add a communication listener to the connector service defined
+     * for the given connection.
+     *
+     * @param listener
+     *            - listener to add
      */
-    public void addCommunicationListener(ICommunicationsListener listener);
+    void addCommunicationListener(ICommunicationsListener listener);
 
     /**
-     * Method to remove a communication listener from the connector service defined for 
-     * the given connection. 
-     * 
-     * @param listener - listener to remove
-     * @throws Exception
+     * Method to remove a communication listener from the connector service
+     * defined for the given connection.
+     *
+     * @param listener
+     *            - listener to remove
      */
-    public void removeCommunicationListener(ICommunicationsListener listener);
+    void removeCommunicationListener(ICommunicationsListener listener);
 
 }
\ No newline at end of file