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<org.apache.olingo.client.api.communication.response.ODataBatchResponse>

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

All Implemented Interfaces:

org.apache.olingo.client.api.communication.request.ODataPayloadManager<org.apache.olingo.client.api.communication.response.ODataBatchResponse>, org.apache.olingo.client.api.communication.request.ODataStreamer

Direct Known Subclasses:

ODataBatchRequestImpl.BatchManagerImpl

public abstract class AbstractBatchManager
extends AbstractODataStreamManager<org.apache.olingo.client.api.communication.response.ODataBatchResponse>

Batch request payload management.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	continueOnError
protected org.apache.olingo.client.api.communication.request.batch.ODataBatchRequestItem	currentItem Batch request current item.
protected org.apache.olingo.client.api.communication.request.batch.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(org.apache.olingo.client.api.communication.request.batch.ODataBatchRequest req, Wrapper<Future<org.apache.http.HttpResponse>> futureWrap, boolean continueOnError)

Method Summary

Modifier and Type	Method and Description
org.apache.olingo.client.api.communication.request.batch.ODataChangeset	addChangeset() Gets a changeset batch item instance.
void	addRequest(org.apache.olingo.client.api.communication.request.ODataBatchableRequest request) Adds a retrieve batch item instance.
protected void	closeCurrentItem() Close the current streamed item.
protected org.apache.olingo.client.api.communication.response.ODataBatchResponse	getResponse(long timeout, TimeUnit unit) Gets OData response.
protected abstract org.apache.olingo.client.api.communication.response.ODataBatchResponse	getResponseInstance(long timeout, TimeUnit unit)
protected void	streamCloseDelimiter() Streams close delimiter.
protected void	streamDashBoundary() Streams dash boundary.
protected abstract void	validateSingleRequest(org.apache.olingo.client.api.communication.request.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 org.apache.olingo.client.api.communication.request.batch.ODataBatchRequestItem currentItem

Batch request current item.

req

protected final org.apache.olingo.client.api.communication.request.batch.ODataBatchRequest req

batch request reference.

Constructor Detail

AbstractBatchManager

protected AbstractBatchManager(org.apache.olingo.client.api.communication.request.batch.ODataBatchRequest req,
                               Wrapper<Future<org.apache.http.HttpResponse>> futureWrap,
                               boolean continueOnError)

Method Detail

addChangeset

public org.apache.olingo.client.api.communication.request.batch.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(org.apache.olingo.client.api.communication.request.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

protected org.apache.olingo.client.api.communication.response.ODataBatchResponse getResponse(long timeout,
                                                                                             TimeUnit unit)

Description copied from class: AbstractODataStreamManager

Gets OData response.

Specified by:

getResponse in class AbstractODataStreamManager<org.apache.olingo.client.api.communication.response.ODataBatchResponse>

Parameters:

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

unit - time unit.

Returns:

ODataResponse instance.

getResponseInstance

protected abstract org.apache.olingo.client.api.communication.response.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(org.apache.olingo.client.api.communication.request.ODataBatchableRequest request)