org.pageseeder.ox.berlioz.generator.ExecuteStep Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pso-ox-berlioz Show documentation
XML processing pipeline
There is a newer version: 2.2.93
/*
 * Copyright 2021 Allette Systems (Australia)
 * http://www.allette.com.au
 *
 * 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.
 */
package org.pageseeder.ox.berlioz.generator;

import org.pageseeder.berlioz.BerliozException;
import org.pageseeder.berlioz.GlobalSettings;
import org.pageseeder.berlioz.content.ContentGenerator;
import org.pageseeder.berlioz.content.ContentRequest;
import org.pageseeder.berlioz.content.ContentStatus;
import org.pageseeder.ox.api.Result;
import org.pageseeder.ox.berlioz.Requests;
import org.pageseeder.ox.core.*;
import org.pageseeder.ox.process.StepJobManager;
import org.pageseeder.ox.process.StepJobQueue;
import org.pageseeder.ox.util.StringUtils;
import org.pageseeder.xmlwriter.XMLWriter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.util.Enumeration;

/**
 * A generator to invoke OX Step.
 *
 * Parameter
 * 
 *  pipeline the id of the pipeline. By default use the first pipline in model
 *  step the id of step. By default use the first step in pipeline.
 * 
 *
 *
 * @author Ciber Cai
 * @version 16 June 2014
 */
public class ExecuteStep implements ContentGenerator {

  private static final Logger LOGGER = LoggerFactory.getLogger(ExecuteStep.class);

  @Override
  public void process(ContentRequest req, XMLWriter xml) throws BerliozException, IOException {
    // get the model
    Model model = Requests.getModel(req, xml);
    if (model == null) {
      req.setStatus(ContentStatus.NOT_FOUND);
      LOGGER.error("No model found.");
      return;
    }

    // Fetch the package data
    PackageData data = Requests.getPackageData(req, xml);

    //Add extra step parameters
    Enumeration extraParameters = req.getParameterNames();
    String parameterValue = null;
    while(extraParameters.hasMoreElements()) {
      String extraParameter = extraParameters.nextElement();
      boolean foundExtraParameter = false;
      if (!extraParameter.equals("id")
          &&!extraParameter.equals("pipeline")
          &&!extraParameter.equals("model")
          &&!extraParameter.equals("step")) {
        parameterValue = req.getParameter(extraParameter);
        if (StringUtils.isBlank(parameterValue)) parameterValue = "";
        data.setParameter(extraParameter, parameterValue);
        foundExtraParameter = true;
      }
      if (foundExtraParameter) {
        data.saveProperties();
        LOGGER.debug("New request parameters added to package {}", data.id());
      }
    }


    if (data == null) {
      req.setStatus(ContentStatus.NOT_FOUND);
      LOGGER.error("No package data found.");
      return;
    }

    // find the pipeline
    String pindex = req.getParameter("pipeline");

    Pipeline pipeline = null;
    if (pindex != null) {
      pipeline = model.getPipeline(pindex);
    } else {
      pipeline = model.getPipelineDefault();
    }

    if (pipeline == null) {
      req.setStatus(ContentStatus.NOT_FOUND);
      LOGGER.error("No pipeline found.");
      return;
    }

    // find the step
    String sindex = req.getParameter("step");
    StepDefinition stepDef = null;
    if (sindex != null) {
      stepDef = pipeline.getStep(sindex);
    } else {
      stepDef = pipeline.getStep(0);
    }

    if (stepDef == null) {
      req.setStatus(ContentStatus.NOT_FOUND);
      LOGGER.error("No Step found.");
      return;
    }

    // execute the step
    if (!stepDef.async()) {
      //Synchronous
      //TODO HTTPS Session
      Result result = stepDef.exec(data);
      stepDef.toXML(result, xml);
    } else {
      long startTime = System.currentTimeMillis();
      //Asynchronous
      int noThreads = GlobalSettings.get("ox2.step.threads-number",
          StepJobManager.DEAULT_NUMBER_OF_THREAD);
      int maxStoredCompletedJob = GlobalSettings.get("ox2.max-stored-completed-job",
          StepJobQueue.DEFAULT_MAX_STORED_COMPLETED_JOB);
      long maxInactiveTimeAllowed = Long.parseLong(GlobalSettings.get("ox2.max-inactive-time-ms", String.valueOf(StepJob.DEFAULT_MAX_INACTIVE_TIME_MS)));
      StepJobManager manager = new StepJobManager(noThreads, maxStoredCompletedJob);
      StepJob job = new StepJob(stepDef, data, maxInactiveTimeAllowed);
      manager.addJob(job);

      //Sametimes the execution of this will be very quickly, then before to return let's give some time and check the new status.
      long maxTimeToCheck = 30000;// thirty seconds (Because the maxInactiveTimeAllowed could 1 hour, then it limits to 30 seconds
      long currentTime = 0;
      do {
        try {
          Thread.sleep(5000);
        } catch (InterruptedException ex) {
          LOGGER.warn("An interruption exception happened in {}", ex.getMessage());
        }
        currentTime = System.currentTimeMillis();
      } while (!job.getStatus().hasCompleted() //While not completed
          && (currentTime-startTime) <= maxInactiveTimeAllowed // The current time spent to check is less than or equal the time allowed in the config
          && (currentTime-startTime) <= maxTimeToCheck);//The current time spent to check is less than or equal the time allowed by default

      job.toXML(xml);
      //If the job was not completed yet.
      if (!job.getStatus().hasCompleted()) {
        req.setStatus(ContentStatus.ACCEPTED);
      }
    }
  }
}