org.geotools.data.ows.HTTPResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gt-main Show documentation

The main module contains the GeoTools public interfaces that are used by other GeoTools modules (and GeoTools applications). Where possible we make use industry standard terms as provided by OGC and ISO standards. The formal GeoTools public api consists of gt-metadata, jts and the gt-main module. The main module contains the default implementations that are available provided to other GeoTools modules using our factory system. Factories are obtained from an appropriate FactoryFinder, giving applications a chance configure the factory used using the Factory Hints facilities. FilterFactory ff = CommonFactoryFinder.getFilterFactory(); Expression expr = ff.add( expression1, expression2 ); If you find yourself using implementation specific classes chances are you doing it wrong: Expression expr = new AddImpl( expression1, expressiom2 );

There is a newer version: 24.2-oss84-1

Show newest version

/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2004-2011, Open Source Geospatial Foundation (OSGeo)
 *
 *    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;
 *    version 2.1 of the License.
 *
 *    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.
 */
package org.geotools.data.ows;

import java.io.IOException;
import java.io.InputStream;

/**
 * Interface by which an {@link AbstractOpenWebService} retrieves the contents of an HTTP request
 * issued through its {@link HTTPClient}.
 *
 * An HTTPResponse instance shall be {@link #dispose() disposed} as soon as it's {@link
 * #getResponseStream() response stream} has been consumed or is no longer needed. It's up to the
 * implementations to just close the actual {@link InputStream} or return the http connection to the
 * connection pool, or any other resource clean up task that needs to be done.
 *
 * @author groldan
 * @see HTTPClient
 */
public interface HTTPResponse {

    /**
     * Disposes this HTTP response and cleans up any resource being held.
     *
     * Multiple invocations of this method shall not raise an exception but return silently.
     */
    public void dispose();

    /** Short cut for {@code getResponseHeader("Content-Type")} */
    public String getContentType();

    /** Returns the value of the requested HTTP response header, or {@code null} if not set. */
    public String getResponseHeader(String headerName);

    /**
     * Returns the HTTP response content byte stream, automatically recognizing gzip encoded
     * responses and returning an uncompressing stream if that's the case.
     *
     * @throws IOException if such happens when obtaining the response stream.
     */
    public InputStream getResponseStream() throws IOException;

    /**
     * @return the response charset parsed out of the content type response header, if any, or
     *     {@code null} otherwise.
     */
    public String getResponseCharset();
}