runtime/org.argeo.slc.server/src/main/java/org/argeo/slc/web/mvc/controllers/ProcessController.java

   1 /*
   2  * Copyright (C) 2010 Mathieu Baudier <mbaudier@argeo.org>
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *         http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.argeo.slc.web.mvc.controllers;
  18
  19 import java.io.BufferedReader;
  20 import java.util.Comparator;
  21 import java.util.List;
  22 import java.util.SortedSet;
  23 import java.util.TreeSet;
  24 import java.util.UUID;
  25
  26 import javax.servlet.http.HttpServletRequest;
  27
  28 import org.apache.commons.logging.Log;
  29 import org.apache.commons.logging.LogFactory;
  30 import org.argeo.slc.core.attachment.AttachmentsStorage;
  31 import org.argeo.slc.dao.process.SlcExecutionDao;
  32 import org.argeo.slc.execution.ExecutionModuleDescriptor;
  33 import org.argeo.slc.msg.ExecutionAnswer;
  34 import org.argeo.slc.msg.MsgConstants;
  35 import org.argeo.slc.msg.ObjectList;
  36 import org.argeo.slc.process.SlcExecution;
  37 import org.argeo.slc.process.SlcExecutionStep;
  38 import org.argeo.slc.runtime.SlcAgent;
  39 import org.argeo.slc.runtime.SlcAgentFactory;
  40 import org.argeo.slc.services.SlcExecutionService;
  41 import org.springframework.oxm.Marshaller;
  42 import org.springframework.oxm.Unmarshaller;
  43 import org.springframework.stereotype.Controller;
  44 import org.springframework.ui.Model;
  45 import org.springframework.util.Assert;
  46 import org.springframework.web.bind.annotation.RequestMapping;
  47 import org.springframework.web.bind.annotation.RequestParam;
  48 import org.springframework.xml.transform.StringSource;
  49
  50 @Controller
  51 public class ProcessController {
  52
  53         public final static String KEY_ANSWER = "__answer";
  54         private final static Log log = LogFactory.getLog(ProcessController.class);
  55
  56         private SlcExecutionDao slcExecutionDao;
  57         private SlcAgentFactory agentFactory;
  58         private Unmarshaller unmarshaller;
  59         private Marshaller marshaller;
  60         private SlcExecutionService slcExecutionService;
  61         private AttachmentsStorage attachmentsStorage;
  62
  63         private SlcExecutionManager slcExecutionManager;
  64
  65         @RequestMapping("/listSlcExecutions.service")
  66         protected ObjectList listSlcExecutions() {
  67                 List<SlcExecution> list = slcExecutionDao.listSlcExecutions();
  68                 return new ObjectList(list);
  69         }
  70
  71         @RequestMapping("/getExecutionDescriptor.service")
  72         protected ExecutionModuleDescriptor getExecutionDescriptor(
  73                         @RequestParam String agentId, @RequestParam String moduleName,
  74                         @RequestParam String version) {
  75
  76                 SlcAgent slcAgent = agentFactory.getAgent(agentId);
  77
  78                 ExecutionModuleDescriptor md = slcAgent.getExecutionModuleDescriptor(
  79                                 moduleName, version);
  80                 return md;
  81         }
  82
  83         @RequestMapping("/listModulesDescriptors.service")
  84         protected ObjectList listModulesDescriptors(@RequestParam String agentId) {
  85                 // TODO: use centralized agentId property (from MsgConstants)?
  86                 SlcAgent slcAgent = agentFactory.getAgent(agentId);
  87
  88                 List<ExecutionModuleDescriptor> descriptors = slcAgent
  89                                 .listExecutionModuleDescriptors();
  90                 SortedSet<ExecutionModuleDescriptor> set = new TreeSet<ExecutionModuleDescriptor>(
  91                                 new Comparator<ExecutionModuleDescriptor>() {
  92
  93                                         public int compare(ExecutionModuleDescriptor md1,
  94                                                         ExecutionModuleDescriptor md2) {
  95                                                 String str1 = md1.getLabel() != null ? md1.getLabel()
  96                                                                 : md1.getName();
  97                                                 String str2 = md2.getLabel() != null ? md2.getLabel()
  98                                                                 : md2.getName();
  99                                                 return str1.compareTo(str2);
 100                                         }
 101                                 });
 102                 set.addAll(descriptors);
 103                 return new ObjectList(set);
 104         }
 105
 106         @RequestMapping("/getSlcExecution.service")
 107         protected SlcExecution getSlcExecution(@RequestParam String uuid) {
 108                 SlcExecution slcExecution = slcExecutionDao.getSlcExecution(uuid);
 109                 initializeSEM();
 110                 slcExecutionManager.retrieveRealizedFlows(slcExecution);
 111                 return slcExecution;
 112         }
 113
 114         @RequestMapping("/newSlcExecution.service")
 115         protected ExecutionAnswer newSlcExecution(HttpServletRequest request,
 116                         Model model) throws Exception {
 117
 118                 String agentId = request
 119                                 .getParameter(MsgConstants.PROPERTY_SLC_AGENT_ID);
 120                 Assert.notNull(agentId, "agent id");
 121
 122                 String answer = request.getParameter("body");
 123                 if (answer == null) {
 124                         // lets read the message body instead
 125                         BufferedReader reader = request.getReader();
 126                         StringBuffer buffer = new StringBuffer();
 127                         String line = null;
 128                         while (((line = reader.readLine()) != null)) {
 129                                 buffer.append(line);
 130                         }
 131                         answer = buffer.toString();
 132                 }
 133
 134                 if (log.isTraceEnabled())
 135                         log.debug("Received message:\n" + answer);
 136
 137                 StringSource source = new StringSource(answer);
 138                 SlcExecution slcExecution = (SlcExecution) unmarshaller
 139                                 .unmarshal(source);
 140
 141                 // Workaround for https://www.argeo.org/bugzilla/show_bug.cgi?id=86
 142                 if (slcExecution.getUuid() == null
 143                                 || slcExecution.getUuid().length() < 8)
 144                         slcExecution.setUuid(UUID.randomUUID().toString());
 145
 146                 slcExecution.setStatus(SlcExecution.STATUS_SCHEDULED);
 147                 slcExecution.getSteps().add(
 148                                 new SlcExecutionStep(SlcExecutionStep.START,
 149                                                 "Process started from the Web UI"));
 150
 151                 initializeSEM();
 152                 slcExecutionManager.storeRealizedFlows(slcExecution);
 153                 slcExecutionService.newExecution(slcExecution);
 154                 SlcAgent agent = agentFactory.getAgent(agentId);
 155                 agent.runSlcExecution(slcExecution);
 156
 157                 return ExecutionAnswer.ok("Execution completed properly");
 158         }
 159
 160         private void initializeSEM() {
 161                 slcExecutionManager = new SlcExecutionManager(unmarshaller, marshaller,
 162                                 attachmentsStorage);
 163         }
 164
 165         public void setSlcExecutionDao(SlcExecutionDao slcExecutionDao) {
 166                 this.slcExecutionDao = slcExecutionDao;
 167         }
 168
 169         public void setSlcExecutionService(SlcExecutionService slcExecutionService) {
 170                 this.slcExecutionService = slcExecutionService;
 171         }
 172
 173         public void setUnmarshaller(Unmarshaller unmarshaller) {
 174                 this.unmarshaller = unmarshaller;
 175         }
 176
 177         public void setMarshaller(Marshaller marshaller) {
 178                 this.marshaller = marshaller;
 179         }
 180
 181         public void setAttachmentsStorage(AttachmentsStorage attachmentsStorage) {
 182                 this.attachmentsStorage = attachmentsStorage;
 183         }
 184
 185         public void setAgentFactory(SlcAgentFactory agentFactory) {
 186                 this.agentFactory = agentFactory;
 187         }
 188
 189 }