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

Class GetByKeyRequestBuilder<EntityT extends VdmEntity<?>>

java.lang.Object

com.sap.cloud.sdk.datamodel.odatav4.core.GetByKeyRequestBuilder<EntityT>

Type Parameters:

EntityT - The type of the result entity.

public class GetByKeyRequestBuilder<EntityT extends VdmEntity<?>>
extends Object

Representation of an OData request to retrieve an entity by its key as a fluent interface for further configuring the request and executing it.

Constructor Summary

Constructors

Constructor and Description
GetByKeyRequestBuilder(String servicePath, Class<EntityT> entityClass, Map<String,Object> key) Instantiates this fluent helper using the given service path to send the requests.

Method Summary

Modifier and Type	Method and Description
protected <PrimitiveT> void	addKeyProperty(String propertyName, PrimitiveT value) Adds a property to the OData key representation (composite key).
EntityT	execute(HttpDestinationProperties destination) Execute the OData request.
protected com.sap.cloud.sdk.datamodel.odatav4.core.CsrfTokenRetriever	getCsrfTokenRetriever()
protected Class<EntityT>	getEntityClass() Returns a class object of the type this fluent helper works with.
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.
String	getQueryString() Return the string representation of the underlying query that is being build by this fluent helper.
protected String	getServicePath()
protected FluentHelperT	getThis() Get the reference to this instance.
GetByKeyRequestBuilder<EntityT>	select(Property<EntityT>... fields) Query modifier to limit which field values of the entity EntityT get fetched and populated.
ODataRequestReadByKey	toRequest() Creates an instance of ODataRequestReadByKey based on the Entity class.
io.vavr.control.Try<ResultT>	tryExecute(HttpDestinationProperties destination) Safely execute the OData request.
FluentHelperT	withHeader(String key, String value) Gives the option to specify custom HTTP headers.
FluentHelperT	withHeaders(Map<String,String> map) Gives the option to specify a map of custom HTTP headers.
FluentHelperT	withListener(ODataRequestListener listener) An error handling class that implements the error result handler interface can be attached to this fluent helper.
FluentHelperT	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

Constructor Detail

GetByKeyRequestBuilder

public GetByKeyRequestBuilder(@Nonnull
                              String servicePath,
                              @Nonnull
                              Class<EntityT> entityClass,
                              @Nonnull
                              Map<String,Object> key)

Instantiates this fluent helper using the given service path to send the requests.

Parameters:

servicePath - The service path to direct the requests to.

entityClass - The expected entity type.

key - The composite entity key.

Throws:

IllegalArgumentException - When there is no mapping found for one of the provided Java literal in the composite key.

Method Detail

addKeyProperty

protected <PrimitiveT> void addKeyProperty(@Nonnull
                                           String propertyName,
                                           @Nonnull
                                           PrimitiveT value)

Adds a property to the OData key representation (composite key). It is expected that generated VDM classes implement this.

Type Parameters:

PrimitiveT - The Java type of the value.

Parameters:

propertyName - EDMX name of the key property.

value - Current value of the property, taken from an entity instance.

Throws:

IllegalArgumentException - When there is no mapping found for the provided Java literal.

toRequest

@Nonnull
 @Beta
public ODataRequestReadByKey toRequest()

Creates an instance of ODataRequestReadByKey based on the Entity class.

The following settings are used:

• the endpoint URL
• the entity collection name
• the key fields of the entity
• the fields to be selected

Returns:

An initialized ODataRequestReadByKey.

getQueryString

@Nonnull
 @Beta
public String getQueryString()

Return the string representation of the underlying query that is being build by this fluent helper. This includes all query parameters as well as nested queries but not the entity, the service path or other request options like format.

Returns:

The underlying request as query string.

execute

@Nonnull
 @Beta
public EntityT execute(@Nonnull
                                       HttpDestinationProperties destination)

Execute the OData request.

Parameters:

destination - The destination to be used as request target.

Returns:

The generic OData response result.

select

@SafeVarargs
 @Nonnull
public final GetByKeyRequestBuilder<EntityT> select(@Nonnull
                                                                           Property<EntityT>... fields)

Query modifier to limit which field values of the entity EntityT get fetched and populated. Navigational properties supplied here will be expanded. If this method is called at least once, then only the specified fields will be fetched and populated. If none of the select methods is called, then all fields will be fetched and populated. Calling this multiple times will combine the set(s) of fields of each call.

Parameters:

fields - Properties of EntityT to be selected.

Returns:

This request object with the added selections.

getEntityClass

protected Class<EntityT> getEntityClass()

Returns a class object of the type this fluent helper works with.

Returns:

A class object of the handled type.

getThis

@Nonnull
protected FluentHelperT getThis()

Get the reference to this instance.

Returns:

The FluentHelper instance.

tryExecute

@Nonnull
public io.vavr.control.Try<ResultT> tryExecute(@Nonnull
                                                        HttpDestinationProperties destination)

Safely execute the OData request.

Parameters:

destination - The destination to be used as request target.

Returns:

The generic OData response result wrapped in a Try block.

withListener

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

An error handling class that implements the error result handler interface can be attached to this fluent helper. 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 fluent helper 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 fluent helper with its error handler set to the provided object.

withHeader

@Nonnull
 @Beta
public FluentHelperT withHeader(@Nonnull
                                                String key,
                                                @Nullable
                                                String value)

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

Parameters:

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

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

Returns:

A fluent helper to specify further headers and their intended usage.

withHeaders

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

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.

Parameters:

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

Returns:

A fluent helper to specify further headers and their intended usage.

withQueryParameter

@Nonnull
 @Beta
public FluentHelperT 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 fluent helper 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 fluent helper.

getCsrfTokenRetriever

@Nonnull
protected com.sap.cloud.sdk.datamodel.odatav4.core.CsrfTokenRetriever getCsrfTokenRetriever()

getServicePath

@Nonnull
protected String getServicePath()

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()