org.apache.olingo.client.core.communication.request

Class AbstractODataStreamManager<T extends ODataResponse>

java.lang.Object

org.apache.olingo.client.core.communication.request.AbstractODataStreamer

org.apache.olingo.client.core.communication.request.AbstractODataStreamManager<T>

Type Parameters:

T - OData response type corresponding to the request implementation.

All Implemented Interfaces:

ODataPayloadManager<T>, ODataStreamer

Direct Known Subclasses:

AbstractBatchManager, ODataMediaEntityCreateRequestImpl.MediaEntityCreateStreamManagerImpl, ODataMediaEntityUpdateRequestImpl.MediaEntityUpdateStreamManagerImpl, ODataStreamUpdateRequestImpl.StreamUpdateStreamManagerImpl

public abstract class AbstractODataStreamManager<T extends ODataResponse>
extends AbstractODataStreamer
implements ODataPayloadManager<T>

OData request payload management abstract class.

Field Summary

Fields inherited from class org.apache.olingo.client.core.communication.request.AbstractODataStreamer

LOG

Fields inherited from interface org.apache.olingo.client.api.communication.request.ODataStreamer

CRLF

Constructor Summary

Constructors

Constructor and Description
AbstractODataStreamManager(Wrapper<Future<org.apache.http.HttpResponse>> futureWrap) Constructor.
AbstractODataStreamManager(Wrapper<Future<org.apache.http.HttpResponse>> futureWrap, InputStream input) Constructor.
AbstractODataStreamManager(Wrapper<Future<org.apache.http.HttpResponse>> futureWrap, PipedOutputStream output) Constructor.

Method Summary

Modifier and Type	Method and Description
void	finalizeBody() Closes piped output stream.
Future<T>	getAsyncResponse() Closes the payload input stream and ask for an asynchronous response.
InputStream	getBody() Gets payload stream.
protected org.apache.http.HttpResponse	getHttpResponse(long timeout, TimeUnit unit) Gets HttpResponse.
T	getResponse() Closes the payload input stream and gets the OData response back.
abstract T	getResponse(long timeout, TimeUnit unit) Gets OData response.

Methods inherited from class org.apache.olingo.client.core.communication.request.AbstractODataStreamer

getBodyStreamWriter, newLine, stream

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.olingo.client.api.communication.request.ODataStreamer

getBodyStreamWriter

Constructor Detail

AbstractODataStreamManager

public AbstractODataStreamManager(Wrapper<Future<org.apache.http.HttpResponse>> futureWrap)

Constructor.

Parameters:

futureWrap - wrapper of the Future object of the HttpResponse.

AbstractODataStreamManager

public AbstractODataStreamManager(Wrapper<Future<org.apache.http.HttpResponse>> futureWrap,
                                  PipedOutputStream output)

Constructor.

Parameters:

futureWrap - wrapper of the Future object of the HttpResponse.

output - stream to be piped to retrieve the payload.

AbstractODataStreamManager

public AbstractODataStreamManager(Wrapper<Future<org.apache.http.HttpResponse>> futureWrap,
                                  InputStream input)

Constructor.

Parameters:

futureWrap - wrapper of the Future object of the HttpResponse.

input - stream to be used to retrieve the content.

Method Detail

getBody

public InputStream getBody()

Gets payload stream.

Specified by:

getBody in interface ODataPayloadManager<T extends ODataResponse>

Returns:

payload stream.

finalizeBody

public void finalizeBody()

Closes piped output stream.

Specified by:

finalizeBody in interface ODataPayloadManager<T extends ODataResponse>

getHttpResponse

protected org.apache.http.HttpResponse getHttpResponse(long timeout,
                                                       TimeUnit unit)

Gets HttpResponse.

Parameters:

timeout - maximum delay after which the request must be aborted.

unit - time unit.

Returns:

HttpResponse.

getResponse

public abstract T getResponse(long timeout,
                              TimeUnit unit)

Gets OData response.

Parameters:

timeout - maximum delay after which the request must be aborted.

unit - time unit.

Returns:

ODataResponse instance.

getResponse

public final T getResponse()

Closes the payload input stream and gets the OData response back.

Specified by:

getResponse in interface ODataPayloadManager<T extends ODataResponse>

Returns:

OData response.

getAsyncResponse

public final Future<T> getAsyncResponse()

Closes the payload input stream and ask for an asynchronous response.

Specified by:

getAsyncResponse in interface ODataPayloadManager<T extends ODataResponse>

Returns:

Future<ODataResponse> about the executed request.