XmlRpcStreamServer.java

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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.apache.xmlrpc.server;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.List;
import java.util.zip.GZIPInputStream;
import java.util.zip.GZIPOutputStream;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.xmlrpc.XmlRpcException;
import org.apache.xmlrpc.XmlRpcRequest;
import org.apache.xmlrpc.XmlRpcRequestConfig;
import org.apache.xmlrpc.common.ServerStreamConnection;
import org.apache.xmlrpc.common.XmlRpcStreamRequestConfig;
import org.apache.xmlrpc.common.XmlRpcStreamRequestProcessor;
import org.apache.xmlrpc.parser.XmlRpcRequestParser;
import org.apache.xmlrpc.serializer.DefaultXMLWriterFactory;
import org.apache.xmlrpc.serializer.XmlRpcWriter;
import org.apache.xmlrpc.serializer.XmlWriterFactory;
import org.apache.xmlrpc.util.SAXParsers;
import org.xml.sax.ContentHandler;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.XMLReader;


public abstract class XmlRpcStreamServer extends XmlRpcServer
                implements XmlRpcStreamRequestProcessor {
        private static final Log log = LogFactory.getLog(XmlRpcStreamServer.class);
        private XmlWriterFactory writerFactory = new DefaultXMLWriterFactory();
        private static final XmlRpcErrorLogger theErrorLogger = new XmlRpcErrorLogger();
        private XmlRpcErrorLogger errorLogger = theErrorLogger;
        
        protected XmlRpcRequest getRequest(final XmlRpcStreamRequestConfig pConfig,
                                                                           InputStream pStream) throws XmlRpcException {
                final XmlRpcRequestParser parser = new XmlRpcRequestParser(pConfig, getTypeFactory());
                final XMLReader xr = SAXParsers.newXMLReader();
                xr.setContentHandler(parser);
                try {
                        xr.parse(new InputSource(pStream));
                } catch (SAXException e) {
                        Exception ex = e.getException();
                        if (ex != null  &&  ex instanceof XmlRpcException) {
                                throw (XmlRpcException) ex;
                        }
                        throw new XmlRpcException("Failed to parse XML-RPC request: " + e.getMessage(), e);
                } catch (IOException e) {
                        throw new XmlRpcException("Failed to read XML-RPC request: " + e.getMessage(), e);
                }
                final List params = parser.getParams();
                return new XmlRpcRequest(){
                        public XmlRpcRequestConfig getConfig() { return pConfig; }
                        public String getMethodName() { return parser.getMethodName(); }
                        public int getParameterCount() { return params == null ? 0 : params.size(); }
                        public Object getParameter(int pIndex) { return params.get(pIndex); }
                };
        }

        protected XmlRpcWriter getXmlRpcWriter(XmlRpcStreamRequestConfig pConfig,
                                                                                   OutputStream pStream)
                        throws XmlRpcException {
                ContentHandler w = getXMLWriterFactory().getXmlWriter(pConfig, pStream);
                return new XmlRpcWriter(pConfig, w, getTypeFactory());
        }

        protected void writeResponse(XmlRpcStreamRequestConfig pConfig, OutputStream pStream,
                                                                 Object pResult) throws XmlRpcException {
                try {
                        getXmlRpcWriter(pConfig, pStream).write(pConfig, pResult);
                } catch (SAXException e) {
                        throw new XmlRpcException("Failed to write XML-RPC response: " + e.getMessage(), e);
                }
        }

    protected Throwable convertThrowable(Throwable pError) {
        return pError;
    }

    protected void writeError(XmlRpcStreamRequestConfig pConfig, OutputStream pStream,
                                                          Throwable pError)
                        throws XmlRpcException {
        final Throwable error = convertThrowable(pError);
        final int code;
                final String message;
                if (error instanceof XmlRpcException) {
                        XmlRpcException ex = (XmlRpcException) error;
                        code = ex.code;
                } else {
                        code = 0;
                }
                message = error.getMessage();
                try {
                        getXmlRpcWriter(pConfig, pStream).write(pConfig, code, message, error);
                } catch (SAXException e) {
                        throw new XmlRpcException("Failed to write XML-RPC response: " + e.getMessage(), e);
                }
        }

        public void setXMLWriterFactory(XmlWriterFactory pFactory) {
                writerFactory = pFactory;
        }

        public XmlWriterFactory getXMLWriterFactory() {
                return writerFactory;
        }

        protected InputStream getInputStream(XmlRpcStreamRequestConfig pConfig,
                                                                                 ServerStreamConnection pConnection) throws IOException {
                InputStream istream = pConnection.newInputStream();
                if (pConfig.isEnabledForExtensions()  &&  pConfig.isGzipCompressing()) {
                        istream = new GZIPInputStream(istream);
                }
                return istream;
        }

        protected OutputStream getOutputStream(ServerStreamConnection pConnection,
                                                                                   XmlRpcStreamRequestConfig pConfig, OutputStream pStream) throws IOException {
                if (pConfig.isEnabledForExtensions()  &&  pConfig.isGzipRequesting()) {
                        return new GZIPOutputStream(pStream);
                } else {
                        return pStream;
                }
        }

        protected OutputStream getOutputStream(XmlRpcStreamRequestConfig pConfig,
                                                                                   ServerStreamConnection pConnection,
                                                                                   int pSize) throws IOException {
            return pConnection.newOutputStream();
        }

        protected boolean isContentLengthRequired(XmlRpcStreamRequestConfig pConfig) {
                return false;
        }