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

Introduction

Here is the source code for org.alfresco.module.vti.web.ws.CheckInFileEndpoint.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 org.alfresco.module.vti.handler.CheckOutCheckInServiceHandler;
import org.alfresco.module.vti.handler.alfresco.VtiUtils;
import org.alfresco.service.cmr.model.FileNotFoundException;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.version.VersionType;
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;
import org.springframework.extensions.surf.util.URLDecoder;

/**
 * Class for handling CheckIn soap method
 * 
 * @author DmitryVas
 */
public class CheckInFileEndpoint extends AbstractEndpoint {

    private static Log logger = LogFactory.getLog(CheckInFileEndpoint.class);

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

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

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

    /**
     * Check in 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);

        // getting pageUrl parameter from request
        XPath xpath = new Dom4jXPath(buildXPath(prefix, "/CheckInFile/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());
        String context = soapRequest.getAlfrescoContextName();
        docPath = URIUtil.getPath(docPath).substring(context.length());

        // Get the comment
        xpath = new Dom4jXPath(buildXPath(prefix, "/CheckInFile/comment"));
        xpath.setNamespaceContext(nc);
        String comment = ((Element) xpath.selectSingleNode(soapRequest.getDocument().getRootElement()))
                .getTextTrim();

        // Get the checkin type
        xpath = new Dom4jXPath(buildXPath(prefix, "/CheckInFile/CheckinType"));
        xpath.setNamespaceContext(nc);
        Element typeE = (Element) xpath.selectSingleNode(soapRequest.getDocument().getRootElement());

        VersionType type = VersionType.MAJOR;
        if (typeE != null && typeE.getTextTrim().length() > 0) {
            String typeS = typeE.getTextTrim();
            if ("0".equals(typeS)) {
                type = VersionType.MINOR;
            } else if ("1".equals(typeS)) {
                type = VersionType.MAJOR;
            } else if ("2".equals(typeS)) {
                type = VersionType.MAJOR;
            } else {
                throw new VtiSoapException("Invalid Checkin Type '" + typeS + "' received", -1);
            }
        }

        // Good to go
        if (logger.isDebugEnabled()) {
            logger.debug("item parameter for this request: " + docPath);
        }

        NodeRef originalNode;
        boolean lockAfterSucess = true;

        // Do not lock original node if we work with Office 2008/2011 for Mac
        if (VtiUtils.isMacClientRequest(soapRequest)) {
            lockAfterSucess = false;
        }

        try {
            originalNode = handler.checkInDocument(docPath, type, comment, lockAfterSucess);
        } catch (FileNotFoundException fnfe) {
            throw new VtiSoapException("File not found", -1, fnfe);
        }

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

        soapResponse.setContentType("text/xml");
        if (logger.isDebugEnabled()) {
            logger.debug("Soap Method with name " + getName() + " is finished.");
        }

    }
}