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

Class AbstractBatchManager

java.lang.Object

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

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

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

All Implemented Interfaces:

ODataPayloadManager<ODataBatchResponse>, ODataStreamer

Direct Known Subclasses:

ODataBatchRequestImpl.BatchManagerImpl

public abstract class AbstractBatchManager
extends AbstractODataStreamManager<ODataBatchResponse>

Batch request payload management.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	continueOnError
protected ODataBatchRequestItem	currentItem Batch request current item.
protected ODataBatchRequest	req batch request reference.

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

Modifier	Constructor and Description
protected	AbstractBatchManager(ODataBatchRequest req, Wrapper<Future<org.apache.http.HttpResponse>> futureWrap, boolean continueOnError)

Method Summary

Modifier and Type	Method and Description
ODataChangeset	addChangeset() Gets a changeset batch item instance.
void	addRequest(ODataBatchableRequest request) Adds a retrieve batch item instance.
protected void	closeCurrentItem() Close the current streamed item.
ODataBatchResponse	getResponse(long timeout, TimeUnit unit) Gets OData response.
protected abstract ODataBatchResponse	getResponseInstance(long timeout, TimeUnit unit)
protected void	streamCloseDelimiter() Streams close delimiter.
protected void	streamDashBoundary() Streams dash boundary.
protected abstract void	validateSingleRequest(ODataBatchableRequest request)

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

finalizeBody, getAsyncResponse, getBody, getHttpResponse, getResponse

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

Field Detail

continueOnError

protected final boolean continueOnError

currentItem

protected ODataBatchRequestItem currentItem

Batch request current item.

req

protected final ODataBatchRequest req

batch request reference.

Constructor Detail

AbstractBatchManager

protected AbstractBatchManager(ODataBatchRequest req,
                               Wrapper<Future<org.apache.http.HttpResponse>> futureWrap,
                               boolean continueOnError)

Method Detail

addChangeset

public ODataChangeset addChangeset()

Gets a changeset batch item instance. A changeset can be submitted embedded into a batch request only.

Returns:

ODataChangeset instance.

addRequest

public void addRequest(ODataBatchableRequest request)

Adds a retrieve batch item instance. A retrieve item can be submitted embedded into a batch request only.

Parameters:

request - retrieve request to batch.

closeCurrentItem

protected void closeCurrentItem()

Close the current streamed item.

getResponse

public ODataBatchResponse getResponse(long timeout,
                                      TimeUnit unit)

Description copied from class: AbstractODataStreamManager

Gets OData response.

Specified by:

getResponse in class AbstractODataStreamManager<ODataBatchResponse>

Parameters:

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

unit - time unit.

Returns:

ODataResponse instance.

getResponseInstance

protected abstract ODataBatchResponse getResponseInstance(long timeout,
                                                          TimeUnit unit)

streamDashBoundary

protected void streamDashBoundary()

Streams dash boundary.

streamCloseDelimiter

protected void streamCloseDelimiter()

Streams close delimiter.

validateSingleRequest

protected abstract void validateSingleRequest(ODataBatchableRequest request)