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

Class UpdateRequestBuilder<EntityT extends VdmEntity<?>>

java.lang.Object
com.sap.cloud.sdk.datamodel.odatav4.core.UpdateRequestBuilder<EntityT>
Type Parameters:
EntityT - The type of the result entity.
All Implemented Interfaces:
ModificationRequestBuilder<ModificationResponse<EntityT>>, RequestBuilder<ModificationResponse<EntityT>>, RequestBuilderExecutable<ModificationResponse<EntityT>>
public class UpdateRequestBuilder<EntityT extends VdmEntity<?>> extends Object implements ModificationRequestBuilder<ModificationResponse<EntityT>>
Representation of an OData request as a fluent interface for further configuring the request and executing it.

  • Field Details

    • csrfTokenRetriever

      @Nonnull protected CsrfTokenRetriever csrfTokenRetriever
      A token retriever.

  • Constructor Details

    • UpdateRequestBuilder

      public UpdateRequestBuilder(@Nonnull String servicePath, @Nonnull EntityT entity, @Nonnull String entityCollection)
      Instantiate an UpdateRequestBuilder.
      Parameters:
      servicePath - The service path.
      entity - The entity to update.
      entityCollection - The entity collection

  • Method Details

    • getEntityClass

      @Nonnull protected Class<EntityT> getEntityClass()
      Returns a class object of the type this request builder works with.
      Returns:
      A class object of the handled type.

    • execute

      @Nonnull public ModificationResponse<EntityT> execute(@Nonnull Destination destination)
      Execute the OData update request for the provided entity. Execute the OData request.
      Specified by:
      execute in interface RequestBuilderExecutable<EntityT extends VdmEntity<?>>
      Parameters:
      destination - The destination to be used as request target.
      Returns:
      The wrapped service response, exposing response headers, status code and entity references. If the HTTP response is not within healthy bounds, then one of the declared runtime exceptions will be thrown with further details.

    • toRequest

      @Nonnull public ODataRequestUpdate toRequest()
      Creates an instance of the ODataRequestUpdate based on the Entity class.

      The following settings are used to build the Request Builder:

      • the endpoint URL
      • the entity collection name
      • the key fields of the entity
      • the entity JSON payload
      • the update strategy (full update or delta)
      Specified by:
      toRequest in interface RequestBuilder<EntityT extends VdmEntity<?>>
      Returns:
      An initialized ODataRequestUpdate.
      Throws:
      ODataSerializationException - If entity cannot be serialized for HTTP request.

    • includingFields

      @Nonnull public final UpdateRequestBuilder<EntityT> includingFields(@Nonnull FieldReference... fields)
      Allows to explicitly specify entity fields that shall be sent in an update request regardless if the values of these fields have been changed. This is helpful in case the API requires to send certain fields in any case in an update request.
      Parameters:
      fields - The fields to be included in the update execution.
      Returns:
      The same request builder which will include the specified fields in an update request.

    • excludingFields

      @Nonnull public final UpdateRequestBuilder<EntityT> excludingFields(@Nonnull FieldReference... fields)
      Allows to explicitly specify entity fields that should not be sent in an update request. This is helpful in case some services require no read only fields to be sent for update requests. These fields are only excluded in a PUT request, they are not considered in a PATCH request.
      Parameters:
      fields - The fields to be excluded in the update execution.
      Returns:
      The same request builder which will exclude the specified fields in an update request.

    • replacingEntity

      @Nonnull public final UpdateRequestBuilder<EntityT> replacingEntity()
      Allows to control that the request to update the entity is sent with the HTTP method PUT and its payload contains all fields of the entity, regardless which of them have been changed.
      Returns:
      The same request builder which will replace the entity in the remote system

    • modifyingEntity

      @Nonnull public final UpdateRequestBuilder<EntityT> modifyingEntity()
      Allows to control that the request to update the entity is sent with the HTTP method PATCH and its payload contains the changed fields only.
      Returns:
      The same request builder which will modify the entity in the remote system.

    • disableVersionIdentifier

      @Nonnull public UpdateRequestBuilder<EntityT> disableVersionIdentifier()
      The update request will ignore any version identifier present on the entity and not send an `If-Match` header.

      Warning: This might lead to a response from the remote system that the `If-Match` header is missing.

      It depends on the implementation of the remote system whether the `If-Match` header is expected.

      Returns:
      The same request builder that will not send the `If-Match` header in the update request

    • matchAnyVersionIdentifier

      @Nonnull public UpdateRequestBuilder<EntityT> matchAnyVersionIdentifier()
      The update request will ignore any version identifier present on the entity and update the entity, regardless of any changes on the remote entity.

      Warning: Be careful with this option, as this might overwrite any changes made to the remote representation of this object.

      Returns:
      The same request builder that will ignore the version identifier of the entity to update

    • withoutCsrfToken

      @Nonnull public UpdateRequestBuilder<EntityT> withoutCsrfToken()
      Description copied from interface: ModificationRequestBuilder
      Deactivates the CSRF token retrieval for this OData request. This is useful if the server does not support or require CSRF tokens as part of the request.
      Specified by:
      withoutCsrfToken in interface ModificationRequestBuilder<EntityT extends VdmEntity<?>>
      Returns:
      The same builder

    • getEntity

      @Nonnull protected EntityT getEntity()
      The entity object to be updated by calling the execute(Destination) method.

    • getThis

      @Nonnull protected UpdateRequestBuilder<EntityT> getThis()
      Get the reference to this instance.
      Returns:
      The FluentHelper instance.

    • withListener

      @Nonnull public UpdateRequestBuilder<EntityT> 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 UpdateRequestBuilder<EntityT> withHeader(@Nonnull String key, @Nullable String value)
      Description copied from interface: RequestBuilder
      Gives the option to specify custom HTTP headers. Multiple headers with the same key can be specified. The returned object allows to specify the requests the headers should be used in.
      Specified by:
      withHeader in interface RequestBuilder<BuilderT extends 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 UpdateRequestBuilder<EntityT> 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<BuilderT extends 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 public UpdateRequestBuilder<EntityT> 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,Collection<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()