org.alfresco.module.vti.web.ws.CheckOutFileEndpoint.java Source code

Introduction

Here is the source code for org.alfresco.module.vti.web.ws.CheckOutFileEndpoint.java

Source

/*
 * #%L
 * Alfresco Sharepoint Protocol
 * %%
 * Copyright (C) 2005 - 2016 Alfresco Software Limited
 * %%
 * This file is part of the Alfresco software. 
 * If the software was purchased under a paid Alfresco license, the terms of 
 * the paid license agreement will prevail.  Otherwise, the software is 
 * provided under the following open source license terms:
 * 
 * Alfresco 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 3 of the License, or
 * (at your option) any later version.
 * 
 * Alfresco 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */

package org.alfresco.module.vti.web.ws;

import java.net.URLDecoder;

import javax.servlet.http.HttpServletResponse;

import org.alfresco.module.vti.handler.CheckOutCheckInServiceHandler;
import org.alfresco.module.vti.handler.alfresco.VtiUtils;
import org.alfresco.repo.security.permissions.AccessDeniedException;
import org.alfresco.service.cmr.model.FileNotFoundException;
import org.alfresco.service.cmr.repository.NodeRef;
import org.apache.commons.httpclient.util.URIUtil;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.dom4j.Element;
import org.jaxen.SimpleNamespaceContext;
import org.jaxen.XPath;
import org.jaxen.dom4j.Dom4jXPath;

/**
 * Class for handling CheckOut soap method
 * 
 * @author DmitryVas
 */
public class CheckOutFileEndpoint extends AbstractEndpoint {
    private static Log logger = LogFactory.getLog(CheckOutFileEndpoint.class);

    // handler that provides methods for checkOut/CheckIn operations
    private CheckOutCheckInServiceHandler handler;

    // xml namespace prefix
    private static String prefix = "webs";

    /**
     * constructor
     *
     * @param handler
     */
    public CheckOutFileEndpoint(CheckOutCheckInServiceHandler handler) {
        this.handler = handler;
    }

    /**
     * Check out file
     * 
     * @param soapRequest Vti soap request ({@link VtiSoapRequest})
     * @param soapResponse Vti soap response ({@link VtiSoapResponse}) 
     */
    public void execute(VtiSoapRequest soapRequest, VtiSoapResponse soapResponse) throws Exception {
        if (logger.isDebugEnabled())
            logger.debug("Soap Method with name " + getName() + " is started.");

        // mapping xml namespace to prefix
        SimpleNamespaceContext nc = new SimpleNamespaceContext();
        nc.addNamespace(prefix, namespace);
        nc.addNamespace(soapUriPrefix, soapUri);

        // Get the pageUrl parameter from the request
        XPath xpath = new Dom4jXPath(buildXPath(prefix, "/CheckOutFile/pageUrl"));
        xpath.setNamespaceContext(nc);
        Element docE = (Element) xpath.selectSingleNode(soapRequest.getDocument().getRootElement());
        if (docE == null || docE.getTextTrim().length() == 0) {
            throw new VtiSoapException("pageUrl must be supplied", 0x82000001l);
        }
        String docPath = URLDecoder.decode(docE.getTextTrim(), "UTF-8");
        String context = soapRequest.getAlfrescoContextName();

        docPath = URIUtil.getPath(docPath).substring(context.length());

        // Did they want to work on it locally?
        xpath = new Dom4jXPath(buildXPath(prefix, "/CheckOutFile/checkoutToLocal"));
        xpath.setNamespaceContext(nc);
        Element localE = (Element) xpath.selectSingleNode(soapRequest.getDocument().getRootElement());
        if (localE != null) {
            // If given, must be one of True or False
            String local = localE.getTextTrim().toLowerCase();
            if ("true".equals(local) || "false".equals(local)) {
                // Good
            } else {
                throw new VtiSoapException("Invalid CheckOutToLocal Parameter", -1);
            }
        }

        // Report what we're about to do
        if (logger.isDebugEnabled()) {
            logger.debug("About to check out " + docPath);
        }

        NodeRef workingCopy;
        boolean lockAfterSucess = true;

        // Do not lock working copy node if we work with Office 2008/2011 for Mac
        // this clients don't send UNLOCK method after SOAP CheckOutFile request, so no need to lock working copy
        if (VtiUtils.isMacClientRequest(soapRequest)) {
            lockAfterSucess = false;
        }

        try {
            workingCopy = handler.checkOutDocument(docPath, lockAfterSucess);

            // creating soap response
            Element responseElement = soapResponse.getDocument().addElement("CheckOutFileResponse", namespace);
            Element result = responseElement.addElement("CheckOutFileResult");
            result.setText(workingCopy != null ? "true" : "false");

            soapResponse.setContentType("text/xml");
            if (logger.isDebugEnabled()) {
                logger.debug("Soap Method with name " + getName() + " is finished.");
            }
        } catch (AccessDeniedException e) {
            soapResponse.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
        } catch (FileNotFoundException fnfe) {
            throw new VtiSoapException("File not found", -1, fnfe);
        }

    }

}