Clean up Process Engine selection logic

Several failed attempts to split the BPMN application into
multiple applications with separate camunda process engines
have left a mess of confusing classes and process engine
definitions.

In the Amsterdam release, there should be only one BPMN
application war.  This is MSOInfrastructureBPMN.
MSOCommonBPMN should not be deployed as a separate
application.  Its classes are compiled into a jar and
this is included inside MSOInfrastructureBPMN.

The MSOInfrastructureBPMN application should use the
"default" process engine.

WorkflowAsyncInfrastructureResource and
MSOCommonApplication classes are not needed.

Issue: SO-322
Change-Id: Ifdb3b33541346b561a16361d1aa791e8342a34fa
Signed-off-by: Rob Daugherty <rd472p@att.com>

7 files changed, 67 insertions, 152 deletions

diff --git a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/MSOCommonApplication.java b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/MSOCommonApplication.java
deleted file mode 100644
index 3e8fd6ee05..0000000000
--- a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/MSOCommonApplication.java
+++ /dev/null
@@ -1,59 +0,0 @@
-package org.openecomp.mso.bpmn.common;

-/*-

- * ============LICENSE_START=======================================================

- * ONAP - SO

- * ================================================================================

- * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.

- * ================================================================================

- * 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.

- * ============LICENSE_END=========================================================

- */

-

-

-

-import java.util.List;

-

-import org.camunda.bpm.application.PostDeploy;

-import org.camunda.bpm.application.PreUndeploy;

-import org.camunda.bpm.application.ProcessApplication;

-import org.camunda.bpm.application.ProcessApplicationInfo;

-import org.camunda.bpm.application.impl.ServletProcessApplication;

-import org.camunda.bpm.engine.ProcessEngine;

-

-import org.openecomp.mso.logger.MsoLogger;

-

-/**

- * @since Version 1.0

- *

- */

-@ProcessApplication(name="MSO Common Application", deploymentDescriptors={"../processes.xml"})

-public class MSOCommonApplication extends ServletProcessApplication {

-	

-	private MsoLogger msoLogger = MsoLogger.getMsoLogger(MsoLogger.Catalog.BPEL);

-	

-	@PostDeploy

-	public void postDeploy(ProcessEngine processEngineInstance) {

-		long startTime = System.currentTimeMillis();

-		

-		msoLogger.recordAuditEvent (startTime, MsoLogger.StatusCode.COMPLETE, MsoLogger.ResponseCode.Suc, "Post deployment complete...");		

-	}

-	

-	@PreUndeploy

-	public void cleanup(ProcessEngine processEngine, ProcessApplicationInfo processApplicationInfo, List<ProcessEngine> processEngines) {

-		long startTime = System.currentTimeMillis();

-		

-		msoLogger.recordAuditEvent (startTime, MsoLogger.StatusCode.COMPLETE, MsoLogger.ResponseCode.Suc, "Pre Undeploy complete...");	

-		

-	}

-	

-}

diff --git a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/AbstractCallbackService.java b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/AbstractCallbackService.java
index c0be8992ef..d65311dfe8 100644
--- a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/AbstractCallbackService.java
+++ b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/AbstractCallbackService.java
@@ -26,8 +26,6 @@ import java.util.List;
 import java.util.Map;

 

 import org.camunda.bpm.engine.MismatchingMessageCorrelationException;

-import org.camunda.bpm.engine.ProcessEngineServices;

-import org.camunda.bpm.engine.ProcessEngines;

 import org.camunda.bpm.engine.RuntimeService;

 import org.camunda.bpm.engine.runtime.Execution;

 import org.camunda.bpm.engine.runtime.MessageCorrelationResult;

@@ -38,7 +36,7 @@ import org.openecomp.mso.logger.MsoLogger;
 /**

  * Abstract base class for callback services.

  */

-public abstract class AbstractCallbackService {

+public abstract class AbstractCallbackService extends ProcessEngineAwareService {

 	public static final long DEFAULT_TIMEOUT_SECONDS = 60;

 	public static final long FAST_POLL_DUR_SECONDS = 5;

 	public static final long FAST_POLL_INT_MS = 100;

@@ -46,8 +44,6 @@ public abstract class AbstractCallbackService {
 	

 	private static final MsoLogger LOGGER = MsoLogger.getMsoLogger(MsoLogger.Catalog.BPEL);

 

-	protected volatile ProcessEngineServices pes4junit = null;

-	

 	/**

 	 * Parameterized callback handler.

 	 */

@@ -368,16 +364,4 @@ public abstract class AbstractCallbackService {
 				+ ":" + execution.getId() + "]";

 		}

 	}

-	

-	protected ProcessEngineServices getProcessEngineServices() {

-		if (pes4junit == null) {

-			return ProcessEngines.getProcessEngine("infrastructure");

-		} else {

-			return pes4junit;

-		}

-	}

-

-	public void setProcessEngineServices4junit(ProcessEngineServices pes) {

-		pes4junit = pes;

-	}

 }
diff --git a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/WorkflowAsyncCommonResource.java b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/ProcessEngineAwareService.java
index 4534b56efc..dbb6674a64 100644
--- a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/WorkflowAsyncCommonResource.java
+++ b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/ProcessEngineAwareService.java
@@ -1,32 +1,64 @@
-/*-

- * ============LICENSE_START=======================================================

- * ONAP - SO

- * ================================================================================

- * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.

- * ================================================================================

- * 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.

- * ============LICENSE_END=========================================================

- */

-

-package org.openecomp.mso.bpmn.common.workflow.service;

-

-import org.camunda.bpm.engine.ProcessEngineServices;

-import org.camunda.bpm.engine.ProcessEngines;

-

-

-public class WorkflowAsyncCommonResource extends WorkflowAsyncResource {

-

-    protected ProcessEngineServices getProcessEngineServices() {

-        return pes4junit.orElse(ProcessEngines.getProcessEngine("infrastructure"));

-    }

-}

+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - SO
+ * ================================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2017 Huawei Technologies Co., Ltd. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.openecomp.mso.bpmn.common.workflow.service;
+
+import java.util.Optional;
+
+import org.camunda.bpm.engine.ProcessEngineServices;
+import org.camunda.bpm.engine.ProcessEngines;
+
+/**
+ * Base class for services that must be process-engine aware. The only
+ * process engine currently supported is the "default" process engine.
+ */
+public class ProcessEngineAwareService {
+	
+	private final String processEngineName = "default";
+	private volatile Optional<ProcessEngineServices> pes4junit = Optional.empty();
+	
+	/**
+	 * Gets the process engine name.
+	 * @return the process engine name
+	 */
+	public String getProcessEngineName() {
+		return processEngineName;
+	}
+
+	/**
+	 * Gets process engine services.
+	 * @return process engine services
+	 */
+	public ProcessEngineServices getProcessEngineServices() {
+		return pes4junit.orElse(ProcessEngines.getProcessEngine(
+				getProcessEngineName()));
+	}
+
+	/**
+	 * Allows a particular process engine to be specified, overriding the
+	 * usual process engine lookup by name.  Intended primarily for the
+	 * unit test environment.
+	 * @param pes process engine services
+	 */
+	public void setProcessEngineServices4junit(ProcessEngineServices pes) {
+		pes4junit = Optional.ofNullable(pes);
+	}
+}
diff --git a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/SDNCAdapterCallbackServiceImpl.java b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/SDNCAdapterCallbackServiceImpl.java
index 2186e071f4..c5f0d02dff 100644
--- a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/SDNCAdapterCallbackServiceImpl.java
+++ b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/SDNCAdapterCallbackServiceImpl.java
@@ -20,9 +20,6 @@
 

 package org.openecomp.mso.bpmn.common.workflow.service;

 

-import java.util.HashMap;

-import java.util.Map;

-

 import javax.jws.WebMethod;

 import javax.jws.WebParam;

 import javax.jws.WebResult;

@@ -30,16 +27,9 @@ import javax.jws.WebService;
 import javax.ws.rs.core.Context;

 import javax.xml.ws.WebServiceContext;

 

-import org.camunda.bpm.BpmPlatform;

-import org.camunda.bpm.engine.MismatchingMessageCorrelationException;

-import org.camunda.bpm.engine.ProcessEngineServices;

-import org.camunda.bpm.engine.RuntimeService;

-import org.camunda.bpm.engine.runtime.ExecutionQuery;

 import org.openecomp.mso.bpmn.common.adapter.sdnc.SDNCAdapterCallbackRequest;

 import org.openecomp.mso.bpmn.common.adapter.sdnc.SDNCAdapterResponse;

 import org.openecomp.mso.bpmn.common.adapter.sdnc.SDNCCallbackAdapterPortType;

-import org.openecomp.mso.bpmn.core.PropertyConfiguration;

-import org.openecomp.mso.logger.MessageEnum;

 import org.openecomp.mso.logger.MsoLogger;

 

 /**

diff --git a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/WorkflowAsyncResource.java b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/WorkflowAsyncResource.java
index 99909b68a0..608adcf756 100644
--- a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/WorkflowAsyncResource.java
+++ b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/WorkflowAsyncResource.java
@@ -53,7 +53,7 @@ import org.slf4j.MDC;
  * For asynchronous process - the activity may send a acknowledgement response and then proceed further on executing the process

  */

 @Path("/async")

-public abstract class WorkflowAsyncResource {

+public class WorkflowAsyncResource extends ProcessEngineAwareService {

 

 	private static final WorkflowContextHolder contextHolder = WorkflowContextHolder.getInstance();

 	protected Optional<ProcessEngineServices> pes4junit = Optional.empty();

@@ -274,12 +274,6 @@ public abstract class WorkflowAsyncResource {
 	}

 	

 	

-	protected abstract ProcessEngineServices getProcessEngineServices();

-	

-	public void setProcessEngineServices4junit(ProcessEngineServices pes) {

-		pes4junit = Optional.ofNullable(pes);

-	}

-

 	private static Map<String, Object> getInputVariables(VariableMapImpl variableMap) {

 		Map<String, Object> inputVariables = new HashMap<>();

 		@SuppressWarnings("unchecked")

diff --git a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/WorkflowResource.java b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/WorkflowResource.java
index 0521fb4df3..76ff221018 100644
--- a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/WorkflowResource.java
+++ b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/WorkflowResource.java
@@ -39,7 +39,6 @@ import javax.ws.rs.core.UriInfo;
 import org.camunda.bpm.engine.HistoryService;

 import org.camunda.bpm.engine.ProcessEngineException;

 import org.camunda.bpm.engine.ProcessEngineServices;

-import org.camunda.bpm.engine.ProcessEngines;

 import org.camunda.bpm.engine.RuntimeService;

 import org.camunda.bpm.engine.history.HistoricVariableInstance;

 import org.camunda.bpm.engine.runtime.ProcessInstance;

@@ -53,10 +52,8 @@ import org.openecomp.mso.logger.MsoLogger;
 import org.slf4j.MDC;

 

 @Path("/workflow")

-public class WorkflowResource {

+public class WorkflowResource extends ProcessEngineAwareService {

 	

-	private ProcessEngineServices pes4junit = null;

-

 	private static final MsoLogger msoLogger = MsoLogger.getMsoLogger(MsoLogger.Catalog.BPEL);

 	private static final String LOGMARKER = "[WRKFLOW-RESOURCE]";

 

@@ -615,16 +612,4 @@ public class WorkflowResource {
 		

 		return response;

 	}

-

-	private ProcessEngineServices getProcessEngineServices() {

-		if (pes4junit == null) {

-			return ProcessEngines.getProcessEngine("infrastructure");

-		} else {

-			return pes4junit;

-		}

-	}

-

-	public void setProcessEngineServices4junit(ProcessEngineServices pes) {

-		pes4junit = pes;

-	}

 }

diff --git a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/WorkflowResourceApplication.java b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/WorkflowResourceApplication.java
index 4f99edd660..193b8fe903 100644
--- a/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/WorkflowResourceApplication.java
+++ b/bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/workflow/service/WorkflowResourceApplication.java
@@ -26,23 +26,12 @@ import java.util.Set;
 import javax.ws.rs.ApplicationPath;

 import javax.ws.rs.core.Application;

 

-import org.openecomp.mso.bpmn.common.workflow.service.WorkflowMessageResource;

-import org.openecomp.mso.bpmn.common.workflow.service.WorkflowResource;

-

-/**

- * @version 1.0

- * RESTeasy workflow application which wires synchronous and asynchronous response

- *

- */

 @ApplicationPath("/")

 public class WorkflowResourceApplication extends Application {

     private Set<Object> singletons = new HashSet<Object>();

     private Set<Class<?>> classes = new HashSet<Class<?>>();

 

     public WorkflowResourceApplication() {

-        singletons.add(new WorkflowResource());

-        singletons.add(new WorkflowAsyncCommonResource());

-        singletons.add(new WorkflowMessageResource());

     }

 

     @Override