org.wso2.carbon.connector.util.ResultPayloadCreator.java Source code

Java tutorial

Introduction

Here is the source code for org.wso2.carbon.connector.util.ResultPayloadCreator.java

Source

/*
* Copyright (c) 2016, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
*
* WSO2 Inc. licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License.
* You may obtain a copy of the License at
*
*http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.wso2.carbon.connector.util;

import org.apache.axiom.om.OMAbstractFactory;
import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.OMFactory;
import org.apache.axiom.om.OMNamespace;
import org.apache.axiom.soap.SOAPBody;
import org.apache.axis2.Constants;
import org.apache.axis2.builder.Builder;
import org.apache.axis2.builder.BuilderUtil;
import org.apache.axis2.format.DataSourceMessageBuilder;
import org.apache.axis2.format.ManagedDataSource;
import org.apache.axis2.format.ManagedDataSourceFactory;
import org.apache.axis2.transport.TransportUtils;
import org.apache.commons.io.input.AutoCloseInputStream;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.commons.vfs2.FileObject;
import org.apache.commons.vfs2.FileSystemException;
import org.apache.synapse.MessageContext;
import org.apache.synapse.SynapseException;
import org.apache.synapse.transport.passthru.util.BinaryRelayBuilder;

import javax.mail.internet.ContentType;
import javax.mail.internet.ParseException;
import java.io.IOException;
import java.io.InputStream;
import java.util.Iterator;

/**
 * This class is used to prepare the payload, generate the result to display after each file operation completes,
 * read the file content and set that content as the current SOAPEnvelope.
 */
public class ResultPayloadCreator {
    private static final Log log = LogFactory.getLog(ResultPayloadCreator.class);

    /**
     * Prepare payload is used to delete the element in existing body and add the new element.
     *
     * @param messageContext The message context that is used to prepare payload message flow.
     * @param element        The OMElement that needs to be added in the body.
     */
    public static void preparePayload(MessageContext messageContext, OMElement element) {
        SOAPBody soapBody = messageContext.getEnvelope().getBody();
        for (Iterator itr = soapBody.getChildElements(); itr.hasNext();) {
            OMElement child = (OMElement) itr.next();
            child.detach();
        }
        soapBody.addChild(element);
    }

    /**
     * Generate the result is used to display the result(true/false) after file operations complete.
     *
     * @param messageContext The message context that is used in generate result mediation flow.
     * @param resultStatus   Boolean value of the result to display.
     */
    public static void generateResult(MessageContext messageContext, boolean resultStatus) {
        OMFactory factory = OMAbstractFactory.getOMFactory();
        OMNamespace ns = factory.createOMNamespace(FileConstants.FILECON, FileConstants.NAMESPACE);
        OMElement result = factory.createOMElement(FileConstants.RESULT, ns);
        OMElement messageElement = factory.createOMElement(FileConstants.SUCCESS, ns);
        messageElement.setText(String.valueOf(resultStatus));
        result.addChild(messageElement);
        preparePayload(messageContext, result);
    }

    /**
     * Read the file content and set those content as the current SOAPEnvelope.
     *
     * @param file        File which needs to be read.
     * @param msgCtx      Message Context that is used in the file read mediation flow.
     * @param contentType content type.
     * @param streaming   streaming mode (true/false).
     * @return true, if file content is read successfully.
     */

    public static boolean buildFile(FileObject file, MessageContext msgCtx, String contentType, boolean streaming) {
        ManagedDataSource dataSource = null;
        InputStream in = null;
        try {
            if (StringUtils.isEmpty(contentType)) {
                if (file.getName().getExtension().toLowerCase().endsWith("xml")) {
                    contentType = "application/xml";
                } else if (file.getName().getExtension().toLowerCase().endsWith("txt")) {
                    contentType = "text/plain";
                }
            } else {
                // Extract the charset encoding from the configured content type and
                // set the CHARACTER_SET_ENCODING property as e.g. SOAPBuilder relies on this.
                try {
                    String charSetEnc = new ContentType(contentType).getParameter("charset");
                    msgCtx.setProperty(Constants.Configuration.CHARACTER_SET_ENCODING, charSetEnc);
                } catch (ParseException ex) {
                    throw new SynapseException("Invalid encoding type.", ex);
                }
            }
            if (log.isDebugEnabled()) {
                log.debug("Processed file : " + file + " of Content-type : " + contentType);
            }
            org.apache.axis2.context.MessageContext axis2MsgCtx = ((org.apache.synapse.core.axis2.Axis2MessageContext) msgCtx)
                    .getAxis2MessageContext();
            // Determine the message builder to use
            Builder builder;
            if (StringUtils.isEmpty(contentType)) {
                log.debug("No content type specified. Using RELAY builder.");
                builder = new BinaryRelayBuilder();
            } else {
                int index = contentType.indexOf(';');
                String type = index > 0 ? contentType.substring(0, index) : contentType;
                builder = BuilderUtil.getBuilderFromSelector(type, axis2MsgCtx);
                if (builder == null) {
                    if (log.isDebugEnabled()) {
                        log.debug(
                                "No message builder found for type '" + type + "'. Falling back to RELAY builder.");
                    }
                    builder = new BinaryRelayBuilder();
                }
            }
            // set the message payload to the message context
            OMElement documentElement;
            if (builder instanceof DataSourceMessageBuilder && streaming) {
                dataSource = ManagedDataSourceFactory.create(new FileObjectDataSource(file, contentType));
                documentElement = ((DataSourceMessageBuilder) builder).processDocument(dataSource, contentType,
                        axis2MsgCtx);
            } else {
                in = new AutoCloseInputStream(file.getContent().getInputStream());
                documentElement = builder.processDocument(in, contentType, axis2MsgCtx);
            }
            // We need this to build the complete message before closing the stream
            if (!streaming && documentElement != null) {
                //msgCtx.getEnvelope().build();
                documentElement.toString();
            }
            msgCtx.setEnvelope(TransportUtils.createSOAPEnvelope(documentElement));
        } catch (Exception e) {
            throw new SynapseException("Error while processing the file/folder", e);
        } finally {
            if (dataSource != null) {
                dataSource.destroy();
            }
            if (in != null) {
                try {
                    in.close();
                } catch (IOException e) {
                    log.error("Error while closing the InputStream");
                }
            }
            try {
                file.close();
            } catch (FileSystemException e) {
                log.error("Error while closing the FileObject", e);
            }
        }
        return true;
    }
}