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      * Enables channels with given names which are part of this domain. If a given channel
  50      * doesn't exists it creates a new channel with the given parameters (or default values
  51      * if given parameter is null).
  52      * @param - a parameter instance with data for the command execution
  53      * @param channelNames - a list of channel names to enable on this domain
  54      * @param info - channel information to set for the channel (use null for default)
  55      * @param isKernel -  a flag for indicating kernel or UST.
  56      * @param monitor - a progress monitor
  57      * @throws ExecutionException
  58      */
  59     abstract public void enableChannel(CommandParameter param, List<String> channelNames, IChannelInfo info, boolean isKernel, IProgressMonitor monitor) throws ExecutionException;
  60
  61     /**
  62      * @param - a parameter instance with data for the command execution
  63      * @return returns the relevant domain (null if domain is not known)
  64      */
  65     abstract public TraceDomainComponent getDomain(CommandParameter param);
  66
  67     /*
  68      * (non-Javadoc)
  69      * @see org.eclipse.core.commands.AbstractHandler#execute(org.eclipse.core.commands.ExecutionEvent)
  70      */
  71     @Override
  72     public Object execute(ExecutionEvent event) throws ExecutionException {
  73         fLock.lock();
  74         try {
  75             final CommandParameter param = fParam.clone();
  76
  77             final IEnableChannelDialog dialog =  TraceControlDialogFactory.getInstance().getEnableChannelDialog();
  78             dialog.setDomainComponent(getDomain(param));
  79
  80             if (dialog.open() != Window.OK) {
  81                 return null;
  82             }
  83
  84             Job job = new Job(Messages.TraceControl_CreateChannelStateJob) {
  85                 @Override
  86                 protected IStatus run(IProgressMonitor monitor) {
  87                     Exception error = null;
  88
  89                     List<String> channelNames = new ArrayList<String>();
  90                     channelNames.add(dialog.getChannelInfo().getName());
  91
  92                     try {
  93                         enableChannel(param, channelNames, dialog.getChannelInfo(), dialog.isKernel(), monitor);
  94                     } catch (ExecutionException e) {
  95                         error = e;
  96                     }
  97
  98                     // refresh in all cases
  99                     refresh(param);
 100
 101                     if (error != null) {
 102                         return new Status(Status.ERROR, Activator.PLUGIN_ID, Messages.TraceControl_CreateChannelStateFailure, error);
 103                     }
 104                     return Status.OK_STATUS;
 105                 }
 106             };
 107             job.setUser(true);
 108             job.schedule();
 109         } finally {
 110             fLock.unlock();
 111         }
 112         return null;
 113     }
 114
 115 }