com.baidubce.model

Class AbstractBceStreamResponse

java.lang.Object

com.baidubce.model.AbstractBceResponse

com.baidubce.model.AbstractBceStreamResponse

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable

public class AbstractBceStreamResponse
extends AbstractBceResponse
implements Closeable

Abstract response class for BCE responses that contain a file stream. This class holds the raw InputStream from the HTTP response and must be closed after use.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.baidubce.model.AbstractBceResponse

metadata

Constructor Summary

Constructors

Constructor and Description
AbstractBceStreamResponse()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the content stream and the underlying HTTP response.
InputStream	getContent() Gets the content stream from the response.
long	getContentLength() Gets the content length of the response.
String	getContentType() Gets the content type of the response.
void	populateStream(InputStream stream) 默认实现：将响应流写入 content 字段。 生成的 response 子类可覆写此方法，将流写入用户指定的字段。
void	setContent(InputStream content) Sets the content stream.
void	setContentLength(long contentLength) Sets the content length of the response.
void	setContentType(String contentType) Sets the content type of the response.
void	setHttpResponse(org.apache.http.client.methods.CloseableHttpResponse httpResponse) Sets the underlying HTTP response for proper resource management.

Methods inherited from class com.baidubce.model.AbstractBceResponse

getMetadata, setMetadata, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBceStreamResponse

public AbstractBceStreamResponse()

Method Detail

getContent

public InputStream getContent()

Gets the content stream from the response. The caller is responsible for closing the stream and this response object after use.

Returns:

the content stream

setContent

public void setContent(InputStream content)

Sets the content stream.

Parameters:

content - the content stream

populateStream

public void populateStream(InputStream stream)

默认实现：将响应流写入 content 字段。 生成的 response 子类可覆写此方法，将流写入用户指定的字段。

setHttpResponse

public void setHttpResponse(org.apache.http.client.methods.CloseableHttpResponse httpResponse)

Sets the underlying HTTP response for proper resource management.

Parameters:

httpResponse - the HTTP response

getContentType

public String getContentType()

Gets the content type of the response.

Returns:

the content type

setContentType

public void setContentType(String contentType)

Sets the content type of the response.

Parameters:

contentType - the content type

getContentLength

public long getContentLength()

Gets the content length of the response.

Returns:

the content length, or -1 if unknown

setContentLength

public void setContentLength(long contentLength)

Sets the content length of the response.

Parameters:

contentLength - the content length

close

public void close()
           throws IOException

Closes the content stream and the underlying HTTP response. This method must be called after the stream has been fully consumed.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an I/O error occurs