Package com.sap.cloud.sdk.datamodel.odata.client.request

Class ODataRequestBatch

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestGeneric

com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestBatch

All Implemented Interfaces:

ODataRequestExecutable

public class ODataRequestBatch
extends ODataRequestGeneric

The OData Batch request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ODataRequestBatch.Changeset	The Changeset representation of the OData Batch operation.

Field Summary

Fields inherited from class com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestGeneric

csrfTokenRetriever, resourcePath, servicePath

Constructor Summary

Constructors

Constructor	Description
ODataRequestBatch(String servicePath, ODataProtocol protocol)	Default constructor for OData Batch request.
ODataRequestBatch(String servicePath, ODataProtocol protocol, Supplier<UUID> uuidProvider)	Default constructor for OData Batch request.

Method Summary

Modifier and Type	Method	Description
ODataRequestBatch	addFunction(ODataRequestFunction request)	Add an OData Function request to the current OData Batch request.
ODataRequestBatch	addRead(ODataRequestRead request)	Add an OData Read request to the current OData Batch request.
ODataRequestBatch	addReadByKey(ODataRequestReadByKey request)	Add an OData Read-By-Key request to the current OData Batch request.
ODataRequestBatch.Changeset	beginChangeset()	Instantiate a new changeset to the current OData Batch request.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
ODataRequestResultMultipartGeneric	execute(org.apache.http.client.HttpClient httpClient)	Execute the OData request with the provided HttpClient reference.
UUID	getBatchUuid()
AtomicInteger	getContentId()
Map<String,Collection<String>>	getHeaders()	Get the list of headers that will be sent with this request.
URI	getRelativeUri(UriEncodingStrategy strategy)	Get the static request URI of the OData resource.
List<com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestBatch.BatchItem>	getRequests()
Supplier<UUID>	getUuidProvider()
int	hashCode()

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestGeneric

addHeader, addHeaderIfAbsent, addListener, addQueryParameter, getListeners, getProtocol, getQueryParameters, getRelativeUri, getRequestQuery, getResourcePath, getServicePath, setCsrfTokenRetriever, setHeader, setHeader, tryExecute, tryExecuteWithCsrfToken

Methods inherited from class java.lang.Object

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

Constructor Details

ODataRequestBatch

public ODataRequestBatch(@Nonnull
 String servicePath,
 @Nonnull
 ODataProtocol protocol)

Default constructor for OData Batch request. The service path will be URL-encoded during request serialization.

Parameters:

servicePath - The unencoded OData service path

protocol - The OData protocol

ODataRequestBatch

public ODataRequestBatch(@Nonnull
 String servicePath,
 @Nonnull
 ODataProtocol protocol,
 @Nonnull
 Supplier<UUID> uuidProvider)

Default constructor for OData Batch request. The service path will be URL-encoded during request serialization.

Parameters:

servicePath - The unencoded OData service path

protocol - The OData protocol

uuidProvider - A generic UUID provider, customizable for testing

Method Details

getRelativeUri

@Nonnull
public URI getRelativeUri(@Nonnull
 UriEncodingStrategy strategy)

Description copied from class: ODataRequestGeneric

Get the static request URI of the OData resource.

Specified by:

getRelativeUri in class ODataRequestGeneric

Parameters:

strategy - URI encoding strategy.

Returns:

The String representation of the request URI.

addRead

@Nonnull
public ODataRequestBatch addRead(@Nonnull
 ODataRequestRead request)

Add an OData Read request to the current OData Batch request.

Parameters:

request - The Read request.

Returns:

The Batch request fluent helper instance.

addReadByKey

@Nonnull
public ODataRequestBatch addReadByKey(@Nonnull
 ODataRequestReadByKey request)

Add an OData Read-By-Key request to the current OData Batch request.

Parameters:

request - The Read-By-Key request.

Returns:

The Batch request fluent helper instance.

addFunction

@Nonnull
public ODataRequestBatch addFunction(@Nonnull
 ODataRequestFunction request)

Add an OData Function request to the current OData Batch request.

Parameters:

request - The Function request.

Returns:

The Batch request fluent helper instance.

beginChangeset

@Nonnull
public ODataRequestBatch.Changeset beginChangeset()

Instantiate a new changeset to the current OData Batch request. As per specification if any data modifying operation fails within one changeset, then the incomplete changes will be reverted.

Returns:

A new Changeset fluent helper instance.

execute

@Nonnull
public ODataRequestResultMultipartGeneric execute(@Nonnull
 org.apache.http.client.HttpClient httpClient)

Description copied from interface: ODataRequestExecutable

Execute the OData request with the provided HttpClient reference.

Parameters:

httpClient - The HttpClient.

Returns:

An OData request result.

getHeaders

@Nonnull
public Map<String,Collection<String>> getHeaders()

Description copied from class: ODataRequestGeneric

Get the list of headers that will be sent with this request. To add headers, please use addHeader and addHeaderIfAbsent

Overrides:

getHeaders in class ODataRequestGeneric

Returns:

The list of headers.

getRequests

@Nonnull
public List<com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestBatch.BatchItem> getRequests()

getContentId

public AtomicInteger getContentId()

getBatchUuid

public UUID getBatchUuid()

getUuidProvider

public Supplier<UUID> getUuidProvider()

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class ODataRequestGeneric

canEqual

protected boolean canEqual(@Nullable
 Object other)

Overrides:

canEqual in class ODataRequestGeneric

hashCode

public int hashCode()

Overrides:

hashCode in class ODataRequestGeneric