1 /**********************************************************************
2 * Copyright (c) 2012 Ericsson
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
10 * Bernd Hufmann - Initial API and implementation
11 **********************************************************************/
12 package org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.handlers
;
14 import java
.util
.ArrayList
;
15 import java
.util
.Iterator
;
16 import java
.util
.List
;
18 import org
.eclipse
.core
.commands
.ExecutionEvent
;
19 import org
.eclipse
.core
.commands
.ExecutionException
;
20 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
21 import org
.eclipse
.core
.runtime
.IStatus
;
22 import org
.eclipse
.core
.runtime
.Status
;
23 import org
.eclipse
.core
.runtime
.jobs
.Job
;
24 import org
.eclipse
.jface
.viewers
.ISelection
;
25 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
26 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.Activator
;
27 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.ControlView
;
28 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.Messages
;
29 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.TraceEnablement
;
30 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.impl
.TraceChannelComponent
;
31 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.impl
.TraceEventComponent
;
32 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.impl
.TraceSessionComponent
;
33 import org
.eclipse
.ui
.IWorkbenchPage
;
34 import org
.eclipse
.ui
.IWorkbenchWindow
;
35 import org
.eclipse
.ui
.PlatformUI
;
38 * <b><u>EnableChannelHandler</u></b>
40 * Base Command handler implementation to enable or disabling a trace channel.
43 abstract public class ChangeEventStateHandler
extends BaseControlViewHandler
{
45 // ------------------------------------------------------------------------
47 // ------------------------------------------------------------------------
49 * The command execution parameter.
51 protected Parameter fParam
;
53 // ------------------------------------------------------------------------
55 // ------------------------------------------------------------------------
57 * @return the new state to set
59 abstract protected TraceEnablement
getNewState();
61 // ------------------------------------------------------------------------
63 // ------------------------------------------------------------------------
66 * @param channel - channel of events to be enabled
67 * @param eventNames - list event names
68 * @param monitor - a progress monitor
69 * @throws ExecutionException
71 abstract protected void changeState(TraceChannelComponent channel
, List
<String
> eventNames
, IProgressMonitor monitor
) throws ExecutionException
;
75 * @see org.eclipse.core.commands.AbstractHandler#execute(org.eclipse.core.commands.ExecutionEvent)
78 public Object
execute(ExecutionEvent event
) throws ExecutionException
{
80 IWorkbenchWindow window
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow();
89 final Parameter param
= new Parameter(fParam
);
91 Job job
= new Job(Messages
.TraceControl_ChangeChannelStateJob
) {
93 protected IStatus
run(IProgressMonitor monitor
) {
94 Exception error
= null;
96 TraceSessionComponent session
= null;
99 boolean isAll
= false;
100 if (param
.getChannel() != null) {
101 session
= param
.getChannel().getSession();
102 List
<String
> eventNames
= new ArrayList
<String
>();
103 List
<TraceEventComponent
> events
= param
.getEvents();
105 for (Iterator
<TraceEventComponent
> iterator
= events
.iterator(); iterator
.hasNext();) {
106 // Enable/disable all selected channels which are disabled
107 TraceEventComponent event
= (TraceEventComponent
) iterator
.next();
109 // Workaround for wildcard handling in lttng-tools
110 if ("*".equals(event
.getName())) { //$NON-NLS-1$
113 eventNames
.add(event
.getName());
117 changeState(param
.getChannel(), null, monitor
);
120 if (!eventNames
.isEmpty()) {
121 changeState(param
.getChannel(), eventNames
, monitor
);
124 for (Iterator
<TraceEventComponent
> iterator
= events
.iterator(); iterator
.hasNext();) {
125 // Enable all selected channels which are disabled
126 TraceEventComponent ev
= (TraceEventComponent
) iterator
.next();
127 ev
.setState(getNewState());
130 } catch (ExecutionException e
) {
134 if (session
!= null) {
135 // In all cases notify listeners
136 session
.fireComponentChanged(session
);
140 return new Status(Status
.ERROR
, Activator
.PLUGIN_ID
, Messages
.TraceControl_ChangeEventStateFailure
, error
);
143 return Status
.OK_STATUS
;
156 * @see org.eclipse.core.commands.AbstractHandler#isEnabled()
159 public boolean isEnabled() {
160 // Get workbench page for the Control View
161 IWorkbenchPage page
= getWorkbenchPage();
166 // Check if one or more session are selected
167 ISelection selection
= page
.getSelection(ControlView
.ID
);
169 TraceChannelComponent channel
= null;
170 List
<TraceEventComponent
> events
= new ArrayList
<TraceEventComponent
>();
172 if (selection
instanceof StructuredSelection
) {
173 StructuredSelection structered
= ((StructuredSelection
) selection
);
174 String sessionName
= null;
175 String channelName
= null;
177 for (Iterator
<?
> iterator
= structered
.iterator(); iterator
.hasNext();) {
178 Object element
= (Object
) iterator
.next();
180 if (element
instanceof TraceEventComponent
) {
182 TraceEventComponent event
= (TraceEventComponent
) element
;
183 if (sessionName
== null) {
184 sessionName
= String
.valueOf(event
.getSessionName());
187 if (channel
== null) {
188 channel
= (TraceChannelComponent
)event
.getParent();
191 if (channelName
== null) {
192 channelName
= event
.getChannelName();
195 // Enable command only for events of same session, same channel and domain
196 if ((!sessionName
.equals(event
.getSessionName())) ||
197 (!channelName
.equals(event
.getChannelName())) ||
198 (channel
.isKernel() != event
.isKernel())) {
203 if ((event
.getState() != getNewState())) {
209 boolean isEnabled
= !events
.isEmpty();
215 fParam
= new Parameter(channel
, events
);
224 * Class containing parameter for the command execution.
226 static protected class Parameter
{
228 * Channel component reference.
230 final private TraceChannelComponent fChannel
;
232 * The list of kernel channel components the command is to be executed on.
234 final private List
<TraceEventComponent
> fEvents
= new ArrayList
<TraceEventComponent
>();
238 * @param channel - a channel component
239 * @param events - a list of event components
241 public Parameter(TraceChannelComponent channel
, List
<TraceEventComponent
> events
) {
243 fEvents
.addAll(events
);
248 * @param other - a parameter to copy
250 public Parameter(Parameter other
) {
251 this(other
.fChannel
, other
.fEvents
);
255 * @return the trace channel component.
257 public TraceChannelComponent
getChannel() {
262 * @return a list of trace event components.
264 public List
<TraceEventComponent
> getEvents() {