Class InputStreamContent

java.lang.Object

com.google.api.client.http.AbstractInputStreamContent

com.google.api.client.http.InputStreamContent

All Implemented Interfaces:

HttpContent, StreamingContent

public final class InputStreamContent
extends AbstractInputStreamContent

Concrete implementation of AbstractInputStreamContent that simply handles the transfer of data from an input stream to an output stream. This should only be used for streams that can not be re-opened and retried. If you have a stream that it is possible to recreate please create a new subclass of AbstractInputStreamContent.

The input stream is guaranteed to be closed at the end of AbstractInputStreamContent.writeTo(OutputStream).

Sample use with a URL:

private static void setRequestJpegContent(HttpRequest request, URL jpegUrl) throws IOException {
request.setContent(new InputStreamContent("image/jpeg", jpegUrl.openStream()));
}

Implementation is not thread-safe.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
private final InputStream	inputStream	Input stream to read from.
private long	length	Content length or less than zero if not known.
private boolean	retrySupported	Whether or not retry is supported.

Constructor Summary

Constructors

Constructor	Description
InputStreamContent(String type, InputStream inputStream)

Method Summary

Modifier and Type	Method	Description
InputStream	getInputStream()	Return an input stream for the specific implementation type of AbstractInputStreamContent.
long	getLength()	Returns the content length or less than zero if not known.
boolean	retrySupported()	Returns whether or not retry is supported on this content type.
InputStreamContent	setCloseInputStream(boolean closeInputStream)	Sets whether the input stream should be closed at the end of AbstractInputStreamContent.writeTo(OutputStream).
InputStreamContent	setLength(long length)	Sets the content length or less than zero if not known.
InputStreamContent	setRetrySupported(boolean retrySupported)	Sets whether or not retry is supported.
InputStreamContent	setType(String type)	Sets the content type or null for none.

Methods inherited from class AbstractInputStreamContent

getCloseInputStream, getType, writeTo

Methods inherited from class Object

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

Field Details

length

private long length

Content length or less than zero if not known. Defaults to -1.

retrySupported

private boolean retrySupported

Whether or not retry is supported. Defaults to false.

inputStream

private final InputStream inputStream

Input stream to read from.

Constructor Details

InputStreamContent

public InputStreamContent(String type,
 InputStream inputStream)

Parameters:

type - Content type or null for none

inputStream - Input stream to read from

Since:

1.5

Method Details

getLength

public long getLength()

Description copied from interface: HttpContent

Returns the content length or less than zero if not known.

retrySupported

public boolean retrySupported()

Description copied from interface: HttpContent

Returns whether or not retry is supported on this content type.

setRetrySupported

public InputStreamContent setRetrySupported(boolean retrySupported)

Sets whether or not retry is supported. Defaults to false.

Should be set to true if getInputStream() is called to reset to the original position of the input stream.

Since:

1.7

getInputStream

public InputStream getInputStream()

Description copied from class: AbstractInputStreamContent

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.

Specified by:

getInputStream in class AbstractInputStreamContent

setType

public InputStreamContent setType(String type)

Description copied from class: AbstractInputStreamContent

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

Overrides:

setType in class AbstractInputStreamContent

setCloseInputStream

public InputStreamContent setCloseInputStream(boolean closeInputStream)

Description copied from class: AbstractInputStreamContent

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

Overrides:

setCloseInputStream in class AbstractInputStreamContent

setLength

public InputStreamContent setLength(long length)

Sets the content length or less than zero if not known.

Defaults to -1.

Since:

1.5