You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@oodt.apache.org by bf...@apache.org on 2012/03/15 01:37:28 UTC
svn commit: r1300799 - in /oodt/trunk/pge/src:
main/java/org/apache/oodt/cas/pge/ main/java/org/apache/oodt/cas/pge/config/
main/java/org/apache/oodt/cas/pge/metadata/ test/org/apache/oodt/cas/pge/
test/org/apache/oodt/cas/pge/metadata/
Author: bfoster
Date: Thu Mar 15 00:37:27 2012
New Revision: 1300799
URL: http://svn.apache.org/viewvc?rev=1300799&view=rev
Log:
- Converted CAS-PGE metadata keys and workflow statuses from static Strings to enums
-------------
OODT-409
Added:
oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/metadata/PgeTaskMetKeys.java (with props)
oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/metadata/PgeTaskStatus.java (with props)
oodt/trunk/pge/src/test/org/apache/oodt/cas/pge/metadata/TestPgeTaskMetKeys.java (with props)
Removed:
oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/metadata/PgeTaskMetadataKeys.java
Modified:
oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/PGETaskInstance.java
oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/config/XmlFilePgeConfigBuilder.java
oodt/trunk/pge/src/test/org/apache/oodt/cas/pge/TestPGETaskInstance.java
Modified: oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/PGETaskInstance.java
URL: http://svn.apache.org/viewvc/oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/PGETaskInstance.java?rev=1300799&r1=1300798&r2=1300799&view=diff
==============================================================================
--- oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/PGETaskInstance.java (original)
+++ oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/PGETaskInstance.java Thu Mar 15 00:37:27 2012
@@ -17,10 +17,6 @@
package org.apache.oodt.cas.pge;
-//OODT static imports
-import static org.apache.oodt.cas.pge.metadata.PgeTaskMetadataKeys.PROPERTY_ADDERS;
-import static org.apache.oodt.cas.pge.metadata.PgeTaskMetadataKeys.PROPERTY_ADDER_CLASSPATH;
-
//JDK imports
import java.util.LinkedList;
import java.util.List;
@@ -58,7 +54,8 @@ import org.apache.oodt.cas.pge.config.Re
import org.apache.oodt.cas.pge.config.XmlFilePgeConfigBuilder;
import org.apache.oodt.cas.pge.metadata.PcsMetadataKeys;
import org.apache.oodt.cas.pge.metadata.PgeMetadata;
-import org.apache.oodt.cas.pge.metadata.PgeTaskMetadataKeys;
+import org.apache.oodt.cas.pge.metadata.PgeTaskMetKeys;
+import org.apache.oodt.cas.pge.metadata.PgeTaskStatus;
import org.apache.oodt.cas.pge.writers.PcsMetFileWriter;
import org.apache.oodt.cas.pge.writers.SciPgeConfigFileWriter;
@@ -120,8 +117,7 @@ public class PGETaskInstance implements
WorkflowTaskConfiguration config) {
Metadata staticMetadata = new Metadata();
for (Object key : config.getProperties().keySet()) {
- if (PROPERTY_ADDERS.equals((String) key)
- || PROPERTY_ADDER_CLASSPATH.equals((String) key)) {
+ if (PgeTaskMetKeys.PROPERTY_ADDERS.getName().equals((String) key)) {
staticMetadata.addMetadata((String) key,
Lists.newArrayList(config.getProperty((String) key).split(",")));
} else {
@@ -135,12 +131,7 @@ public class PGETaskInstance implements
protected void runPropertyAdders() throws Exception {
try {
List<String> propertyAdders = pgeMetadata
- .getAllMetadata(PROPERTY_ADDERS);
- if (propertyAdders == null) {
- // Left for backwards compatibility.
- propertyAdders = pgeMetadata
- .getAllMetadata(PROPERTY_ADDER_CLASSPATH);
- }
+ .getAllMetadata(PgeTaskMetKeys.PROPERTY_ADDERS.getName());
if (propertyAdders != null) {
for (String propertyAdder : propertyAdders) {
runPropertyAdder(loadPropertyAdder(propertyAdder));
@@ -200,7 +191,7 @@ public class PGETaskInstance implements
}
protected void createSciPgeConfigFiles() throws IOException {
- this.updateStatus(PgeTaskMetadataKeys.CONF_FILE_BUILD);
+ this.updateStatus(PgeTaskStatus.CONF_FILE_BUILD.getWorkflowStatusName());
for (DynamicConfigFile dynamicConfigFile : pgeConfig
.getDynamicConfigFiles()) {
try {
@@ -302,14 +293,14 @@ public class PGETaskInstance implements
protected String getPgeScriptName() {
return "sciPgeExeScript_"
- + this.pgeMetadata.getMetadata(PgeTaskMetadataKeys.NAME);
+ + this.pgeMetadata.getMetadata(PgeTaskMetKeys.NAME.getName());
}
protected Handler initializePgeLogHandler() throws SecurityException,
IOException {
FileHandler handler = null;
String logFilePattern = this.pgeMetadata
- .getMetadata(PgeTaskMetadataKeys.LOG_FILE_PATTERN);
+ .getMetadata(PgeTaskMetKeys.LOG_FILE_PATTERN.getName());
if (logFilePattern != null) {
LOG.log(Level.INFO,
"Creating Log Handler to capture pge output to file '"
@@ -325,7 +316,7 @@ public class PGETaskInstance implements
protected Logger initializePgeLogger(Handler handler) {
if (handler != null) {
Logger pgeLogger = Logger.getLogger(this.pgeMetadata
- .getMetadata(PgeTaskMetadataKeys.NAME)
+ .getMetadata(PgeTaskMetKeys.NAME.getName())
+ System.currentTimeMillis());
pgeLogger.addHandler(handler);
return pgeLogger;
@@ -355,7 +346,7 @@ public class PGETaskInstance implements
// run script and evaluate whether success or failure
handler = this.initializePgeLogHandler();
pgeLogger = this.initializePgeLogger(handler);
- this.updateStatus(PgeTaskMetadataKeys.RUNNING_PGE);
+ this.updateStatus(PgeTaskStatus.RUNNING_PGE.getWorkflowStatusName());
if (!this.wasPgeSuccessful(ExecUtils.callProgram(
this.pgeConfig.getShellType() + " " + this.getScriptPath(),
pgeLogger,
@@ -366,7 +357,7 @@ public class PGETaskInstance implements
"Successfully completed running: '" + sf.getCommands() + "'");
long endTime = System.currentTimeMillis();
- this.pgeMetadata.replaceMetadata(PgeTaskMetadataKeys.PGE_RUNTIME,
+ this.pgeMetadata.replaceMetadata(PgeTaskMetKeys.PGE_RUNTIME.getName(),
(endTime - startTime) + "");
} catch (Exception e) {
@@ -437,9 +428,9 @@ public class PGETaskInstance implements
List<File> crawlDirs) {
File currentDir = null;
try {
- this.updateStatus(PgeTaskMetadataKeys.CRAWLING);
+ this.updateStatus(PgeTaskStatus.CRAWLING.getWorkflowStatusName());
boolean attemptIngestAll = Boolean.parseBoolean(this.pgeMetadata
- .getMetadata(PgeTaskMetadataKeys.ATTEMPT_INGEST_ALL));
+ .getMetadata(PgeTaskMetKeys.ATTEMPT_INGEST_ALL.getName()));
for (File crawlDir : crawlDirs) {
currentDir = crawlDir;
LOG.log(Level.INFO, "Executing StdProductCrawler in productPath: ["
Modified: oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/config/XmlFilePgeConfigBuilder.java
URL: http://svn.apache.org/viewvc/oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/config/XmlFilePgeConfigBuilder.java?rev=1300799&r1=1300798&r2=1300799&view=diff
==============================================================================
--- oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/config/XmlFilePgeConfigBuilder.java (original)
+++ oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/config/XmlFilePgeConfigBuilder.java Thu Mar 15 00:37:27 2012
@@ -71,7 +71,7 @@ import org.apache.oodt.cas.metadata.Meta
import org.apache.oodt.cas.metadata.util.PathUtils;
import org.apache.oodt.cas.pge.metadata.PcsMetadataKeys;
import org.apache.oodt.cas.pge.metadata.PgeMetadata;
-import org.apache.oodt.cas.pge.metadata.PgeTaskMetadataKeys;
+import org.apache.oodt.cas.pge.metadata.PgeTaskMetKeys;
import org.apache.oodt.commons.xml.XMLUtils;
//W3C imports
@@ -93,7 +93,7 @@ public class XmlFilePgeConfigBuilder imp
try {
PgeConfig pgeConfig = new PgeConfig();
this.buildImports(this.fillIn(pgeMetadata
- .getMetadata(PgeTaskMetadataKeys.CONFIG_FILE_PATH),
+ .getMetadata(PgeTaskMetKeys.CONFIG_FILE_PATH.getName()),
pgeMetadata.asMetadata()), null, pgeConfig, pgeMetadata);
return pgeConfig;
} catch (Exception e) {
Added: oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/metadata/PgeTaskMetKeys.java
URL: http://svn.apache.org/viewvc/oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/metadata/PgeTaskMetKeys.java?rev=1300799&view=auto
==============================================================================
--- oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/metadata/PgeTaskMetKeys.java (added)
+++ oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/metadata/PgeTaskMetKeys.java Thu Mar 15 00:37:27 2012
@@ -0,0 +1,49 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.oodt.cas.pge.metadata;
+
+//Google imports
+import com.google.common.annotations.VisibleForTesting;
+
+/**
+ * PGETaskInstance Reserved Metadata keys.
+ *
+ * @author bfoster (Brian Foster)
+ */
+public enum PgeTaskMetKeys {
+
+ NAME("PGETask/Name", "PGETask_Name"),
+ CONFIG_FILE_PATH("PGETask/ConfigFilePath", "PGETask_ConfigFilePath"),
+ LOG_FILE_PATTERN("PGETask/LogFilePattern", "PGETask_LogFilePattern"),
+ PROPERTY_ADDERS("PGETask/PropertyAdders", "PGETask_PropertyAdderClasspath"),
+ PGE_RUNTIME("PGETask/Runtime", "PGETask_Runtime"),
+ ATTEMPT_INGEST_ALL("PGETask/AttemptIngestAll", "PGETask_AttemptIngestAll");
+
+ public static final String USE_LEGACY_PROPERTY = "org.apache.oodt.cas.pge.legacyMode";
+
+ @VisibleForTesting String name;
+ @VisibleForTesting String legacyName;
+
+ PgeTaskMetKeys(String name, String legacyName) {
+ this.name = name;
+ this.legacyName = legacyName;
+ }
+
+ public String getName() {
+ return Boolean.getBoolean(USE_LEGACY_PROPERTY) ? legacyName : name;
+ }
+}
Propchange: oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/metadata/PgeTaskMetKeys.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/metadata/PgeTaskStatus.java
URL: http://svn.apache.org/viewvc/oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/metadata/PgeTaskStatus.java?rev=1300799&view=auto
==============================================================================
--- oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/metadata/PgeTaskStatus.java (added)
+++ oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/metadata/PgeTaskStatus.java Thu Mar 15 00:37:27 2012
@@ -0,0 +1,40 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.oodt.cas.pge.metadata;
+
+/**
+ * Workflow Statuses for {@link PGETaskInstance}.
+ *
+ * @author bfoster (Brian Foster)
+ */
+public enum PgeTaskStatus {
+
+ STAGING_INPUT("PGETask_Staging_Input"),
+ CONF_FILE_BUILD("PGETask_Building_Config_File"),
+ RUNNING_PGE("PGETask_Running"),
+ CRAWLING("PGETask_Crawling");
+
+ private String workflowStatusName;
+
+ PgeTaskStatus(String workflowStatusName) {
+ this.workflowStatusName = workflowStatusName;
+ }
+
+ public String getWorkflowStatusName() {
+ return workflowStatusName;
+ }
+}
Propchange: oodt/trunk/pge/src/main/java/org/apache/oodt/cas/pge/metadata/PgeTaskStatus.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Modified: oodt/trunk/pge/src/test/org/apache/oodt/cas/pge/TestPGETaskInstance.java
URL: http://svn.apache.org/viewvc/oodt/trunk/pge/src/test/org/apache/oodt/cas/pge/TestPGETaskInstance.java?rev=1300799&r1=1300798&r2=1300799&view=diff
==============================================================================
--- oodt/trunk/pge/src/test/org/apache/oodt/cas/pge/TestPGETaskInstance.java (original)
+++ oodt/trunk/pge/src/test/org/apache/oodt/cas/pge/TestPGETaskInstance.java Thu Mar 15 00:37:27 2012
@@ -17,14 +17,14 @@
package org.apache.oodt.cas.pge;
//OODT static imports
-import static org.apache.oodt.cas.pge.metadata.PgeTaskMetadataKeys.PROPERTY_ADDERS;
-import static org.apache.oodt.cas.pge.metadata.PgeTaskMetadataKeys.PROPERTY_ADDER_CLASSPATH;
+import static org.apache.oodt.cas.pge.metadata.PgeTaskMetKeys.PROPERTY_ADDERS;
//OODT imports
import org.apache.oodt.cas.metadata.Metadata;
import org.apache.oodt.cas.pge.PGETaskInstance;
import org.apache.oodt.cas.pge.config.PgeConfig;
import org.apache.oodt.cas.pge.metadata.PgeMetadata;
+import org.apache.oodt.cas.pge.metadata.PgeTaskMetKeys;
//Google imports
import com.google.common.collect.Lists;
@@ -49,7 +49,7 @@ public class TestPGETaskInstance extends
public void testRunPropertyAdders() throws Exception {
PGETaskInstance pgeTask = new PGETaskInstance();
Metadata staticMet = new Metadata();
- staticMet.addMetadata(PROPERTY_ADDER_CLASSPATH, MockConfigFilePropertyAdder.class.getCanonicalName());
+ staticMet.addMetadata(PROPERTY_ADDERS.getName(), MockConfigFilePropertyAdder.class.getCanonicalName());
Metadata dynMet = new Metadata();
pgeTask.pgeMetadata = new PgeMetadata(staticMet, dynMet);
pgeTask.pgeConfig = new PgeConfig();
@@ -59,22 +59,23 @@ public class TestPGETaskInstance extends
staticMet = new Metadata();
dynMet = new Metadata();
- dynMet.addMetadata(PROPERTY_ADDERS, MockConfigFilePropertyAdder.class.getCanonicalName());
+ dynMet.addMetadata(PROPERTY_ADDERS.getName(), Lists.newArrayList(MockConfigFilePropertyAdder.class.getCanonicalName(), MockConfigFilePropertyAdder.class.getCanonicalName()));
pgeTask.pgeMetadata = new PgeMetadata(staticMet, dynMet);
pgeTask.pgeConfig = new PgeConfig();
pgeTask.pgeConfig.setPropertyAdderCustomArgs(new Object[] { "key", "value" });
pgeTask.runPropertyAdders();
assertEquals("value", pgeTask.pgeMetadata.getMetadata("key"));
- assertEquals("1", pgeTask.pgeMetadata.getMetadata(MockConfigFilePropertyAdder.RUN_COUNTER));
+ assertEquals("2", pgeTask.pgeMetadata.getMetadata(MockConfigFilePropertyAdder.RUN_COUNTER));
+ System.setProperty(PgeTaskMetKeys.USE_LEGACY_PROPERTY, "true");
staticMet = new Metadata();
dynMet = new Metadata();
- dynMet.addMetadata(PROPERTY_ADDERS, Lists.newArrayList(MockConfigFilePropertyAdder.class.getCanonicalName(), MockConfigFilePropertyAdder.class.getCanonicalName()));
+ dynMet.addMetadata(PROPERTY_ADDERS.getName(), MockConfigFilePropertyAdder.class.getCanonicalName());
pgeTask.pgeMetadata = new PgeMetadata(staticMet, dynMet);
pgeTask.pgeConfig = new PgeConfig();
pgeTask.pgeConfig.setPropertyAdderCustomArgs(new Object[] { "key", "value" });
pgeTask.runPropertyAdders();
assertEquals("value", pgeTask.pgeMetadata.getMetadata("key"));
- assertEquals("2", pgeTask.pgeMetadata.getMetadata(MockConfigFilePropertyAdder.RUN_COUNTER));
+ assertEquals("1", pgeTask.pgeMetadata.getMetadata(MockConfigFilePropertyAdder.RUN_COUNTER));
}
}
Added: oodt/trunk/pge/src/test/org/apache/oodt/cas/pge/metadata/TestPgeTaskMetKeys.java
URL: http://svn.apache.org/viewvc/oodt/trunk/pge/src/test/org/apache/oodt/cas/pge/metadata/TestPgeTaskMetKeys.java?rev=1300799&view=auto
==============================================================================
--- oodt/trunk/pge/src/test/org/apache/oodt/cas/pge/metadata/TestPgeTaskMetKeys.java (added)
+++ oodt/trunk/pge/src/test/org/apache/oodt/cas/pge/metadata/TestPgeTaskMetKeys.java Thu Mar 15 00:37:27 2012
@@ -0,0 +1,34 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.oodt.cas.pge.metadata;
+
+//JUnit imports
+import junit.framework.TestCase;
+
+/**
+ * Test class for {@link PgeTaskMetKeys}.
+ *
+ * @author bfoster (Brian Foster)
+ */
+public class TestPgeTaskMetKeys extends TestCase {
+
+ public void testLegacyMode() {
+ assertEquals(PgeTaskMetKeys.NAME.getName(), PgeTaskMetKeys.NAME.name);
+ System.setProperty(PgeTaskMetKeys.USE_LEGACY_PROPERTY, "true");
+ assertEquals(PgeTaskMetKeys.NAME.getName(), PgeTaskMetKeys.NAME.legacyName);
+ }
+}
Propchange: oodt/trunk/pge/src/test/org/apache/oodt/cas/pge/metadata/TestPgeTaskMetKeys.java
------------------------------------------------------------------------------
svn:mime-type = text/plain