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 StringBuffer errorString
= new StringBuffer();
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
) {
131 errorString
.append(e
.toString());
132 errorString
.append('\n');
135 if (session
!= null) {
136 // In all cases notify listeners
137 session
.fireComponentChanged(session
);
140 if (errorString
.length() > 0) {
141 return new Status(Status
.ERROR
, Activator
.PLUGIN_ID
, errorString
.toString());
144 return Status
.OK_STATUS
;
157 * @see org.eclipse.core.commands.AbstractHandler#isEnabled()
160 public boolean isEnabled() {
161 // Get workbench page for the Control View
162 IWorkbenchPage page
= getWorkbenchPage();
167 // Check if one or more session are selected
168 ISelection selection
= page
.getSelection(ControlView
.ID
);
170 TraceChannelComponent channel
= null;
171 List
<TraceEventComponent
> events
= new ArrayList
<TraceEventComponent
>();
173 if (selection
instanceof StructuredSelection
) {
174 StructuredSelection structered
= ((StructuredSelection
) selection
);
175 String sessionName
= null;
176 String channelName
= null;
178 for (Iterator
<?
> iterator
= structered
.iterator(); iterator
.hasNext();) {
179 Object element
= (Object
) iterator
.next();
181 if (element
instanceof TraceEventComponent
) {
183 TraceEventComponent event
= (TraceEventComponent
) element
;
184 if (sessionName
== null) {
185 sessionName
= String
.valueOf(event
.getSessionName());
188 if (channel
== null) {
189 channel
= (TraceChannelComponent
)event
.getParent();
192 if (channelName
== null) {
193 channelName
= event
.getChannelName();
196 // Enable command only for events of same session, same channel and domain
197 if ((!sessionName
.equals(event
.getSessionName())) ||
198 (!channelName
.equals(event
.getChannelName())) ||
199 (channel
.isKernel() != event
.isKernel())) {
204 if ((event
.getState() != getNewState())) {
210 boolean isEnabled
= !events
.isEmpty();
216 fParam
= new Parameter(channel
, events
);
225 * Class containing parameter for the command execution.
227 static protected class Parameter
{
229 * Channel component reference.
231 final private TraceChannelComponent fChannel
;
233 * The list of kernel channel components the command is to be executed on.
235 final private List
<TraceEventComponent
> fEvents
= new ArrayList
<TraceEventComponent
>();
239 * @param channel - a channel component
240 * @param events - a list of event components
242 public Parameter(TraceChannelComponent channel
, List
<TraceEventComponent
> events
) {
244 fEvents
.addAll(events
);
249 * @param other - a parameter to copy
251 public Parameter(Parameter other
) {
252 this(other
.fChannel
, other
.fEvents
);
256 * @return the trace channel component.
258 public TraceChannelComponent
getChannel() {
263 * @return a list of trace event components.
265 public List
<TraceEventComponent
> getEvents() {