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

Java tutorial

Introduction

Here is the source code for org.alfresco.module.vti.web.ws.UndoCheckOutFileEndpoint.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 org.alfresco.module.vti.handler.CheckOutCheckInServiceHandler;
import org.alfresco.service.cmr.repository.NodeRef;
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;

public class UndoCheckOutFileEndpoint extends AbstractEndpoint {

    private static Log logger = LogFactory.getLog(UndoCheckOutFileEndpoint.class);
    private final static String HEADER_X_OFFICE_VERSION = "X-Office-Version";

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

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

    public UndoCheckOutFileEndpoint(CheckOutCheckInServiceHandler handler) {
        this.handler = handler;
    }

    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);

        String host = getHost(soapRequest);
        String context = soapRequest.getAlfrescoContextName();

        // getting pageUrl parameter from request
        XPath xpath = new Dom4jXPath(buildXPath(prefix, "/UndoCheckOut/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");
        if (docPath.indexOf(host) == -1 || docPath.indexOf(context) == -1) {
            throw new VtiSoapException("Invalid URI: The format of the URI could not be determined", 0x80070002l);
        }
        docPath = docPath.substring(host.length() + context.length());

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

        boolean lockAfterSucess = false;
        String officeVersion = soapRequest.getHeader(HEADER_X_OFFICE_VERSION);

        // Lock original node if we work with Office 2010 and greater
        if (officeVersion != null && Integer.parseInt(officeVersion.split("\\.")[0]) >= 14) {
            lockAfterSucess = true;
        }

        NodeRef originalNode = handler.undoCheckOutDocument(docPath, lockAfterSucess);

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

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

    }
}