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     @SuppressWarnings("rawtypes")
 175     @Override
 176     public Object getAdapter(Class adapter) {
 177         if (adapter == IPropertySource.class) {
 178             return new TargetNodePropertySource(this);
 179         }
 180         return null;
 181     }
 182
 183     /**
 184      * @return remote host name
 185      */
 186     public String getHostName() {
 187         return fHost.getHostName();
 188     }
 189
 190     /**
 191      * @return remote system proxy implementation
 192      */
 193     public IRemoteSystemProxy getRemoteSystemProxy() {
 194         return fRemoteProxy;
 195     }
 196
 197     /**
 198      * @return all available sessions.
 199      */
 200     public TraceSessionComponent[] getSessions() {
 201         List<ITraceControlComponent> compenents = getChildren(TraceSessionGroup.class);
 202         if (compenents.size() > 0) {
 203             TraceSessionGroup group = (TraceSessionGroup)compenents.get(0);
 204             List<ITraceControlComponent> sessions = group.getChildren(TraceSessionComponent.class);
 205             return sessions.toArray(new TraceSessionComponent[sessions.size()]);
 206         }
 207         return new TraceSessionComponent[0];
 208     }
 209
 210     // ------------------------------------------------------------------------
 211     // Operations
 212     // ------------------------------------------------------------------------
 213
 214    /*
 215     * @see org.eclipse.rse.core.subsystems.ICommunicationsListener#communicationsStateChange(org.eclipse.rse.core.subsystems.CommunicationsEvent)
 216     */
 217    @Override
 218    public void communicationsStateChange(CommunicationsEvent e) {
 219        if (e.getState() == CommunicationsEvent.AFTER_DISCONNECT ||
 220                e.getState() == CommunicationsEvent.CONNECTION_ERROR) {
 221            handleDisconnected();
 222        } if ((e.getState() == CommunicationsEvent.AFTER_CONNECT) && (fState != TargetNodeState.CONNECTING)) {
 223            handleConnected();
 224        }
 225    }
 226
 227    /* (non-Javadoc)
 228     * @see org.eclipse.rse.core.subsystems.ICommunicationsListener#isPassiveCommunicationsListener()
 229     */
 230    @Override
 231    public boolean isPassiveCommunicationsListener() {
 232        return true;
 233    }
 234
 235    /*
 236     * (non-Javadoc)
 237     * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.TraceControlComponent#dispose()
 238     */
 239    @Override
 240    public void dispose() {
 241        fRemoteProxy.removeCommunicationListener(this);
 242    }
 243
 244    /**
 245     * Method to connect this node component to the remote target node.
 246     */
 247    public void connect() {
 248        if (fState == TargetNodeState.DISCONNECTED) {
 249            try {
 250                setTargetNodeState(TargetNodeState.CONNECTING);
 251                fRemoteProxy.connect(new IRSECallback() {
 252                    @Override
 253                    public void done(IStatus status, Object result) {
 254                        // Note: result might be null!
 255                        if(status.isOK()) {
 256                            handleConnected();
 257                        } else {
 258                            handleDisconnected();
 259                        }
 260                    }
 261                });
 262            } catch (Exception e) {
 263                setTargetNodeState(TargetNodeState.DISCONNECTED);
 264                Activator.getDefault().logError(Messages.TraceControl_ConnectionFailure + " (" + getName() + "). \n", e); //$NON-NLS-1$ //$NON-NLS-2$
 265            }
 266        }
 267     }
 268
 269    /**
 270     * Method to disconnect this node component to the remote target node.
 271     */
 272     public void disconnect() {
 273         if (fState == TargetNodeState.CONNECTED) {
 274             try {
 275                 setTargetNodeState(TargetNodeState.DISCONNECTING);
 276                 fRemoteProxy.disconnect();
 277             } catch (Exception e) {
 278                 Activator.getDefault().logError(Messages.TraceControl_DisconnectionFailure + " (" + getName() + "). \n", e); //$NON-NLS-1$ //$NON-NLS-2$
 279             } finally {
 280                 handleDisconnected();
 281             }
 282         }
 283     }
 284
 285     /**
 286      * Retrieves the trace configuration from the target node and populates the
 287      * information in the tree model. The execution is done in a own job.
 288      */
 289     public void getConfigurationFromNode() {
 290         Job job = new Job(Messages.TraceControl_RetrieveNodeConfigurationJob) {
 291             @Override
 292             protected IStatus run(IProgressMonitor monitor) {
 293
 294                 try {
 295                     // Get provider information from node
 296                     TraceProviderGroup providerGroup = new TraceProviderGroup(Messages.TraceControl_ProviderDisplayName, TargetNodeComponent.this);
 297                     addChild(providerGroup);
 298                     providerGroup.getProviderFromNode(monitor);
 299
 300                     // Get session information from node
 301                     TraceSessionGroup sessionGroup = new TraceSessionGroup(Messages.TraceControl_AllSessionsDisplayName, TargetNodeComponent.this);
 302                     addChild(sessionGroup);
 303                     sessionGroup.getSessionsFromNode(monitor);
 304                 } catch (ExecutionException e) {
 305                     removeAllChildren();
 306                     return new Status(IStatus.ERROR, Activator.PLUGIN_ID, Messages.TraceControl_ListSessionFailure, e);
 307                 }
 308
 309                 return Status.OK_STATUS;
 310             }
 311         };
 312         job.setUser(true);
 313         job.schedule();
 314     }
 315
 316     /**
 317      * Refresh the node configuration
 318      */
 319     public void refresh() {
 320         removeAllChildren();
 321         getConfigurationFromNode();
 322     }
 323
 324     /**
 325      * Deregisters host from registry.
 326      */
 327     public void deregister() {
 328         ISystemRegistry registry = RSECorePlugin.getTheSystemRegistry();
 329         registry.deleteHost(fHost);
 330     }
 331
 332     // ------------------------------------------------------------------------
 333     // Helper function
 334     // ------------------------------------------------------------------------
 335     /**
 336      * @return returns the control service for LTTng specific commands.
 337      * @throws ExecutionException
 338      */
 339     private ILttngControlService createControlService() throws ExecutionException {
 340         if (fShell == null) {
 341             fShell = fRemoteProxy.createCommandShell();
 342             fRemoteProxy.addCommunicationListener(this);
 343         }
 344         fService = LTTngControlServiceFactory.getInstance().getLttngControlService(fShell);
 345         return fService;
 346     }
 347
 348     /**
 349      * Handles the connected event.
 350      */
 351     private void handleConnected() {
 352         setTargetNodeState(TargetNodeState.CONNECTED);
 353         try {
 354             createControlService();
 355             getConfigurationFromNode();
 356         } catch (ExecutionException e) {
 357             Activator.getDefault().logError(Messages.TraceControl_ListSessionFailure + " (" + getName() + "). \n", e); //$NON-NLS-1$ //$NON-NLS-2$
 358         }
 359     }
 360
 361     /**
 362      * Handles the disconnected event.
 363      */
 364     private void handleDisconnected() {
 365         removeAllChildren();
 366         setTargetNodeState(TargetNodeState.DISCONNECTED);
 367         fShell = null;
 368         fService = null;
 369     }
 370 }