1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
/*******************************************************************************
* Copyright (c) 2011, 2012 Wind River Systems, Inc. and others. All rights reserved.
* This program and the accompanying materials are made available under the terms
* of the Eclipse Public License v1.0 which accompanies this distribution, and is
* available at http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Wind River Systems - initial API and implementation
*******************************************************************************/
package org.eclipse.tcf.te.runtime.stepper.extensions;
import java.util.Date;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Status;
import org.eclipse.osgi.util.NLS;
import org.eclipse.tcf.te.runtime.callback.Callback;
import org.eclipse.tcf.te.runtime.concurrent.util.ExecutorsUtil;
import org.eclipse.tcf.te.runtime.interfaces.ISharedConstants;
import org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer;
import org.eclipse.tcf.te.runtime.stepper.activator.CoreBundleActivator;
import org.eclipse.tcf.te.runtime.stepper.interfaces.IFullQualifiedId;
import org.eclipse.tcf.te.runtime.stepper.interfaces.IStep;
import org.eclipse.tcf.te.runtime.stepper.interfaces.IStepContext;
import org.eclipse.tcf.te.runtime.stepper.interfaces.IStepExecutor;
import org.eclipse.tcf.te.runtime.stepper.interfaces.tracing.ITraceIds;
import org.eclipse.tcf.te.runtime.stepper.nls.Messages;
import org.eclipse.tcf.te.runtime.utils.ProgressHelper;
import org.eclipse.tcf.te.runtime.utils.StatusHelper;
/**
* Step executor implementation.
* <p>
* The step executor is responsible for initiating the execution of a single step. The executor
* creates and associated the step callback and blocks the execution till the executed step invoked
* the callback.
* <p>
* The step executor is passing any status thrown by the executed step to the parent stepper
* instance for handling.
* <p>
* If the step to execute is of type {@link IExtendedStep}, the step executor is calling
* {@link IExtendedStep#initializeFrom(IAdaptable, IPropertiesContainer, IFullQualifiedId, IProgressMonitor)} and
* {@link IExtendedStep#validateExecute(IAdaptable, IPropertiesContainer, IFullQualifiedId, IProgressMonitor)} before calling
* {@link IStep#execute(IAdaptable, IPropertiesContainer, IFullQualifiedId, IProgressMonitor, org.eclipse.tcf.te.runtime.interfaces.callback.ICallback)}.
* <p>
* The methods will be called within the current step executor thread.
* <p>
* The stepper implementation can be traced and profiled by setting the debug options:
* <ul>
* <li><i>org.eclipse.tcf.te.runtime.stepper/trace/stepping</i></li>
* <li><i>org.eclipse.tcf.te.runtime.stepper/profile/stepping</i></li>
* </ul>
*/
public class StepExecutor implements IStepExecutor {
/* (non-Javadoc)
* @see org.eclipse.tcf.te.runtime.stepper.interfaces.IStepExecutor#execute(org.eclipse.tcf.te.runtime.stepper.interfaces.IStep, org.eclipse.tcf.te.runtime.stepper.interfaces.IFullQualifiedId, org.eclipse.tcf.te.runtime.stepper.interfaces.IStepContext, org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer, org.eclipse.core.runtime.IProgressMonitor)
*/
@Override
public final void execute(final IStep step, IFullQualifiedId id, final IStepContext context, final IPropertiesContainer data, IProgressMonitor progress) throws CoreException {
Assert.isNotNull(step);
Assert.isNotNull(id);
Assert.isNotNull(context);
Assert.isNotNull(data);
Assert.isNotNull(progress);
long startTime = System.currentTimeMillis();
CoreBundleActivator.getTraceHandler().trace("StepExecutor#execute: *** START (" + step.getLabel() + ")", //$NON-NLS-1$ //$NON-NLS-2$
0, ITraceIds.TRACE_STEPPING, IStatus.WARNING, this);
CoreBundleActivator.getTraceHandler().trace(" [" + ISharedConstants.TIME_FORMAT.format(new Date(startTime)) + "]" //$NON-NLS-1$ //$NON-NLS-2$
+ " ***", //$NON-NLS-1$
0, ITraceIds.PROFILE_STEPPING, IStatus.WARNING, this);
int ticksToUse = step.getTotalWork(context, data);
progress = ProgressHelper.getProgressMonitor(progress, ticksToUse);
ProgressHelper.beginTask(progress, step.getLabel(), ticksToUse);
// Create the handler (and the callback) for the current step
final Callback callback = new Callback();
// Catch any exception that might occur during execution.
// Errors are passed through by definition.
try {
step.initializeFrom(context, data, id, progress);
step.validateExecute(context, data, id, progress);
step.execute(context, data, id, progress, callback);
// Wait till the step finished, an execution occurred or the
// user hit cancel on the progress monitor.
ExecutorsUtil.waitAndExecute(0, callback.getDoneConditionTester(progress, step.getCancelTimeout()));
// Check the status of the step
normalizeStatus(step, id, context, data, callback.getStatus());
}
catch (Exception e) {
CoreBundleActivator.getTraceHandler().trace("StepExecutor#execute: Exception catched: class ='" + e.getClass().getName() + "'" //$NON-NLS-1$ //$NON-NLS-2$
+ ", message = '" + e.getLocalizedMessage() + "'" //$NON-NLS-1$ //$NON-NLS-2$
+ ", cause = " //$NON-NLS-1$
+ (e instanceof CoreException ? ((CoreException)e).getStatus().getException() : e.getCause()),
0, ITraceIds.TRACE_STEPPING, IStatus.WARNING, this);
// If the exception is a CoreException by itself, just re-throw
if (e instanceof CoreException) {
// Check if the message does need normalization
if (isExceptionMessageFormatted(e.getLocalizedMessage())) {
throw (CoreException)e;
}
// We have to normalize the status message first
normalizeStatus(step, id, context, data, ((CoreException)e).getStatus());
} else {
// all other exceptions are repackaged within a CoreException
normalizeStatus(step, id, context, data, StatusHelper.getStatus(e));
}
}
finally {
if (!progress.isCanceled()) {
progress.done();
}
// Give the step a chance for cleanup
step.cleanup(context, data, id, progress);
long endTime = System.currentTimeMillis();
CoreBundleActivator.getTraceHandler().trace("StepExecutor#execute: *** DONE (" + step.getLabel() + ")", //$NON-NLS-1$ //$NON-NLS-2$
0, ITraceIds.TRACE_STEPPING, IStatus.WARNING, this);
CoreBundleActivator.getTraceHandler().trace(" [" + ISharedConstants.TIME_FORMAT.format(new Date(endTime)) //$NON-NLS-1$
+ " , delay = " + (endTime - startTime) + " ms]" //$NON-NLS-1$ //$NON-NLS-2$
+ " ***", //$NON-NLS-1$
0, ITraceIds.PROFILE_STEPPING, IStatus.WARNING, this);
}
}
/**
* Normalize the given status.
*
* @param step The step.
* @param id The fully qualified id.
* @param context The context.
* @param data The step data.
* @param status The status.
*
* @throws CoreException - if the operation fails
*/
private void normalizeStatus(IStep step, IFullQualifiedId id, IStepContext context , IPropertiesContainer data, IStatus status) throws CoreException {
Assert.isNotNull(context);
Assert.isNotNull(data);
Assert.isNotNull(id);
Assert.isNotNull(step);
if (status == null || status.isOK()) {
return;
}
switch (status.getSeverity()) {
case IStatus.CANCEL:
throw new OperationCanceledException(status.getMessage());
default:
String message = formatMessage(status.getMessage(), status.getSeverity(), step, id, context, data);
status = new Status(status.getSeverity(), status.getPlugin(), status.getCode(), message != null ? message : status.getMessage(), status.getException());
throw new CoreException(status);
}
}
/**
* Checks if the given message is already formatted to get displayed to the user.
*
* @param message The message. Must not be <code>null</code>.
* @return <code>True</code> if the message is already formatted to get displayed to the user, <code>false</code> otherwise.
*/
protected boolean isExceptionMessageFormatted(String message) {
Assert.isNotNull(message);
return message.startsWith(Messages.StepExecutor_checkPoint_normalizationNeeded);
}
/**
* Format the message depending on the severity.
*
* @param message The message to format.
* @param severity The message severity.
* @param step The step.
* @param id The full qualified step id.
* @param context The target context.
* @param data The step data.
*
* @return Formatted message.
*/
protected String formatMessage(String message, int severity, IStep step, IFullQualifiedId id, IStepContext context, IPropertiesContainer data) {
String template = null;
switch (severity) {
case IStatus.INFO:
template = Messages.StepExecutor_info_stepFailed;
break;
case IStatus.WARNING:
template = Messages.StepExecutor_warning_stepFailed;
break;
case IStatus.ERROR:
template = Messages.StepExecutor_error_stepFailed;
break;
}
// If we cannot determine the formatted message template, just return the message as is
if (template == null) {
return message;
}
// Check the message for additions
message = checkMessage(message);
// Split the message. The first sentence is shown more prominent on the top,
// the rest as additional information below the step information.
String[] splittedMsg = message != null ? message.split("[\t\n\r\f]+", 2) : new String[] { null, null }; //$NON-NLS-1$
// Format the core message
String formattedMessage = NLS.bind(template,
new String[] { splittedMsg[0],
context.getName(),
context.getInfo(data),
(step.getLabel() != null && step.getLabel().trim().length() > 0 ? step.getLabel() : step.getId())
});
// If we have more information available, append them
if (splittedMsg.length > 1 && splittedMsg[1] != null && !"".equals(splittedMsg[1])) { //$NON-NLS-1$
formattedMessage += "\n\n" + splittedMsg[1]; //$NON-NLS-1$
}
// In debug mode, there is even more information to add
if (Platform.inDebugMode()) {
formattedMessage += "\n\n" + NLS.bind(Messages.StepExecutor_stepFailed_debugInfo, id.toString()); //$NON-NLS-1$
}
return formattedMessage;
}
/**
* Check for additions to add to the message.
* <p>
* <i>Reserved for future use. Currently returns the message unmodified.</i>
*
* @param message The message or <code>null</code>.
* @return The checked message.
*/
protected String checkMessage(String message) {
return message;
}
}
|
