Java tutorial
/** * Copyright (C) 2009 - 2014 52North Initiative for Geospatial Open Source * Software GmbH * * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 as published * by the Free Software Foundation. * * If the program is linked with libraries which are licensed under one of * the following licenses, the combination of the program with the linked * library is not considered a "derivative work" of the program: * * Apache License, version 2.0 * Apache Software License, version 1.0 * GNU Lesser General Public License, version 3 * Mozilla Public License, versions 1.0, 1.1 and 2.0 * Common Development and Distribution License (CDDL), version 1.0 * * Therefore the distribution of the program linked with libraries licensed * under the aforementioned licenses, is permitted by the copyright holders * if the distribution is compliant with both the GNU General Public * License version 2 and the aforementioned licenses. * * This program is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General * Public License for more details. */ package org.n52.wps.python; import java.io.File; import java.io.FileNotFoundException; import java.io.IOException; import java.util.ArrayList; import java.util.HashMap; import java.util.Iterator; import java.util.List; import java.util.Map; import java.util.UUID; import net.opengis.wps.x100.ProcessDescriptionType; import org.apache.commons.io.FileUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.n52.wps.io.data.GenericFileDataWithGT; import org.n52.wps.io.data.GenericFileDataConstants; import org.n52.wps.io.data.IData; import org.n52.wps.io.data.binding.complex.GenericFileDataWithGTBinding; import org.n52.wps.server.IAlgorithm; import org.n52.wps.server.feed.movingcode.AlgorithmParameterType; import org.n52.wps.server.feed.movingcode.CommandLineParameter; import org.n52.wps.server.feed.movingcode.MovingCodeUtils; import org.n52.wps.server.feed.movingcode.MovingCodeObject; /** * @author Matthias Mueller, TU Dresden * */ public class PythonScriptDelegator implements IAlgorithm { private static final String COMMAND = "cmd /c"; private static Logger LOGGER = LoggerFactory.getLogger(PythonScriptDelegator.class); private final File scriptWorkspace; private final File workspaceBase; private CommandLineParameter[] scriptParameters; private MovingCodeObject mco; protected List<String> errors; public PythonScriptDelegator(MovingCodeObject templateMCO, File workspaceBase) throws IOException { this.workspaceBase = workspaceBase; this.errors = new ArrayList<String>(); mco = templateMCO.createChild(workspaceBase); this.scriptParameters = new CommandLineParameter[mco.getParameters().size()]; scriptWorkspace = new File(mco.getInstanceWorkspace().getCanonicalPath()); } public Map<String, IData> run(Map<String, List<IData>> inputData) { String instanceExecutable = scriptWorkspace.getAbsolutePath() + mco.getAlgorithmURL().getPublicPath(); List<AlgorithmParameterType> params = mco.getParameters(); HashMap<String, String> outputs = new HashMap<String, String>(); System.gc(); for (AlgorithmParameterType currentParam : params) { String wpsInputID = currentParam.getWpsInputID(); String wpsOutputID = currentParam.getWpsOutputID(); int positionID = currentParam.getPositionID().intValue(); CommandLineParameter cmdParam = null; // input parameters if (!wpsInputID.equalsIgnoreCase("")) { if (inputData.containsKey(wpsInputID)) { //open the IData list and iterate through it List<IData> dataItemList = inputData.get(wpsInputID); Iterator<IData> it = dataItemList.iterator(); //create CommanLineParameter Object cmdParam = new CommandLineParameter(currentParam.getPrefixString(), currentParam.getSuffixString(), currentParam.getSeparatorString()); while (it.hasNext()) { IData currentItem = it.next(); // load as file and add to CommanLineParameter cmdParam.addValue((MovingCodeUtils.loadSingleDataItem(currentItem, scriptWorkspace))); } } } else if (!wpsOutputID.equalsIgnoreCase("")) { // output only parameters !!ONLY SINGLE OUTPUT ITEMS SUPPORTED BY WPS!! // create CommanLineParameter Object cmdParam = new CommandLineParameter(currentParam.getPrefixString(), currentParam.getSuffixString(), currentParam.getSeparatorString()); // retrieve the default mimeType String mimeType = mco.getDefaultMimeType(wpsOutputID); // prepare output filename String extension = GenericFileDataConstants.mimeTypeFileTypeLUT().get(mimeType); String fileName = UUID.randomUUID() + "." + extension; fileName = scriptWorkspace.getAbsolutePath() + File.separator + fileName; cmdParam.addValue(fileName); } //prepare the output - files only if (!wpsOutputID.equalsIgnoreCase("")) { String fileName = cmdParam.getAsPlainString(); outputs.put(wpsOutputID, fileName); } // create a new parameter in the Parameter Array scriptParameters[positionID] = cmdParam; } // initialize execution LOGGER.info("Executing CommandLine Algorithm " + instanceExecutable + " . Parameter array contains " + scriptParameters.length + " parameters."); // build the execution command String command = COMMAND + " " + instanceExecutable; for (CommandLineParameter currentParam : scriptParameters) { // check for empty (possibly optional) parameters if (currentParam != null) { command = command + " " + currentParam.getAsCommandString(); } } // execute LOGGER.info("Executing " + command); executeScript(command, scriptWorkspace); //create the output - files only HashMap<String, IData> result = new HashMap<String, IData>(); for (String wpsOutputID : outputs.keySet()) { // create File object File currentFile = new File(outputs.get(wpsOutputID)); GenericFileDataWithGT outputFileData; try { // create the GenericFileData object outputFileData = new GenericFileDataWithGT(currentFile, mco.getDefaultMimeType(wpsOutputID)); // put result on output map result.put(wpsOutputID, new GenericFileDataWithGTBinding(outputFileData)); } catch (FileNotFoundException e) { LOGGER.error("Could not read output file: " + outputs.get(wpsOutputID)); e.printStackTrace(); } catch (IOException e) { LOGGER.error("Could not create output file from: " + outputs.get(wpsOutputID)); e.printStackTrace(); } } return result; } public List<String> getErrors() { return errors; } public ProcessDescriptionType getDescription() { return mco.getProcessDescription(); } public String getWellKnownName() { return mco.getProcessID(); } public boolean processDescriptionIsValid() { return mco.getProcessDescription().validate(); } public Class getInputDataType(String id) { return MovingCodeUtils.getInputDataType(mco, id); } public Class getOutputDataType(String id) { return MovingCodeUtils.getOutputDataType(mco, id); } private void executeScript(String command, File workspaceDir) //throws Exception { try { Process p = Runtime.getRuntime().exec(command, null, workspaceDir); p.waitFor(); if (p.exitValue() == 0) { LOGGER.info("Successfull termination of command:\n" + command); } else { LOGGER.error("Abnormal termination of command:\n" + command); LOGGER.error("Errorlevel / Exit Value: " + p.exitValue()); throw new IOException(); } } catch (IOException e) { LOGGER.error("Error executing command:\n" + command); e.printStackTrace(); //throw new Exception(); } catch (InterruptedException e) { LOGGER.error("Execution interrupted! Command was:\n" + command); e.printStackTrace(); //throw new Exception(); } } //delete the current workspace protected void finalize() { try { FileUtils.deleteDirectory(workspaceBase); } catch (IOException e) { LOGGER.error("Could not delete dead workspace:\n" + workspaceBase.getAbsolutePath()); e.printStackTrace(); } } }