added svcapi ui and camunda code
[it/otf.git] / otf-camunda / src / main / java / org / oran / otf / camunda / service / ProcessEngineAwareService.java
1 /*-\r
2  * ============LICENSE_START=======================================================\r
3  * ONAP - SO\r
4  * ================================================================================\r
5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.\r
6  * Copyright (C) 2017 Huawei Technologies Co., Ltd. All rights reserved.\r
7  * ================================================================================\r
8  * Licensed under the Apache License, Version 2.0 (the "License");\r
9  * you may not use this file except in compliance with the License.\r
10  * You may obtain a copy of the License at\r
11  *\r
12  *      http://www.apache.org/licenses/LICENSE-2.0\r
13  *\r
14  * Unless required by applicable law or agreed to in writing, software\r
15  * distributed under the License is distributed on an "AS IS" BASIS,\r
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
17  * See the License for the specific language governing permissions and\r
18  * limitations under the License.\r
19  * ============LICENSE_END=========================================================\r
20  */\r
21 \r
22 package org.oran.otf.camunda.service;\r
23 \r
24 import org.oran.otf.camunda.configuration.OtfCamundaConfiguration;\r
25 import java.util.Optional;\r
26 import org.camunda.bpm.engine.ProcessEngineServices;\r
27 import org.camunda.bpm.engine.ProcessEngines;\r
28 import org.springframework.stereotype.Service;\r
29 \r
30 /**\r
31  * Base class for services that must be process-engine aware. The only process engine currently\r
32  * supported is the "default" process engine.\r
33  */\r
34 @Service\r
35 public class ProcessEngineAwareService {\r
36 \r
37   //  private final String processEngineName = OTFProcessEngineConfiguration.processEngineName;\r
38   private final String processEngineName = OtfCamundaConfiguration.processEngineName;\r
39   private volatile Optional<ProcessEngineServices> pes4junit = Optional.empty();\r
40 \r
41   /**\r
42    * Gets the process engine name.\r
43    *\r
44    * @return the process engine name\r
45    */\r
46   public String getProcessEngineName() {\r
47     return processEngineName;\r
48   }\r
49 \r
50   /**\r
51    * Gets process engine services.\r
52    *\r
53    * @return process engine services\r
54    */\r
55   public ProcessEngineServices getProcessEngineServices() {\r
56     return pes4junit.orElse(ProcessEngines.getProcessEngine(getProcessEngineName()));\r
57   }\r
58 \r
59   /**\r
60    * Allows a particular process engine to be specified, overriding the usual process engine lookup\r
61    * by name. Intended primarily for the unit test environment.\r
62    *\r
63    * @param pes process engine services\r
64    */\r
65   public void setProcessEngineServices4junit(ProcessEngineServices pes) {\r
66     pes4junit = Optional.ofNullable(pes);\r
67   }\r
68 }\r