X-Git-Url: http://git.argeo.org/?a=blobdiff_plain;f=runtime%2Forg.argeo.slc.specs%2Fsrc%2Fmain%2Fjava%2Forg%2Fargeo%2Fslc%2Fprocess%2FSlcExecutionStep.java;h=bc79688ff7033eb703b9f96dc5033aff872b3229;hb=9b2422e7198df6f34282a805058dd5f497417318;hp=59cf231d834cdee6299e0008d0ed493f1189f36a;hpb=2f57b9abf7e5110603e8cf952259509c76c9a162;p=gpl%2Fargeo-slc.git

diff --git a/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/process/SlcExecutionStep.java b/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/process/SlcExecutionStep.java
index 59cf231d8..bc79688ff 100644
--- a/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/process/SlcExecutionStep.java
+++ b/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/process/SlcExecutionStep.java
@@ -1,32 +1,63 @@
+/*
+ * Copyright (C) 2010 Mathieu Baudier <mbaudier@argeo.org>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package org.argeo.slc.process;
 
-import java.io.IOException;
-import java.io.StringReader;
-import java.io.StringWriter;
+import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
+import java.util.StringTokenizer;
 import java.util.UUID;
-import java.util.Vector;
 
-import org.apache.commons.io.IOUtils;
+import org.argeo.slc.execution.ExecutionStep;
 
-public class SlcExecutionStep {
-	public final static String TYPE_LOG = "LOG";
+/**
+ * An atomic step to be notified in during an {@link SlcExecution}. Can be a log
+ * or the start/end of a phase, etc.
+ * 
+ * @deprecated use {@link ExecutionStep} instead
+ */
+public class SlcExecutionStep extends ExecutionStep {
+	private static final long serialVersionUID = -7308643628104726471L;
 
-	private String uuid;
-	private String type;
-	private Date begin;
-	private List<String> logLines = new Vector<String>();
+	private String uuid = UUID.randomUUID().toString();
+	private List<String> logLines = new ArrayList<String>();
 
 	/** Empty constructor */
 	public SlcExecutionStep() {
 	}
 
+	/** Creates a step at the current date of type INFO */
 	public SlcExecutionStep(String log) {
-		this.type = TYPE_LOG;
-		this.begin = new Date();
-		this.uuid = UUID.randomUUID().toString();
-		addLog(log);
+		this(new Date(), INFO, log);
+	}
+
+	/** Creates a step at the current date */
+	public SlcExecutionStep(String type, String log) {
+		this(new Date(), type, log);
+	}
+
+	/** Creates a step of the given type. */
+	public SlcExecutionStep(Date timestamp, String type, String log) {
+		this(timestamp, type, log, Thread.currentThread().getName());
+	}
+
+	public SlcExecutionStep(Date timestamp, String type, String log,
+			String thread) {
+		super("UNKOWN_LOCATION", timestamp, type, log, thread);
 	}
 
 	public String getUuid() {
@@ -37,20 +68,16 @@ public class SlcExecutionStep {
 		this.uuid = uuid;
 	}
 
-	public String getType() {
-		return type;
-	}
-
 	public void setType(String type) {
 		this.type = type;
 	}
 
-	public Date getBegin() {
-		return begin;
+	public void setTimestamp(Date begin) {
+		this.timestamp = begin;
 	}
 
-	public void setBegin(Date begin) {
-		this.begin = begin;
+	public void setThread(String thread) {
+		this.thread = thread;
 	}
 
 	public List<String> getLogLines() {
@@ -61,23 +88,46 @@ public class SlcExecutionStep {
 		this.logLines = logLines;
 	}
 
-	public String logAsString() {
-		StringWriter writer = new StringWriter();
-		String log = writer.toString();
-		IOUtils.closeQuietly(writer);
-		return log;
-	}
+	/** public for legacy reasons */
+	public String addLog(String log) {
+		if (logLines == null)
+			logLines = new ArrayList<String>();
 
-	public void addLog(String log) {
 		if (log == null)
-			return;
+			return null;
 
-		try {
-			List<String> lines = IOUtils.readLines(new StringReader(log));
-			logLines.addAll(lines);
-		} catch (IOException e) {
-			throw new RuntimeException("Cannot add log", e);
+		StringTokenizer st = new StringTokenizer(log, "\n");
+		while (st.hasMoreTokens())
+			logLines.add(removeNonXmlChars(st.nextToken()));
+		return null;
+	}
+
+	/**
+	 * Removes non XML compliant characters (from
+	 * http://stackoverflow.com/questions
+	 * /20762/how-do-you-remove-invalid-hexadecimal
+	 * -characters-from-an-xml-based-data-source-pr)
+	 */
+	private static String removeNonXmlChars(String inString) {
+		if (inString == null)
+			return null;
+
+		StringBuilder newString = new StringBuilder();
+		char ch;
+
+		for (int i = 0; i < inString.length(); i++) {
+
+			ch = inString.charAt(i);
+			// remove any characters outside the valid UTF-8 range as well as
+			// all control characters
+			// except tabs and new lines
+			if ((ch < 0x00FD && ch > 0x001F) || ch == '\t' || ch == '\n'
+					|| ch == '\r') {
+				newString.append(ch);
+			}
 		}
+		return newString.toString();
+
 	}
 
 	@Override