com.adobe.acs.commons.workflow.bulk.removal.impl.servlets.RemoveServlet.java Source code

Introduction

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

Source

/*
 * #%L
 * ACS AEM Commons Bundle
 * %%
 * Copyright (C) 2015 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.removal.impl.servlets;

import static com.adobe.acs.commons.json.JsonObjectUtil.getInteger;
import static com.adobe.acs.commons.json.JsonObjectUtil.getLong;
import static com.adobe.acs.commons.json.JsonObjectUtil.getString;
import static com.adobe.acs.commons.json.JsonObjectUtil.toJsonObject;
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 java.util.ArrayList;
import java.util.Calendar;
import java.util.List;
import java.util.regex.Pattern;

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.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.removal.WorkflowInstanceRemover;
import com.adobe.acs.commons.workflow.bulk.removal.WorkflowRemovalForceQuitException;
import com.google.gson.JsonArray;
import com.google.gson.JsonObject;

/**
 * ACS AEM Commons - Workflow Instance Remover - Remove Servlet
 */
@SuppressWarnings("serial")
@Component(service = Servlet.class, property = {
        SLING_SERVLET_RESOURCE_TYPES + "=acs-commons/components/utilities/workflow-remover",
        SLING_SERVLET_SELECTORS + "=remove", SLING_SERVLET_METHODS + "=POST", SLING_SERVLET_EXTENSIONS + "=json" })
public class RemoveServlet extends SlingAllMethodsServlet {
    private static final Logger log = LoggerFactory.getLogger(RemoveServlet.class);

    private static final String PARAM_BATCH_SIZE = "batchSize";

    private static final String PARAM_WORKFLOW_STATUSES = "statuses";

    private static final String PARAM_WORKFLOW_MODELS = "models";

    private static final String PARAM_WORKFLOW_PAYLOADS = "payloads";

    private static final String PARAM_OLDER_THAN = "olderThan";

    private static final String PARAM_MAX_DURATION = "maxDuration";

    private static final int MS_IN_SECOND = 1000;

    private static final int DEFAULT_BATCH_SIZE = 1000;

    private static final int DEFAULT_MAX_DURATION = 0;

    @Reference
    private WorkflowInstanceRemover workflowInstanceRemover;

    @Override
    public final void doPost(SlingHttpServletRequest request, SlingHttpServletResponse response)
            throws ServletException, IOException {

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

        List<String> statuses = new ArrayList<>();
        List<String> models = new ArrayList<>();
        List<Pattern> payloads = new ArrayList<>();
        Calendar olderThan = null;

        try {
            JsonObject params = toJsonObject(request.getParameter("params"));

            JsonArray jsonArray = params.getAsJsonArray(PARAM_WORKFLOW_STATUSES);
            for (int i = 0; i < jsonArray.size(); i++) {
                statuses.add(jsonArray.get(i).getAsString());
            }

            jsonArray = params.getAsJsonArray(PARAM_WORKFLOW_MODELS);
            for (int i = 0; i < jsonArray.size(); i++) {
                models.add(jsonArray.get(i).getAsString());
            }

            jsonArray = params.getAsJsonArray(PARAM_WORKFLOW_PAYLOADS);
            for (int i = 0; i < jsonArray.size(); i++) {
                final JsonObject tmp = jsonArray.get(i).getAsJsonObject();
                final String pattern = getString(tmp, "pattern");

                if (StringUtils.isNotBlank(pattern)) {
                    payloads.add(Pattern.compile(pattern));
                }
            }

            final Long ts = getLong(params, PARAM_OLDER_THAN);
            if (ts != null && ts > 0) {
                olderThan = Calendar.getInstance();
                olderThan.setTimeInMillis(ts * MS_IN_SECOND);
            }

            int batchSize = getInteger(params, PARAM_BATCH_SIZE);
            if (batchSize < 1) {
                batchSize = DEFAULT_BATCH_SIZE;
            }

            int maxDuration = getInteger(params, PARAM_MAX_DURATION);
            if (maxDuration < 1) {
                maxDuration = DEFAULT_MAX_DURATION;
            }

            workflowInstanceRemover.removeWorkflowInstances(request.getResourceResolver(), models, statuses,
                    payloads, olderThan, batchSize, maxDuration);

        } catch (WorkflowRemovalForceQuitException e) {
            response.setStatus(599);
            response.getWriter().write("Workflow removal force quit");

        } catch (Exception e) {
            log.error("An error occurred while attempting to remove workflow instances.", e);

            response.setStatus(SlingHttpServletResponse.SC_INTERNAL_SERVER_ERROR);

            if (response.getWriter() != null) {
                response.getWriter().write(e.getMessage());
            }
        }
    }
}