com.adobe.acs.commons.workflow.bulk.execution.impl.servlets.StartServlet.java Source code

Java tutorial

Introduction

Here is the source code for com.adobe.acs.commons.workflow.bulk.execution.impl.servlets.StartServlet.java

Source

/*
 * #%L
 * ACS AEM Commons Bundle
 * %%
 * Copyright (C) 2013 Adobe
 * %%
 * 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.
 * #L%
 */
package com.adobe.acs.commons.workflow.bulk.execution.impl.servlets;

import static com.adobe.acs.commons.json.JsonObjectUtil.getBoolean;
import static com.adobe.acs.commons.json.JsonObjectUtil.getInteger;
import static com.adobe.acs.commons.json.JsonObjectUtil.getString;
import static org.apache.sling.api.servlets.ServletResolverConstants.SLING_SERVLET_EXTENSIONS;
import static org.apache.sling.api.servlets.ServletResolverConstants.SLING_SERVLET_METHODS;
import static org.apache.sling.api.servlets.ServletResolverConstants.SLING_SERVLET_RESOURCE_TYPES;
import static org.apache.sling.api.servlets.ServletResolverConstants.SLING_SERVLET_SELECTORS;

import java.io.IOException;

import javax.jcr.RepositoryException;
import javax.servlet.Servlet;
import javax.servlet.ServletException;

import org.apache.commons.lang.StringUtils;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.resource.ModifiableValueMap;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.api.servlets.SlingAllMethodsServlet;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.adobe.acs.commons.workflow.bulk.execution.BulkWorkflowEngine;
import com.adobe.acs.commons.workflow.bulk.execution.impl.runners.AEMTransientWorkflowRunnerImpl;
import com.adobe.acs.commons.workflow.bulk.execution.impl.runners.AEMWorkflowRunnerImpl;
import com.adobe.acs.commons.workflow.bulk.execution.impl.runners.FastActionManagerRunnerImpl;
import com.adobe.acs.commons.workflow.bulk.execution.model.Config;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;

/**
 * ACS AEM Commons - Bulk Workflow Manager - Start Servlet
 */
@SuppressWarnings("serial")
@Component(service = Servlet.class, property = {
        SLING_SERVLET_RESOURCE_TYPES + "=" + BulkWorkflowEngine.SLING_RESOURCE_TYPE,
        SLING_SERVLET_SELECTORS + "=start", SLING_SERVLET_METHODS + "=POST", SLING_SERVLET_EXTENSIONS + "=json" })
public class StartServlet extends SlingAllMethodsServlet {

    private static final Logger log = LoggerFactory.getLogger(StartServlet.class);

    @Reference
    private BulkWorkflowEngine bulkWorkflowEngine;

    @Override
    @SuppressWarnings("squid:S1192")
    protected final void doPost(SlingHttpServletRequest request, SlingHttpServletResponse response)
            throws ServletException, IOException {

        response.setContentType("application/json");
        response.setCharacterEncoding("UTF-8");

        try {
            final JsonObject params = new JsonParser().parse(request.getParameter("params")).getAsJsonObject();
            final ModifiableValueMap properties = request.getResource().adaptTo(ModifiableValueMap.class);

            properties.put("runnerType", getString(params, "runnerType"));
            properties.put("queryType", getString(params, "queryType"));
            properties.put("queryStatement", getString(params, "queryStatement"));
            properties.put("relativePath", StringUtils.removeStart(getString(params, "relativePath", ""), "/"));
            properties.put("workflowModel", getString(params, "workflowModelId"));
            properties.put("interval", getInteger(params, "interval", 10));
            properties.put("timeout", getInteger(params, "timeout", 30));
            properties.put("throttle", getInteger(params, "throttle", 10));
            properties.put("retryCount", getInteger(params, "retryCount", 0));
            properties.put("batchSize", getInteger(params, "batchSize", 10));
            String userEventData = getString(params, "userEventData");
            if (userEventData != null && !userEventData.isEmpty()) {
                properties.put("userEventData", userEventData);
            }

            properties.put("purgeWorkflow", getBoolean(params, "purgeWorkflow", false));
            properties.put("autoThrottle", getBoolean(params, "autoThrottle", true));

            if (AEMWorkflowRunnerImpl.class.getName().equals(properties.get("runnerType", String.class))
                    && isTransient(request.getResourceResolver(), properties.get("workflowModel", String.class))) {
                properties.put("runnerType", AEMTransientWorkflowRunnerImpl.class.getName());
            }

            // If FAM retires are enabled, then force BatchSize to be 1
            if (FastActionManagerRunnerImpl.class.getName().equals(properties.get("runnerType", ""))
                    && properties.get("retryCount", 0) > 0) {
                properties.put("batchSize", 1);
            }

            request.getResourceResolver().commit();

            Config config = request.getResource().adaptTo(Config.class);

            bulkWorkflowEngine.initialize(config);
            bulkWorkflowEngine.start(config);

            response.sendRedirect(
                    request.getResourceResolver().map(request, request.getResource().getPath()) + ".status.json");

        } catch (RepositoryException e) {
            log.error("Could not initialize Bulk Workflow: {}", e);

            JSONErrorUtil.sendJSONError(response, SlingHttpServletResponse.SC_INTERNAL_SERVER_ERROR,
                    "Could not initialize Bulk Workflow.", e.getMessage());

        } catch (IllegalArgumentException e) {
            log.warn("Could not initialize Bulk Workflow due to invalid arguments: {}", e);

            JSONErrorUtil.sendJSONError(response, SlingHttpServletResponse.SC_INTERNAL_SERVER_ERROR,
                    "Could not initialize Bulk Workflow due to invalid arguments.", e.getMessage());

        } catch (Exception e) {
            log.error("Could not initialize Bulk Workflow due to unexpected error: {}", e);

            JSONErrorUtil.sendJSONError(response, SlingHttpServletResponse.SC_INTERNAL_SERVER_ERROR,
                    "Could not start Bulk Workflow.", e.getMessage());
        }
    }

    private boolean isTransient(ResourceResolver resourceResolver, String workflowModelId) {
        Resource resource = resourceResolver.getResource(workflowModelId).getParent();
        return resource.getValueMap().get("transient", false);
    }
}