org.deegree.protocol.ows.http.OwsHttpResponseImpl.java Source code

Introduction

Here is the source code for org.deegree.protocol.ows.http.OwsHttpResponseImpl.java

Source

//$HeadURL$
/*----------------------------------------------------------------------------
 This file is part of deegree, http://deegree.org/
 Copyright (C) 2001-2011 by:
 - Department of Geography, University of Bonn -
 and
 - lat/lon GmbH -
    
 This library 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 2.1 of the License, or (at your option)
 any later version.
 This library 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 this library; if not, write to the Free Software Foundation, Inc.,
 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
    
 Contact information:
    
 lat/lon GmbH
 Aennchenstr. 19, 53177 Bonn
 Germany
 http://lat-lon.de/
    
 Department of Geography, University of Bonn
 Prof. Dr. Klaus Greve
 Postfach 1147, 53001 Bonn
 Germany
 http://www.geographie.uni-bonn.de/deegree/
    
 e-mail: info@deegree.org
 ----------------------------------------------------------------------------*/
package org.deegree.protocol.ows.http;

import static org.deegree.commons.ows.exception.OWSException.NO_APPLICABLE_CODE;
import static org.deegree.commons.xml.stax.XMLStreamUtils.skipStartDocument;
import static org.deegree.protocol.ows.exception.OWSExceptionReader.isExceptionReport;
import static org.deegree.protocol.ows.exception.OWSExceptionReader.parseExceptionReport;

import java.io.IOException;
import java.io.InputStream;
import java.util.Collections;

import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;

import org.apache.http.Header;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.StatusLine;
import org.apache.http.conn.ClientConnectionManager;
import org.deegree.commons.ows.exception.OWSException;
import org.deegree.protocol.ows.exception.OWSExceptionReport;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Encapsulates an HTTP response from an OGC web service.
 * <p>
 * NOTE: The receiver <b>must</b> call {@link #close()} eventually, otherwise the HTTP connection will not be freed.
 * </p>
 * 
 * @version $Revision$, $Date$
 */
public class OwsHttpResponseImpl implements OwsHttpResponse {

    private static Logger LOG = LoggerFactory.getLogger(OwsHttpResponseImpl.class);

    private static final XMLInputFactory xmlFac = XMLInputFactory.newInstance();

    private final HttpResponse httpResponse;

    private final ClientConnectionManager connManager;

    private final String url;

    private final InputStream is;

    /**
     * Creates a new {@link OwsHttpResponseImpl} instance.
     * 
     * @param httpResponse
     * @param httpClient
     * @param url
     * @throws IllegalStateException
     * @throws IOException
     */
    OwsHttpResponseImpl(HttpResponse httpResponse, ClientConnectionManager connManager, String url)
            throws IllegalStateException, IOException {
        this.httpResponse = httpResponse;
        this.connManager = connManager;
        this.url = url;
        HttpEntity entity = httpResponse.getEntity();
        if (entity == null) {
            // TODO exception
        }
        is = entity.getContent();
    }

    @Override
    public HttpResponse getAsHttpResponse() {
        return httpResponse;
    }

    @Override
    public CloseRequiredInputStream getAsBinaryStream() {
        return new CloseRequiredInputStream(this, is);
    }

    @Override
    public XMLStreamReader getAsXMLStream() throws OWSExceptionReport, XMLStreamException {
        XMLStreamReader xmlStream = xmlFac.createXMLStreamReader(url, is);
        assertNoExceptionReport(xmlStream);
        LOG.debug("Response root element: " + xmlStream.getName());
        String version = xmlStream.getAttributeValue(null, "version");
        LOG.trace("Response version attribute: " + version);
        return xmlStream;
    }

    private void assertNoExceptionReport(XMLStreamReader xmlStream) throws OWSExceptionReport, XMLStreamException {
        skipStartDocument(xmlStream);
        if (isExceptionReport(xmlStream.getName())) {
            try {
                throw parseExceptionReport(xmlStream);
            } finally {
                close();
            }
        }
    }

    @Override
    public void assertHttpStatus200() throws OWSExceptionReport {
        StatusLine statusLine = httpResponse.getStatusLine();
        int statusCode = statusLine.getStatusCode();
        if (statusCode != 200) {
            try {
                XMLStreamReader xmlStream = xmlFac.createXMLStreamReader(url, is);
                assertNoExceptionReport(xmlStream);
            } catch (OWSExceptionReport e) {
                throw e;
            } catch (Exception e) {
                throwHttpStatusException(statusLine);
            }
            throwHttpStatusException(statusLine);
        }
    }

    private void throwHttpStatusException(StatusLine statusLine) throws OWSExceptionReport {
        OWSException exception = new OWSException("Request failed with HTTP status " + statusLine.getStatusCode()
                + ": " + statusLine.getReasonPhrase(), NO_APPLICABLE_CODE);
        throw new OWSExceptionReport(Collections.singletonList(exception), null, null);
    }

    @Override
    public void assertNoXmlContentTypeAndExceptionReport() throws OWSExceptionReport, XMLStreamException {

        Header contentType = httpResponse.getFirstHeader("Content-Type");
        if (contentType != null && contentType.getValue().startsWith("text/xml")) {
            XMLStreamReader xmlStream = xmlFac.createXMLStreamReader(url, is);
            try {
                assertNoExceptionReport(xmlStream);
            } finally {
                xmlStream.close();
            }
        }
    }

    @Override
    public void close() {
        connManager.shutdown();
    }
}