GenericWorkflowHandlerFactory

/*
 * Copyright 2011 Fraunhofer Gesellschaft, Munich, Germany,
 * for its Fraunhofer Institute for Computer Architecture and Software
 * Technology (FIRST), Berlin, Germany. All rights reserved.
 * http://www.first.fraunhofer.de/
 */

package net.kwfgrid.gwes;

import net.kwfgrid.gwes.exception.LoggingException;
import net.kwfgrid.gwes.exception.WorkflowSecurityException;
import net.kwfgrid.gworkflowdl.conversion.EPML2GWorkflowDLConverter;
import net.kwfgrid.gworkflowdl.conversion.EPNML2GWorkflowDLConverter;
import net.kwfgrid.gworkflowdl.conversion.GWorkflowDLConverter;
import net.kwfgrid.gworkflowdl.structure.WorkflowFormatException;
import org.apache.log4j.Logger;
import org.jdom.JDOMException;
import org.jdom.transform.XSLTransformException;

import java.io.IOException;
import java.util.regex.Pattern;

public class GenericWorkflowHandlerFactory {

    static final Logger logger = Logger.getLogger(GenericWorkflowHandlerFactory.class);

    private GWESEngine engine;

    /**
     * Regex pattern that identifies a GWorkflowDL XML string.
     */
    static final Pattern GWorkflowDL_1_0 = Pattern.compile("(?s).*<workflow.+gworkflowdl_1_0\\.xsd.+", Pattern.DOTALL);
    static final Pattern GWorkflowDL_1_1 = Pattern.compile("(?s).*<workflow.+gworkflowdl_1_1\\.xsd.+", Pattern.DOTALL);
    static final Pattern GWorkflowDL_2_0 = Pattern.compile("(?s).*<workflow.+gworkflowdl_2_0\\.xsd.+", Pattern.DOTALL);
    static final Pattern GWorkflowDL_2_1 = Pattern.compile("(?s).*<workflow.+gworkflowdl_2_1\\.xsd.+", Pattern.DOTALL);
    static final Pattern EPNML_1_1 = Pattern.compile("(?s).*<net.+type.+epnml-?1\\.?1.+", Pattern.DOTALL);
    static final Pattern EPML = Pattern.compile("(?s).*epml xmlns:.+=\"http://www.epml.de\".+", Pattern.DOTALL);

    public GenericWorkflowHandlerFactory(GWESEngine engine) {
        this.engine = engine;
    }

    GenericWorkflowHandler createWorkflowHandler(String workflowDescription, String userIdCredential) throws WorkflowFormatException, WorkflowSecurityException, LoggingException {
        GenericWorkflowHandler handler;
        String originalDescriptionType = Constants.WORKFLOW_DESCRIPTION_TYPE_DEFAULT;

        try {
            // GWorkflowDL 2.1 -> GWorkflowDLHandler
            if (GWorkflowDL_2_1.matcher(workflowDescription).matches()) {
                logger.info("Workflow description of type \"" + Constants.WORKFLOW_DESCRIPTION_TYPE_DEFAULT + "\" detected.");
                handler = new GWorkflowDLHandler(engine, originalDescriptionType, workflowDescription, userIdCredential);
            }

            // GWorkflowDL 2.0 -> GWorkflowDLHandler
            else if (GWorkflowDL_2_0.matcher(workflowDescription).matches()) {
                originalDescriptionType = "GWorkflowDL version 2.0";
                logger.info("Workflow description of type \"" + originalDescriptionType + "\" detected. Converting to \"" + Constants.WORKFLOW_DESCRIPTION_TYPE_DEFAULT + "\" ...");
                GWorkflowDLConverter converter = new GWorkflowDLConverter("gworkflowdl_2_0-to-2_1.xsl");
                String workflowDescriptionNew = converter.convert(workflowDescription);
                handler = new GWorkflowDLHandler(engine, originalDescriptionType, workflowDescriptionNew, userIdCredential);
            }

            // GWorkflowDL 1.1 -> GWorkflowDLHandler
            else if (GWorkflowDL_1_1.matcher(workflowDescription).matches()) {
                originalDescriptionType = "GWorkflowDL version 1.1";
                logger.info("Workflow description of type \"" + originalDescriptionType + "\" detected. Converting to \"" + Constants.WORKFLOW_DESCRIPTION_TYPE_DEFAULT + "\" ...");
                GWorkflowDLConverter converter = new GWorkflowDLConverter("gworkflowdl_1_1-to-2_1.xsl");
                String workflowDescriptionNew = converter.convert(workflowDescription);
                handler = new GWorkflowDLHandler(engine, originalDescriptionType, workflowDescriptionNew, userIdCredential);
            }

            // GWorkflowDL 1.0 -> GWorkflowDLHandler
            else if (GWorkflowDL_1_0.matcher(workflowDescription).matches()) {
                originalDescriptionType = "GWorkflowDL version 1.0";
                logger.info("Workflow description of type \"" + originalDescriptionType + "\" detected. Converting to \"" + Constants.WORKFLOW_DESCRIPTION_TYPE_DEFAULT + "\" ...");
                GWorkflowDLConverter converter = new GWorkflowDLConverter("gworkflowdl_1_0-to-2_1.xsl");
                String workflowDescriptionNew = converter.convert(workflowDescription);
                handler = new GWorkflowDLHandler(engine, originalDescriptionType, workflowDescriptionNew, userIdCredential);
            }

            // EPNML 1.1 -> GWorkflowDLHandler
            else if (EPNML_1_1.matcher(workflowDescription).matches()) {
                originalDescriptionType = "EPNML version 1.1";
                logger.info("Workflow description of type \"" + originalDescriptionType + "\" detected. Converting to \"" + Constants.WORKFLOW_DESCRIPTION_TYPE_DEFAULT + "\" ...");
                EPNML2GWorkflowDLConverter converter = new EPNML2GWorkflowDLConverter();
                String workflowDescriptionNew = converter.convertFromEPNMLToGWorkflowDL(workflowDescription);
                handler = new GWorkflowDLHandler(engine, originalDescriptionType, workflowDescriptionNew, userIdCredential);
            }

            // EPML 1.2 -> GWorkflowDLHandler
            else if (EPML.matcher(workflowDescription).matches()) {
                originalDescriptionType = "EPML version 1.2";
                logger.info("Workflow description of type \"" + originalDescriptionType + "\" detected. Converting to \"" + Constants.WORKFLOW_DESCRIPTION_TYPE_DEFAULT + "\" ...");
                EPML2GWorkflowDLConverter converter = new EPML2GWorkflowDLConverter();
                String workflowDescriptionNew = converter.convertFromEPMLToGWorkflowDL(workflowDescription);
                handler = new GWorkflowDLHandler(engine, originalDescriptionType, workflowDescriptionNew, userIdCredential);
            }

            // not supported workflow description language.
            else {
                logger.error("Unknown workflow description language. Currently, GWorkflowDL version 1.0, 1.1, 2.0, 2.1, (E)PNML 1.1 as well as EPML 1.2 are supported.\n" +
                        "The workflow description must contain a reference to the XML schema 'gworkflowdl_1_0.xsd', 'gworkflowdl_1_1.xsd', 'gworkflowdl_2_0.xsd', 'gworkflowdl_2_1.xsd', 'epnml-1.1', or to the namespace 'http://www.epml.de'\n" +
                        workflowDescription);
                throw new WorkflowFormatException("Unknown workflow description language. Currently, GWorkflowDL version 1.0, 1.1, 2.0, 2.1, (E)PNML 1.1 as well as EPML 1.2 are supported.\n" +
                        "The workflow description must contain a reference to the XML schema 'gworkflowdl_1_0.xsd', 'gworkflowdl_1_1.xsd', 'gworkflowdl_2_0.xsd', 'gworkflowdl_2_1.xsd', 'epnml-1.1', or to the namespace 'http://www.epml.de'\n" +
                        workflowDescription);
            }
        } catch (XSLTransformException e) {
            logger.error("Exception during conversion from " + originalDescriptionType + " to " + Constants.WORKFLOW_DESCRIPTION_TYPE_DEFAULT + ":\n" + e, e);
            throw new WorkflowFormatException("Exception during conversion from " + originalDescriptionType + " to " + Constants.WORKFLOW_DESCRIPTION_TYPE_DEFAULT + ":\n" + e, e);
        } catch (IOException e) {
            logger.error("Exception during conversion from " + originalDescriptionType + " to " + Constants.WORKFLOW_DESCRIPTION_TYPE_DEFAULT + ":\n" + e, e);
            throw new WorkflowFormatException("Exception during conversion from " + originalDescriptionType + " to " + Constants.WORKFLOW_DESCRIPTION_TYPE_DEFAULT + ":\n" + e, e);
        } catch (JDOMException e) {
            logger.error("Exception during conversion from " + originalDescriptionType + " to " + Constants.WORKFLOW_DESCRIPTION_TYPE_DEFAULT + ":\n" + e, e);
            throw new WorkflowFormatException("Exception during conversion from " + originalDescriptionType + " to " + Constants.WORKFLOW_DESCRIPTION_TYPE_DEFAULT + ":\n" + e, e);
        }
        return handler;
    }
}