org.eclipse.webdav.client.ResponseInputStream Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.guvnor.eclipse.webdav

We build this plugin because eclipse no longer distributes it and Guvnor tools needs it.

There is a newer version: 7.48.0.Final

package org.eclipse.webdav.client;

import java.io.FilterInputStream;
import java.io.IOException;
import org.eclipse.webdav.IContext;
import org.eclipse.webdav.IResponse;

/**
 * An InputStream on a response from a WebDAV server.
 * 
 * Note: This class/interface is part of an interim API that is still under 
 * development and expected to change significantly before reaching stability. 
 * It is being made available at this early stage to solicit feedback from pioneering 
 * adopters on the understanding that any code that uses this API will almost 
 * certainly be broken (repeatedly) as the API evolves.
 * 
 */
public class ResponseInputStream extends FilterInputStream {
    private IResponse response;

    /**
     * Creates a new input stream on the given response.
     *
     * @param response a response from a WebDAV server
     */
    public ResponseInputStream(IResponse response) {
        super(response.getInputStream());
        this.response = response;
    }

    /**
     * Closes the response and frees all system resources associated with
     * this input stream.
     */
    public void close() throws IOException {
        response.close();
    }

    /**
     * Returns the http header of the response from the WebDAV server on
     * which this input stream is based. The context contains information
     * that may be useful such as the content length and content type of
     * this input stream.
     */
    public IContext getContext() {
        return response.getContext();
    }
}