dk.netarkivet.harvester.webinterface.TrapAction.java Source code

Introduction

Here is the source code for dk.netarkivet.harvester.webinterface.TrapAction.java

Source

/*
 * #%L
 * Netarchivesuite - harvester
 * %%
 * Copyright (C) 2005 - 2014 The Royal Danish Library, the Danish State and University Library,
 *             the National Library of France and the Austrian National Library.
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 2.1 of the
 * License, or (at your option) any later version.
 * 
 * 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 Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * <http://www.gnu.org/licenses/lgpl-2.1.html>.
 * #L%
 */

package dk.netarkivet.harvester.webinterface;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.jsp.PageContext;

import org.apache.commons.fileupload.servlet.ServletFileUpload;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import dk.netarkivet.common.exceptions.ArgumentNotValid;
import dk.netarkivet.common.exceptions.ForwardedToErrorPage;
import dk.netarkivet.common.utils.I18n;
import dk.netarkivet.common.webinterface.HTMLUtils;

/**
 * Abstract class representing an action to take on the collection of global crawler traps.
 */

public abstract class TrapAction {

    protected static final Logger log = LoggerFactory.getLogger(TrapAction.class);

    /**
     * This method processes the request to determine which action it corresponds to and passes the request along
     * accordingly. If it is a multipart post then it is passed along to a create-or-update instance. Otherwise if no
     * action is specified, none is taken. Otherwise the request is passed on to a specific concrete instance of this
     * class for further processing.
     *
     * @param context the original servlet context of the request.
     * @param i18n the internationalisation to be used.
     * @throws ForwardedToErrorPage if an exception is thrown while carrying out the action.
     */
    public static void processRequest(PageContext context, I18n i18n) throws ForwardedToErrorPage {
        ArgumentNotValid.checkNotNull(context, "PageContext context");
        ArgumentNotValid.checkNotNull(i18n, "I18n i18n");
        log.debug("Processing request");
        HttpServletRequest request = (HttpServletRequest) context.getRequest();

        try {
            if (ServletFileUpload.isMultipartContent(request)) {
                TrapActionEnum.CREATE_OR_UPDATE.getTrapAction().doAction(context, i18n);
            } else {
                String requestType = request.getParameter(Constants.TRAP_ACTION);
                if (requestType == null || requestType.isEmpty()) {
                    TrapActionEnum.NULL_ACTION.getTrapAction().doAction(context, i18n);
                } else {
                    TrapActionEnum actionType = TrapActionEnum.valueOf(requestType);
                    actionType.getTrapAction().doAction(context, i18n);
                }
            }
        } catch (Throwable e) {
            log.warn("Error in Global Crawler Traps", e);
            HTMLUtils.forwardWithErrorMessage(context, i18n, e, "errormsg;crawlertrap.action.error");
            throw new ForwardedToErrorPage("Error in Global Crawler Traps", e);
        }
    }

    /**
     * Method implementing the specific action to take.
     *
     * @param context the context of the servlet request triggering this action.
     * @param i18n the internationalisation to use for presenting the results.
     */
    protected abstract void doAction(PageContext context, I18n i18n);

}