com.google.api.client.http.LowLevelHttpResponse Maven / Gradle / Ivy
Show all versions of google-api-client Show documentation
/*
* Copyright (c) 2010 Google Inc.
*
* Licensed 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 com.google.api.client.http;
import java.io.IOException;
import java.io.InputStream;
/**
* Low-level HTTP response.
*
* This allows providing a different implementation of the HTTP response that is
* more compatible with the Java environment used.
*
* @since 1.0
* @author Yaniv Inbar
*/
public abstract class LowLevelHttpResponse {
/** Returns the HTTP response content input stream or {@code null} for none. */
public abstract InputStream getContent() throws IOException;
/**
* Returns the content encoding (for example {@code "gzip"}) or {@code null}
* for none.
*/
public abstract String getContentEncoding();
/** Returns the content length or {@code 0} for none. */
public abstract long getContentLength();
/** Returns the content type or {@code null} for none. */
public abstract String getContentType();
/** Returns the response status line or {@code null} for none. */
public abstract String getStatusLine();
/** Returns the response status code or {@code 0} for none. */
public abstract int getStatusCode();
/** Returns the HTTP reason phrase or {@code null} for none. */
public abstract String getReasonPhrase();
/**
* Returns the number of HTTP response headers.
*
* Note that multiple headers of the same name need to be supported, in which
* case each header value is treated as a separate header.
*/
public abstract int getHeaderCount();
/** Returns the HTTP response header name at the given zero-based index. */
public abstract String getHeaderName(int index);
/** Returns the HTTP response header value at the given zero-based index. */
public abstract String getHeaderValue(int index);
}