ca.nrc.cadc.uws.web.restlet.resources.AsynchResource.java Source code

Java tutorial

Introduction

Here is the source code for ca.nrc.cadc.uws.web.restlet.resources.AsynchResource.java

Source

/*
************************************************************************
*******************  CANADIAN ASTRONOMY DATA CENTRE  *******************
**************  CENTRE CANADIEN DE DONNES ASTRONOMIQUES  **************
*
*  (c) 2009.                            (c) 2009.
*  Government of Canada                 Gouvernement du Canada
*  National Research Council            Conseil national de recherches
*  Ottawa, Canada, K1A 0R6              Ottawa, Canada, K1A 0R6
*  All rights reserved                  Tous droits rservs
*
*  NRC disclaims any warranties,        Le CNRC dnie toute garantie
*  expressed, implied, or               nonce, implicite ou lgale,
*  statutory, of any kind with          de quelque nature que ce
*  respect to the software,             soit, concernant le logiciel,
*  including without limitation         y compris sans restriction
*  any warranty of merchantability      toute garantie de valeur
*  or fitness for a particular          marchande ou de pertinence
*  purpose. NRC shall not be            pour un usage particulier.
*  liable in any event for any          Le CNRC ne pourra en aucun cas
*  damages, whether direct or           tre tenu responsable de tout
*  indirect, special or general,        dommage, direct ou indirect,
*  consequential or incidental,         particulier ou gnral,
*  arising from the use of the          accessoire ou fortuit, rsultant
*  software.  Neither the name          de l'utilisation du logiciel. Ni
*  of the National Research             le nom du Conseil National de
*  Council of Canada nor the            Recherches du Canada ni les noms
*  names of its contributors may        de ses  participants ne peuvent
*  be used to endorse or promote        tre utiliss pour approuver ou
*  products derived from this           promouvoir les produits drivs
*  software without specific prior      de ce logiciel sans autorisation
*  written permission.                  pralable et particulire
*                                       par crit.
*
*  This file is part of the             Ce fichier fait partie du projet
*  OpenCADC project.                    OpenCADC.
*
*  OpenCADC is free software:           OpenCADC est un logiciel libre ;
*  you can redistribute it and/or       vous pouvez le redistribuer ou le
*  modify it under the terms of         modifier suivant les termes de
*  the GNU Affero General Public        la GNU Affero General Public
*  License as published by the          License? telle que publie
*  Free Software Foundation,            par la Free Software Foundation
*  either version 3 of the              : soit la version 3 de cette
*  License, or (at your option)         licence, soit ( votre gr)
*  any later version.                   toute version ultrieure.
*
*  OpenCADC is distributed in the       OpenCADC est distribu
*  hope that it will be useful,         dans lespoir quil vous
*  but WITHOUT ANY WARRANTY;            sera utile, mais SANS AUCUNE
*  without even the implied             GARANTIE : sans mme la garantie
*  warranty of MERCHANTABILITY          implicite de COMMERCIALISABILIT
*  or FITNESS FOR A PARTICULAR          ni dADQUATION  UN OBJECTIF
*  PURPOSE.  See the GNU Affero         PARTICULIER. Consultez la Licence
*  General Public License for           Gnrale Publique GNU Affero
*  more details.                        pour plus de dtails.
*
*  You should have received             Vous devriez avoir reu une
*  a copy of the GNU Affero             copie de la Licence Gnrale
*  General Public License along         Publique GNU Affero avec
*  with OpenCADC.  If not, see          OpenCADC ; si ce nest
*  <http://www.gnu.org/licenses/>.      pas le cas, consultez :
*                                       <http://www.gnu.org/licenses/>.
*
*  $Revision: 4 $
*
************************************************************************
*/

package ca.nrc.cadc.uws.web.restlet.resources;

import java.io.IOException;
import java.security.AccessControlException;
import java.security.PrivilegedAction;
import java.security.PrivilegedActionException;
import java.security.PrivilegedExceptionAction;
import java.text.DateFormat;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Date;
import java.util.Iterator;
import java.util.List;

import javax.security.auth.Subject;

import org.apache.log4j.Logger;
import org.jdom2.Document;
import org.jdom2.Element;
import org.restlet.data.Form;
import org.restlet.data.Status;
import org.restlet.representation.Representation;
import org.restlet.resource.Post;

import ca.nrc.cadc.auth.AuthMethod;
import ca.nrc.cadc.auth.AuthenticationUtil;
import ca.nrc.cadc.date.DateUtil;
import ca.nrc.cadc.io.ByteLimitExceededException;
import ca.nrc.cadc.net.TransientException;
import ca.nrc.cadc.uws.ExecutionPhase;
import ca.nrc.cadc.uws.Job;
import ca.nrc.cadc.uws.JobListWriter;
import ca.nrc.cadc.uws.JobRef;
import ca.nrc.cadc.uws.server.JobPersistenceException;
import ca.nrc.cadc.uws.web.restlet.RestletJobCreator;

/**
 * Resource to handle Asynchronous calls.
 */
public class AsynchResource extends UWSResource {
    private final static Logger LOGGER = Logger.getLogger(AsynchResource.class);

    private DateFormat dateFormat = DateUtil.getDateFormat(DateUtil.IVOA_DATE_FORMAT, DateUtil.UTC);

    /**
     * Accept POST requests.
     *
     * @param entity    The POST Request body.
     */
    @Post
    public void accept(final Representation entity) {
        Subject subject = getSubject();
        if (subject == null) // anon
        {
            doAccept(entity);
        } else {
            Subject.doAs(subject, new PrivilegedAction<Object>() {
                public Object run() {
                    doAccept(entity);
                    return null;
                }
            });
        }
    }

    @SuppressWarnings("CallToThreadDumpStack")
    private void doAccept(final Representation entity) {
        try {
            final RestletJobCreator jobCreator = new RestletJobCreator(getInlineContentHandler());
            final Job job = jobCreator.create(entity);

            job.setRequestPath(getRequestPath());
            job.setRemoteIP(getRemoteIP());

            Job persistedJob = getJobManager().create(job);
            redirectSeeOther(getHostPart() + getRequestPath() + "/" + persistedJob.getID());
        } catch (ByteLimitExceededException ex) {
            String errorMessage = "XML document exceeds " + ex.getLimit() + " bytes";
            LOGGER.info("Exception caught in doAccept: " + errorMessage);
            generateErrorRepresentation(Status.CLIENT_ERROR_REQUEST_ENTITY_TOO_LARGE, errorMessage);
        } catch (AccessControlException e) {
            generateErrorRepresentation(Status.CLIENT_ERROR_FORBIDDEN, e.getMessage());
        } catch (TransientException t) {
            generateRetryRepresentation(t);
        } catch (Exception ex) {
            LOGGER.error("Exception caught in doAccept: " + ex);
            generateErrorRepresentation(Status.CLIENT_ERROR_BAD_REQUEST, ex.getMessage());
        }
    }

    /**
     * Assemble the XML for this Resource's Representation into the given
     * Document.
     *
     * @param document The Document to build up.
     * @throws java.io.IOException If something went wrong or the XML cannot be
     *                             built.
     */

    @Override
    protected void buildXML(final Document document) throws IOException {
        Subject subject = getSubject();
        if (subject == null) // anon
        {
            doBuildXML(document);
        }

        try {
            Subject.doAs(subject, new PrivilegedExceptionAction<Object>() {
                public Object run() throws Exception {
                    doBuildXML(document);
                    return null;
                }
            });
        } catch (PrivilegedActionException e) {
            throw new IOException(e.getCause());
        }
    }

    private void doBuildXML(final Document document) throws IOException {
        Form query = getQuery();
        String[] phases = query.getValuesArray("PHASE", true);
        String after = query.getFirstValue("AFTER", true);
        String last = query.getFirstValue("LAST", true);
        try {
            Subject caller = AuthenticationUtil.getCurrentSubject();
            AuthMethod am = AuthenticationUtil.getAuthMethod(caller);
            if (am == null || AuthMethod.ANON.equals(am)) {
                generateErrorRepresentation(Status.CLIENT_ERROR_FORBIDDEN, "anonymous job listing not permitted");
            }

            List<ExecutionPhase> phaseList = new ArrayList<ExecutionPhase>();
            for (String es : phases) {
                try {
                    phaseList.add(ExecutionPhase.toValue(es));
                } catch (IllegalArgumentException e) {
                    throw new IllegalArgumentException("invalid parameter: PHASE=" + es);
                }
            }

            String path = getRequestPath();
            int i = path.indexOf('/', 2); // the second /
            String appname = path.substring(0, i + 1); // include second /

            // parse 'last' parameter
            Integer lastInt = null;
            if (last != null) {
                try {
                    lastInt = Integer.parseInt(last);
                } catch (NumberFormatException e) {
                    throw new IllegalArgumentException("invalid parameter: LAST=" + last);
                }

                if (lastInt < 1)
                    throw new IllegalArgumentException("invalid parameter: LAST=" + last);
            }

            // parse 'after' parameter
            Date afterDate = null;
            if (after != null) {
                try {
                    afterDate = dateFormat.parse(after);
                } catch (ParseException e) {
                    throw new IllegalArgumentException("invalid parameter: AFTER=" + after);
                }
            }

            Iterator<JobRef> jobs = getJobManager().iterator(appname, phaseList, afterDate, lastInt);
            JobListWriter jobListWriter = new JobListWriter();
            Element root = jobListWriter.getRootElement(jobs);
            document.setRootElement(root);
        } catch (IllegalArgumentException ex) {
            String msg = ex.getMessage();
            LOGGER.debug(msg);
            generateErrorRepresentation(Status.CLIENT_ERROR_BAD_REQUEST, msg);
        } catch (UnsupportedOperationException e) {
            // not implemented--turn into a 'Forbidden'
            throw new AccessControlException("permission denied: " + e.getMessage());
        } catch (TransientException e) {
            LOGGER.error(e);
            generateErrorRepresentation(Status.SERVER_ERROR_SERVICE_UNAVAILABLE, "Transient error.");
        } catch (JobPersistenceException e) {
            LOGGER.error("persistence fail", e);
            generateErrorRepresentation(Status.SERVER_ERROR_INTERNAL, "Internal error.");
        }
    }
}