org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/model/impl/TargetNodeComponent.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.model.impl;
  13
  14 import java.util.List;
  15
  16 import org.eclipse.core.commands.ExecutionException;
  17 import org.eclipse.core.runtime.IProgressMonitor;
  18 import org.eclipse.core.runtime.IStatus;
  19 import org.eclipse.core.runtime.Status;
  20 import org.eclipse.core.runtime.jobs.Job;
  21 import org.eclipse.linuxtools.internal.lttng2.core.control.model.TargetNodeState;
  22 import org.eclipse.linuxtools.internal.lttng2.ui.Activator;
  23 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.messages.Messages;
  24 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.ITraceControlComponent;
  25 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.property.TargetNodePropertySource;
  26 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.remote.ICommandShell;
  27 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.remote.IRemoteSystemProxy;
  28 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.remote.RemoteSystemProxy;
  29 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.service.ILttngControlService;
  30 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.service.LTTngControlServiceFactory;
  31 import org.eclipse.rse.core.RSECorePlugin;
  32 import org.eclipse.rse.core.model.IHost;
  33 import org.eclipse.rse.core.model.IRSECallback;
  34 import org.eclipse.rse.core.model.ISystemRegistry;
  35 import org.eclipse.rse.core.subsystems.CommunicationsEvent;
  36 import org.eclipse.rse.core.subsystems.ICommunicationsListener;
  37 import org.eclipse.swt.graphics.Image;
  38 import org.eclipse.ui.views.properties.IPropertySource;
  39
  40 /**
  41  * <p>
  42  * Implementation of the trace node component.
  43  * </p>
  44  *
  45  * @author Bernd Hufmann
  46  */
  47 public class TargetNodeComponent extends TraceControlComponent implements ICommunicationsListener {
  48
  49     // ------------------------------------------------------------------------
  50     // Constants
  51     // ------------------------------------------------------------------------
  52     /**
  53      * Path to icon file for this component (state connected).
  54      */
  55     public static final String TARGET_NODE_CONNECTED_ICON_FILE = "icons/obj16/target_connected.gif"; //$NON-NLS-1$
  56     /**
  57      * Path to icon file for this component (state disconnected).
  58      */
  59     public static final String TARGET_NODE_DISCONNECTED_ICON_FILE = "icons/obj16/target_disconnected.gif"; //$NON-NLS-1$
  60
  61     // ------------------------------------------------------------------------
  62     // Attributes
  63     // ------------------------------------------------------------------------
  64     /**
  65      * The node connection state.
  66      */
  67     private TargetNodeState fState = TargetNodeState.DISCONNECTED;
  68     /**
  69      * The image to be displayed in state disconnected.
  70      */
  71     private Image fDisconnectedImage = null;
  72     /**
  73      * The connection implementation.
  74      */
  75     private IHost fHost = null;
  76     /**
  77      * The remote proxy implementation.
  78      */
  79     private IRemoteSystemProxy fRemoteProxy = null;
  80     /**
  81      * The control service for LTTng specific commands.
  82      */
  83     private ILttngControlService fService = null;
  84     /**
  85      * The command shell for issuing commands.
  86      */
  87     private ICommandShell fShell = null;
  88
  89     // ------------------------------------------------------------------------
  90     // Constructors
  91     // ------------------------------------------------------------------------
  92     /**
  93      * Constructor
  94      * @param name - the name of the component
  95      * @param parent - the parent of the component
  96      * @param host - the host connection implementation
  97      * @param proxy - the remote proxy implementation
  98      */
  99     public TargetNodeComponent(String name, ITraceControlComponent parent, IHost host, IRemoteSystemProxy proxy) {
 100         super(name, parent);
 101         setImage(TARGET_NODE_CONNECTED_ICON_FILE);
 102         fDisconnectedImage = Activator.getDefault().loadIcon(TARGET_NODE_DISCONNECTED_ICON_FILE);
 103         fHost = host;
 104         fRemoteProxy = proxy;
 105         setToolTip(fHost.getHostName());
 106     }
 107
 108     /**
 109      * Constructor (using default proxy)
 110      * @param name - the name of the component
 111      * @param parent - the parent of the component
 112      * @param host - the host connection implementation
 113      */
 114     public TargetNodeComponent(String name, ITraceControlComponent parent, IHost host) {
 115         this(name, parent, host, new RemoteSystemProxy(host));
 116     }
 117
 118     // ------------------------------------------------------------------------
 119     // Accessors
 120     // ------------------------------------------------------------------------
 121     /*
 122      * (non-Javadoc)
 123      * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TraceControlComponent#getImage()
 124      */
 125     @Override
 126     public Image getImage() {
 127         if (fState == TargetNodeState.CONNECTED) {
 128             return super.getImage();
 129         }
 130         return fDisconnectedImage;
 131     }
 132
 133     /*
 134      * (non-Javadoc)
 135      * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TraceControlComponent#getTargetNodeState()
 136      */
 137     @Override
 138     public TargetNodeState getTargetNodeState() {
 139         return fState;
 140     }
 141
 142     /*
 143      * (non-Javadoc)
 144      * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TraceControlComponent#setTargetNodeState(org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.ITraceControlComponent.TargetNodeState)
 145      */
 146     @Override
 147     public void setTargetNodeState(TargetNodeState state) {
 148         fState = state;
 149         fireComponentChanged(TargetNodeComponent.this);
 150     }
 151
 152     /*
 153      * (non-Javadoc)
 154      * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TraceControlComponent#getControlService()
 155      */
 156     @Override
 157     public ILttngControlService getControlService() {
 158         return fService;
 159     }
 160
 161     /*
 162      * (non-Javadoc)
 163      * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TraceControlComponent#setControlService(org.eclipse.linuxtools.internal.lttng2.ui.views.control.service.ILttngControlService)
 164      */
 165     @Override
 166     public void setControlService(ILttngControlService service) {
 167         fService = service;
 168     }
 169
 170     /*
 171      * (non-Javadoc)
 172      * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TraceControlComponent#getAdapter(java.lang.Class)
 173      */
 174     @Override
 175     public Object getAdapter(Class adapter) {
 176         if (adapter == IPropertySource.class) {
 177             return new TargetNodePropertySource(this);
 178         }
 179         return null;
 180     }
 181
 182     /**
 183      * @return remote host name
 184      */
 185     public String getHostName() {
 186         return fHost.getHostName();
 187     }
 188
 189     /**
 190      * @return remote system proxy implementation
 191      */
 192     public IRemoteSystemProxy getRemoteSystemProxy() {
 193         return fRemoteProxy;
 194     }
 195
 196     /**
 197      * @return all available sessions.
 198      */
 199     public TraceSessionComponent[] getSessions() {
 200         List<ITraceControlComponent> compenents = getChildren(TraceSessionGroup.class);
 201         if (compenents.size() > 0) {
 202             TraceSessionGroup group = (TraceSessionGroup)compenents.get(0);
 203             List<ITraceControlComponent> sessions = group.getChildren(TraceSessionComponent.class);
 204             return sessions.toArray(new TraceSessionComponent[sessions.size()]);
 205         }
 206         return new TraceSessionComponent[0];
 207     }
 208
 209     /**
 210      * @return node version
 211      */
 212     public String getNodeVersion() {
 213         // Control service is null during connection to node
 214         if (getControlService() != null) {
 215             return getControlService().getVersion();
 216         }
 217         return ""; //$NON-NLS-1$
 218     }
 219
 220     /**
 221      * Returns if node supports filtering of events
 222      * @return <code>true</code> if node supports filtering else <code>false</code>
 223      */
 224     public boolean isEventFilteringSupported() {
 225         return getControlService().isVersionSupported("2.1.0"); //$NON-NLS-1$
 226     }
 227
 228     /**
 229      * Returns if node supports networks streaming or not
 230      * @return <code>true</code> if node supports filtering else <code>false</code>
 231      *
 232      */
 233     public boolean isNetworkStreamingSupported() {
 234         return getControlService().isVersionSupported("2.1.0"); //$NON-NLS-1$
 235     }
 236
 237     // ------------------------------------------------------------------------
 238     // Operations
 239     // ------------------------------------------------------------------------
 240
 241    /*
 242     * @see org.eclipse.rse.core.subsystems.ICommunicationsListener#communicationsStateChange(org.eclipse.rse.core.subsystems.CommunicationsEvent)
 243     */
 244    @Override
 245    public void communicationsStateChange(CommunicationsEvent e) {
 246        if (e.getState() == CommunicationsEvent.AFTER_DISCONNECT ||
 247                e.getState() == CommunicationsEvent.CONNECTION_ERROR) {
 248            handleDisconnected();
 249        } if ((e.getState() == CommunicationsEvent.AFTER_CONNECT) && (fState != TargetNodeState.CONNECTING)) {
 250            handleConnected();
 251        }
 252    }
 253
 254    /* (non-Javadoc)
 255     * @see org.eclipse.rse.core.subsystems.ICommunicationsListener#isPassiveCommunicationsListener()
 256     */
 257    @Override
 258    public boolean isPassiveCommunicationsListener() {
 259        return true;
 260    }
 261
 262    /*
 263     * (non-Javadoc)
 264     * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.TraceControlComponent#dispose()
 265     */
 266    @Override
 267    public void dispose() {
 268        fRemoteProxy.removeCommunicationListener(this);
 269    }
 270
 271    /**
 272     * Method to connect this node component to the remote target node.
 273     */
 274    public void connect() {
 275        if (fState == TargetNodeState.DISCONNECTED) {
 276            try {
 277                setTargetNodeState(TargetNodeState.CONNECTING);
 278                fRemoteProxy.connect(new IRSECallback() {
 279                    @Override
 280                    public void done(IStatus status, Object result) {
 281                        // Note: result might be null!
 282                        if(status.isOK()) {
 283                            handleConnected();
 284                        } else {
 285                            handleDisconnected();
 286                        }
 287                    }
 288                });
 289            } catch (Exception e) {
 290                setTargetNodeState(TargetNodeState.DISCONNECTED);
 291                Activator.getDefault().logError(Messages.TraceControl_ConnectionFailure + " (" + getName() + "). \n", e); //$NON-NLS-1$ //$NON-NLS-2$
 292            }
 293        }
 294     }
 295
 296    /**
 297     * Method to disconnect this node component to the remote target node.
 298     */
 299     public void disconnect() {
 300         if (fState == TargetNodeState.CONNECTED) {
 301             try {
 302                 setTargetNodeState(TargetNodeState.DISCONNECTING);
 303                 fRemoteProxy.disconnect();
 304             } catch (Exception e) {
 305                 Activator.getDefault().logError(Messages.TraceControl_DisconnectionFailure + " (" + getName() + "). \n", e); //$NON-NLS-1$ //$NON-NLS-2$
 306             } finally {
 307                 handleDisconnected();
 308             }
 309         }
 310     }
 311
 312     /**
 313      * Retrieves the trace configuration from the target node and populates the
 314      * information in the tree model. The execution is done in a own job.
 315      */
 316     public void getConfigurationFromNode() {
 317         Job job = new Job(Messages.TraceControl_RetrieveNodeConfigurationJob) {
 318             @Override
 319             protected IStatus run(IProgressMonitor monitor) {
 320
 321                 try {
 322                     // Get provider information from node
 323                     TraceProviderGroup providerGroup = new TraceProviderGroup(Messages.TraceControl_ProviderDisplayName, TargetNodeComponent.this);
 324                     addChild(providerGroup);
 325                     providerGroup.getProviderFromNode(monitor);
 326
 327                     // Get session information from node
 328                     TraceSessionGroup sessionGroup = new TraceSessionGroup(Messages.TraceControl_AllSessionsDisplayName, TargetNodeComponent.this);
 329                     addChild(sessionGroup);
 330                     sessionGroup.getSessionsFromNode(monitor);
 331                 } catch (ExecutionException e) {
 332                     removeAllChildren();
 333                     return new Status(IStatus.ERROR, Activator.PLUGIN_ID, Messages.TraceControl_ListSessionFailure, e);
 334                 }
 335
 336                 return Status.OK_STATUS;
 337             }
 338         };
 339         job.setUser(true);
 340         job.schedule();
 341     }
 342
 343     /**
 344      * Refresh the node configuration
 345      */
 346     public void refresh() {
 347         removeAllChildren();
 348         getConfigurationFromNode();
 349     }
 350
 351     /**
 352      * Deregisters host from registry.
 353      */
 354     public void deregister() {
 355         ISystemRegistry registry = RSECorePlugin.getTheSystemRegistry();
 356         registry.deleteHost(fHost);
 357     }
 358
 359     // ------------------------------------------------------------------------
 360     // Helper function
 361     // ------------------------------------------------------------------------
 362     /**
 363      * @return returns the control service for LTTng specific commands.
 364      * @throws ExecutionException
 365      */
 366     private ILttngControlService createControlService() throws ExecutionException {
 367         if (fShell == null) {
 368             fShell = fRemoteProxy.createCommandShell();
 369             fRemoteProxy.addCommunicationListener(this);
 370         }
 371         fService = LTTngControlServiceFactory.getInstance().getLttngControlService(fShell);
 372         return fService;
 373     }
 374
 375     /**
 376      * Handles the connected event.
 377      */
 378     private void handleConnected() {
 379         setTargetNodeState(TargetNodeState.CONNECTED);
 380         try {
 381             createControlService();
 382             getConfigurationFromNode();
 383         } catch (ExecutionException e) {
 384             Activator.getDefault().logError(Messages.TraceControl_ListSessionFailure + " (" + getName() + "). \n", e); //$NON-NLS-1$ //$NON-NLS-2$
 385         }
 386     }
 387
 388     /**
 389      * Handles the disconnected event.
 390      */
 391     private void handleDisconnected() {
 392         removeAllChildren();
 393         setTargetNodeState(TargetNodeState.DISCONNECTED);
 394         fShell = null;
 395         fService = null;
 396     }
 397 }