org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/handlers/BaseEnableChannelHandler.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.handlers;
  13
  14 import java.util.ArrayList;
  15 import java.util.List;
  16
  17 import org.eclipse.core.commands.ExecutionEvent;
  18 import org.eclipse.core.commands.ExecutionException;
  19 import org.eclipse.core.runtime.IProgressMonitor;
  20 import org.eclipse.core.runtime.IStatus;
  21 import org.eclipse.core.runtime.Status;
  22 import org.eclipse.core.runtime.jobs.Job;
  23 import org.eclipse.jface.window.Window;
  24 import org.eclipse.linuxtools.internal.lttng2.core.control.model.IChannelInfo;
  25 import org.eclipse.linuxtools.internal.lttng2.ui.Activator;
  26 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableChannelDialog;
  27 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.TraceControlDialogFactory;
  28 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.messages.Messages;
  29 import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TraceDomainComponent;
  30
  31 /**
  32  * <p>
  33  * Base implementation of a command handler to enable a trace channel.
  34  * </p>
  35  *
  36  * @author Bernd Hufmann
  37  */
  38 abstract class BaseEnableChannelHandler extends BaseControlViewHandler {
  39
  40     // ------------------------------------------------------------------------
  41     // Attributes
  42     // ------------------------------------------------------------------------
  43     protected CommandParameter fParam;
  44
  45     // ------------------------------------------------------------------------
  46     // Operations
  47     // ------------------------------------------------------------------------
  48
  49     /**
  50      * Enables channels with given names which are part of this domain. If a
  51      * given channel doesn't exists it creates a new channel with the given
  52      * parameters (or default values if given parameter is null).
  53      *
  54      * @param param
  55      *            - a parameter instance with data for the command execution
  56      * @param channelNames
  57      *            - a list of channel names to enable on this domain
  58      * @param info
  59      *            - channel information to set for the channel (use null for
  60      *            default)
  61      * @param isKernel
  62      *            - a flag for indicating kernel or UST.
  63      * @param monitor
  64      *            - a progress monitor
  65      * @throws ExecutionException
  66      *             If something goes wrong when enabling the channel
  67      */
  68     abstract public void enableChannel(CommandParameter param,
  69             List<String> channelNames, IChannelInfo info, boolean isKernel,
  70             IProgressMonitor monitor) throws ExecutionException;
  71
  72     /**
  73      * @param param - a parameter instance with data for the command execution
  74      * @return returns the relevant domain (null if domain is not known)
  75      */
  76     abstract public TraceDomainComponent getDomain(CommandParameter param);
  77
  78     /*
  79      * (non-Javadoc)
  80      * @see org.eclipse.core.commands.AbstractHandler#execute(org.eclipse.core.commands.ExecutionEvent)
  81      */
  82     @Override
  83     public Object execute(ExecutionEvent event) throws ExecutionException {
  84         fLock.lock();
  85         try {
  86             final CommandParameter param = fParam.clone();
  87
  88             final IEnableChannelDialog dialog =  TraceControlDialogFactory.getInstance().getEnableChannelDialog();
  89             dialog.setDomainComponent(getDomain(param));
  90
  91             if (dialog.open() != Window.OK) {
  92                 return null;
  93             }
  94
  95             Job job = new Job(Messages.TraceControl_CreateChannelStateJob) {
  96                 @Override
  97                 protected IStatus run(IProgressMonitor monitor) {
  98                     Exception error = null;
  99
 100                     List<String> channelNames = new ArrayList<String>();
 101                     channelNames.add(dialog.getChannelInfo().getName());
 102
 103                     try {
 104                         enableChannel(param, channelNames, dialog.getChannelInfo(), dialog.isKernel(), monitor);
 105                     } catch (ExecutionException e) {
 106                         error = e;
 107                     }
 108
 109                     // refresh in all cases
 110                     refresh(param);
 111
 112                     if (error != null) {
 113                         return new Status(IStatus.ERROR, Activator.PLUGIN_ID, Messages.TraceControl_CreateChannelStateFailure, error);
 114                     }
 115                     return Status.OK_STATUS;
 116                 }
 117             };
 118             job.setUser(true);
 119             job.schedule();
 120         } finally {
 121             fLock.unlock();
 122         }
 123         return null;
 124     }
 125
 126 }