com.google.api.client.http

Class AbstractInputStreamContent

java.lang.Object

com.google.api.client.http.AbstractInputStreamContent

All Implemented Interfaces:

HttpContent, StreamingContent

Direct Known Subclasses:

ByteArrayContent, FileContent, InputStreamContent

public abstract class AbstractInputStreamContent
extends Object
implements HttpContent

Serializes HTTP request content from an input stream into an output stream.

The type field is required. Subclasses should implement the HttpContent.getLength(), getInputStream(), and HttpContent.retrySupported() for their specific type of input stream. By default, all content is read from the input stream. If instead you want to limit the maximum amount of content read from the input stream, you may use ByteStreams.limit(InputStream, long).

Implementations don't need to be thread-safe.

Since:

1.4

Author:

[email protected] (Jacob Moshenko)

Constructor Summary

Constructors

Constructor and Description
AbstractInputStreamContent(String type)

Method Summary

Methods

Modifier and Type	Method and Description
static void	copy(InputStream inputStream, OutputStream outputStream) Deprecated. (scheduled to be removed in 1.15) Use IOUtils.copy(InputStream, OutputStream) instead
static void	copy(InputStream inputStream, OutputStream outputStream, boolean closeInputStream) Deprecated. (scheduled to be removed in 1.15) Use IOUtils.copy(InputStream, OutputStream, boolean) instead
boolean	getCloseInputStream() Returns whether the input stream should be closed at the end of writeTo(java.io.OutputStream).
String	getEncoding() Deprecated.
abstract InputStream	getInputStream() Return an input stream for the specific implementation type of AbstractInputStreamContent.
String	getType() Returns the content type or null for none.
AbstractInputStreamContent	setCloseInputStream(boolean closeInputStream) Sets whether the input stream should be closed at the end of writeTo(java.io.OutputStream).
AbstractInputStreamContent	setEncoding(String encoding) Deprecated. (scheduled to be removed in 1.15) Use HttpEncoding instead.
AbstractInputStreamContent	setType(String type) Sets the content type or null for none.
void	writeTo(OutputStream out) Writes the byte content to the given output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.api.client.http.HttpContent

getLength, retrySupported

Constructor Detail

AbstractInputStreamContent

public AbstractInputStreamContent(String type)

Parameters:

type - Content type or null for none

Since:

1.5

Method Detail

getInputStream

public abstract InputStream getInputStream()
                                    throws IOException

Return an input stream for the specific implementation type of AbstractInputStreamContent. If the specific implementation will return true for HttpContent.retrySupported() this should be a factory function which will create a new InputStream from the source data whenever invoked.

Throws:

IOException

Since:

1.7

writeTo

public void writeTo(OutputStream out)
             throws IOException

Description copied from interface: HttpContent

Writes the byte content to the given output stream.

Implementations must not close the output stream, and instead should flush the output stream. Some callers may assume that the the output stream has not been closed, and will fail to work if it has been closed.

Upgrade warning: in prior version 1.13 the implementation of this method was allowed to close the stream, but starting with 1.14 closing the stream is no longer allowed.

Specified by:

writeTo in interface HttpContent

Specified by:

writeTo in interface StreamingContent

Parameters:

out - output stream

Throws:

IOException

getEncoding

@Deprecated
public String getEncoding()

Deprecated.

Description copied from interface: HttpContent

Returns the content encoding (for example "gzip") or null for none.

Specified by:

getEncoding in interface HttpContent

getType

public String getType()

Description copied from interface: HttpContent

Returns the content type or null for none.

Specified by:

getType in interface HttpContent

getCloseInputStream

public final boolean getCloseInputStream()

Returns whether the input stream should be closed at the end of writeTo(java.io.OutputStream). Default is true.

Since:

1.7

setEncoding

@Deprecated
public AbstractInputStreamContent setEncoding(String encoding)

Deprecated. (scheduled to be removed in 1.15) Use HttpEncoding instead.

Sets the content encoding (for example "gzip") or null for none. Subclasses should override by calling super.

Since:

1.5

setType

public AbstractInputStreamContent setType(String type)

Sets the content type or null for none. Subclasses should override by calling super.

Since:

1.5

setCloseInputStream

public AbstractInputStreamContent setCloseInputStream(boolean closeInputStream)

Sets whether the input stream should be closed at the end of writeTo(java.io.OutputStream). Default is true. Subclasses should override by calling super.

Since:

1.7

copy

@Deprecated
public static void copy(InputStream inputStream,
                   OutputStream outputStream)
                 throws IOException

Deprecated. (scheduled to be removed in 1.15) Use IOUtils.copy(InputStream, OutputStream) instead

Writes the content provided by the given source input stream into the given destination output stream.

The input stream is guaranteed to be closed at the end of this method.

Sample use:

  static void downloadMedia(HttpResponse response, File file)
      throws IOException {
    FileOutputStream out = new FileOutputStream(file);
    try {
      AbstractInputStreamContent.copy(response.getContent(), out);
    } finally {
      out.close();
    }
  }
 

Parameters:

inputStream - source input stream

outputStream - destination output stream

Throws:

IOException

copy

@Deprecated
public static void copy(InputStream inputStream,
                   OutputStream outputStream,
                   boolean closeInputStream)
                 throws IOException

Deprecated. (scheduled to be removed in 1.15) Use IOUtils.copy(InputStream, OutputStream, boolean) instead

Writes the content provided by the given source input stream into the given destination output stream.

Sample use:

  static void downloadMedia(HttpResponse response, File file)
      throws IOException {
    FileOutputStream out = new FileOutputStream(file);
    try {
      AbstractInputStreamContent.copy(response.getContent(), out, true);
    } finally {
      out.close();
    }
  }
 

Parameters:

inputStream - source input stream

outputStream - destination output stream

closeInputStream - whether the input stream should be closed at the end of this method

Throws:

IOException

Since:

1.7