com.sap.cloud.sdk.datamodel.odatav4.core

Class BatchRequestBuilder

java.lang.Object

com.sap.cloud.sdk.datamodel.odatav4.core.BatchRequestBuilder

All Implemented Interfaces:

RequestBuilder<BatchResponse>, RequestBuilderExecutable<BatchResponse>

@Beta
public class BatchRequestBuilder
extends Object

Representation of an OData Batch request as a fluent interface for combining multiple data reading and modifying operations in one HTTP request.

Constructor Summary

Constructors

Constructor and Description
BatchRequestBuilder(String servicePath) Instantiates this request builder using the given service path to send the requests.

Method Summary

Modifier and Type	Method and Description
BatchRequestBuilder	addChangeset(ModificationRequestBuilder<?>... operations) Add modifying operations to the OData batch request as combined changeset.
BatchRequestBuilder	addReadOperations(ReadRequestBuilder<?>... operations) Add read operations to the OData batch request.
BatchResponse	execute(HttpDestinationProperties destination) Execute the OData request.
protected Map<String,String>	getHeaders() A map containing the headers to be used only for the actual request of this FluentHelper implementation.
protected List<ODataRequestListener>	getListeners()
protected Map<String,String>	getParametersForRequestOnly() A map containing the custom query parameters to be used only for the actual request of this FluentHelper implementation.
protected ODataResourcePath	getResourcePath()
protected String	getServicePath()
protected BuilderT	getThis() Get the reference to this instance.
protected Supplier<UUID>	getUuidProvider()
ODataRequestBatch	toRequest() Assemble a generic, untyped request object that represents the request build up via this builder.
BuilderT	withHeader(String key, String value) Gives the option to specify custom HTTP headers.
BuilderT	withHeaders(Map<String,String> map) Gives the option to specify a map of custom HTTP headers.
BuilderT	withListener(ODataRequestListener listener) An error handling class that implements the error result handler interface can be attached to this request builder.
BuilderT	withQueryParameter(String key, String value) Gives the option to specify custom query parameters for the request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.RequestBuilderExecutable

tryExecute

Constructor Detail

BatchRequestBuilder

public BatchRequestBuilder(@Nonnull
                           String servicePath)

Instantiates this request builder using the given service path to send the requests.

Parameters:

servicePath - The service path to direct the requests to.

Method Detail

addReadOperations

@Nonnull
public BatchRequestBuilder addReadOperations(@Nonnull
                                                      ReadRequestBuilder<?>... operations)

Add read operations to the OData batch request.

Parameters:

operations - A var-arg array of read operations.

Returns:

The current reference of batch request builder.

See Also:

GetAllRequestBuilder, GetByKeyRequestBuilder, FunctionRequestBuilder

addChangeset

@Nonnull
public BatchRequestBuilder addChangeset(@Nonnull
                                                 ModificationRequestBuilder<?>... operations)

Add modifying operations to the OData batch request as combined changeset.

Parameters:

operations - A var-arg array of modifying operations.

Returns:

The current reference of batch request builder.

See Also:

CreateRequestBuilder, DeleteRequestBuilder, UpdateRequestBuilder, ActionRequestBuilder

toRequest

@Beta
 @Nonnull
public ODataRequestBatch toRequest()

Description copied from interface: RequestBuilder

Assemble a generic, untyped request object that represents the request build up via this builder.

Returns:

A request object extending ODataRequestGeneric.

execute

@Nonnull
public BatchResponse execute(@Nonnull
                                      HttpDestinationProperties destination)

Description copied from interface: RequestBuilderExecutable

Execute the OData request.

Parameters:

destination - The destination to be used as request target.

Returns:

The generic OData response result.

getUuidProvider

protected Supplier<UUID> getUuidProvider()

getThis

@Nonnull
protected BuilderT getThis()

Get the reference to this instance.

Returns:

The FluentHelper instance.

withListener

@Nonnull
 @Beta
public BuilderT withListener(@Nonnull
                                             ODataRequestListener listener)

An error handling class that implements the error result handler interface can be attached to this request builder. This allows custom logic to be called when an error occurs in the execute method. If this method is not called, then an instance of ODataRequestListener is used. Only one handler can be attached at a time per request builder object, so calling this multiple times will replace the handler.

Parameters:

listener - Instance of an error handler class that implements the error result handler interface.

Returns:

The same request builder with its error handler set to the provided object.

withHeader

@Nonnull
public BuilderT withHeader(@Nonnull
                                    String key,
                                    @Nullable
                                    String value)

Description copied from interface: RequestBuilder

Gives the option to specify custom HTTP headers. The returned object allows to specify the requests the headers should be used in.

Specified by:

withHeader in interface RequestBuilder<ResultT>

Parameters:

key - Name of the (first) desired HTTP header parameter.

value - Value of the (first) desired HTTP header parameter.

Returns:

A request builder to specify further headers and their intended usage.

withHeaders

@Nonnull
public BuilderT withHeaders(@Nonnull
                                     Map<String,String> map)

Description copied from interface: RequestBuilder

Gives the option to specify a map of custom HTTP headers. The returned object allows to specify the requests the headers should be used in.

Specified by:

withHeaders in interface RequestBuilder<ResultT>

Parameters:

map - A map of HTTP header key/value pairs.

Returns:

A request builder to specify further headers and their intended usage.

withQueryParameter

@Nonnull
 @Beta
public BuilderT withQueryParameter(@Nonnull
                                                   String key,
                                                   @Nullable
                                                   String value)

Gives the option to specify custom query parameters for the request.

Note: It is recommended to only use this function for query parameters which are not supported by the VDM by default. Using this function to bypass request builder method calls can lead to unsupported response handling. There is no contract on the order or priority of parameters added to the request.

Example: Use the request query option $search to reduce the result set, leaving only entities which match the specified search expression. This feature is supported in protocol OData v4.

 new DefaultBusinessPartnerService().getAllBusinessPartner().withQueryParameter("$search", "Köln OR Cologne")
 

Parameters:

key - Name of the query parameter.

value - Value of the query parameter.

Returns:

The same request builder.

getServicePath

@Nonnull
protected String getServicePath()

getResourcePath

@Nonnull
protected ODataResourcePath getResourcePath()

getHeaders

@Nonnull
protected Map<String,String> getHeaders()

A map containing the headers to be used only for the actual request of this FluentHelper implementation.

getParametersForRequestOnly

@Nonnull
protected Map<String,String> getParametersForRequestOnly()

A map containing the custom query parameters to be used only for the actual request of this FluentHelper implementation.

getListeners

@Nonnull
protected List<ODataRequestListener> getListeners()