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

Class ODataRequestGeneric

java.lang.Object

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

All Implemented Interfaces:

ODataRequestExecutable

Direct Known Subclasses:

ODataRequestAction, ODataRequestBatch, ODataRequestCreate, ODataRequestDelete, ODataRequestFunction, ODataRequestRead, ODataRequestReadByKey, ODataRequestUpdate

@Beta
public abstract class ODataRequestGeneric
extends Object
implements ODataRequestExecutable

Generic OData request class to provide default features for service requests.

Field Summary

Fields

Modifier and Type	Field and Description
protected ODataResourcePath	resourcePath The ODataResourcePath that identifies the OData resource to operate on.
protected String	servicePath The service path of the targeted OData service.

Method Summary

Modifier and Type	Method and Description
void	addHeader(String key, String value) Add a header to the OData HTTP request.
void	addHeaderIfAbsent(String key, String value) Add a header to the OData HTTP request, if it is not included already.
void	addListener(ODataRequestListener listener) Attach a listener to the request process.
void	addQueryParameter(String key, String value) Add a query parameter to the HTTP request.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
protected Map<String,String>	getHeaders() Map of HTTP header key-values which are added to the OData request.
protected List<ODataRequestListener>	getListeners() List of listeners to observe and react on OData actions.
ODataProtocol	getProtocol() The OData protocol version of this request.
protected Map<String,String>	getQueryParameters() Map of additional generic HTTP query parameters.
abstract URI	getRelativeUri() Get the static request URI of the OData resource.
String	getRequestQuery() Use all OData query information to construct a HTTP request query String.
protected ODataResourcePath	getResourcePath() The ODataResourcePath that identifies the OData resource to operate on.
String	getServicePath() The service path of the targeted OData service.
int	hashCode()
void	setCsrfTokenRetriever(CsrfTokenRetriever csrfTokenRetriever)
protected io.vavr.control.Try<ODataRequestResultGeneric>	tryExecute(Supplier<org.apache.http.HttpResponse> httpOperation, org.apache.http.client.HttpClient httpClient) Internal execute method.
protected io.vavr.control.Try<ODataRequestResultGeneric>	tryExecuteWithCsrfToken(org.apache.http.client.HttpClient httpClient, Supplier<org.apache.http.HttpResponse> httpOperation) Internal execute method.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestExecutable

execute

Field Detail

servicePath

@Nonnull
protected final String servicePath

The service path of the targeted OData service. E.g. sap/opu/odata/sap/API_BUSINESS_PARTNER

resourcePath

@Nonnull
protected final ODataResourcePath resourcePath

The ODataResourcePath that identifies the OData resource to operate on. E.g. /BusinessPartner('123')/BusinessPartnerAddress(456).

Method Detail

getRelativeUri

@Nonnull
public abstract URI getRelativeUri()

Get the static request URI of the OData resource.

Returns:

The String representation of the request URI.

getRequestQuery

@Nonnull
public String getRequestQuery()

Use all OData query information to construct a HTTP request query String.

Returns:

The request query.

addListener

public void addListener(@Nonnull
                        ODataRequestListener listener)

Attach a listener to the request process.

Parameters:

listener - The listener to react on OData request actions.

addHeader

public void addHeader(@Nonnull
                      String key,
                      @Nullable
                      String value)

Add a header to the OData HTTP request.

Parameters:

key - The header name.

value - The header value.

addHeaderIfAbsent

public void addHeaderIfAbsent(@Nonnull
                              String key,
                              @Nullable
                              String value)

Add a header to the OData HTTP request, if it is not included already.

Parameters:

key - The header name.

value - The header value.

addQueryParameter

public void addQueryParameter(@Nonnull
                              String key,
                              @Nullable
                              String value)

Add a query parameter to the HTTP request. The value must be encoded.

Parameters:

key - The parameter key.

value - The encoded parameters value.

tryExecute

@Nonnull
protected io.vavr.control.Try<ODataRequestResultGeneric> tryExecute(@Nonnull
                                                                             Supplier<org.apache.http.HttpResponse> httpOperation,
                                                                             @Nonnull
                                                                             org.apache.http.client.HttpClient httpClient)

Internal execute method. It will perform the given httpOperation on the given request and ensure a healthy HTTP response code. Failures will always be a subtype of ODataException

Parameters:

httpOperation - The HTTP operation to perform, e.g. ODataHttpRequest.requestGet()

httpClient - The HTTP client instance that is being used to perform the operation.

Returns:

A Try containing either a successful ODataRequestResultGeneric or an ODataException.

tryExecuteWithCsrfToken

@Nonnull
protected io.vavr.control.Try<ODataRequestResultGeneric> tryExecuteWithCsrfToken(@Nonnull
                                                                                          org.apache.http.client.HttpClient httpClient,
                                                                                          @Nonnull
                                                                                          Supplier<org.apache.http.HttpResponse> httpOperation)

Internal execute method. It will attempt to retrieve a CSRF token before issuing the actual request via tryExecute(Supplier, HttpClient). CSRF token retrieval is skipped, if a token is already present. The actual request is performed regardless whether or not a CSRF token was retrieved.

Parameters:

httpClient - An HttpClient to execute the CSRF token retrieval.

httpOperation - The HTTP operation to perform, e.g. ODataHttpRequest.requestGet()

Returns:

A Try containing either a successful ODataRequestResultGeneric or an ODataException.

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(@Nullable
                           Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getServicePath

@Nonnull
public String getServicePath()

The service path of the targeted OData service. E.g. sap/opu/odata/sap/API_BUSINESS_PARTNER

getResourcePath

@Nonnull
protected ODataResourcePath getResourcePath()

The ODataResourcePath that identifies the OData resource to operate on. E.g. /BusinessPartner('123')/BusinessPartnerAddress(456).

getProtocol

public ODataProtocol getProtocol()

The OData protocol version of this request.

getListeners

protected List<ODataRequestListener> getListeners()

List of listeners to observe and react on OData actions.

getHeaders

protected Map<String,String> getHeaders()

Map of HTTP header key-values which are added to the OData request.

getQueryParameters

protected Map<String,String> getQueryParameters()

Map of additional generic HTTP query parameters.

setCsrfTokenRetriever

public void setCsrfTokenRetriever(@Nullable
                                  CsrfTokenRetriever csrfTokenRetriever)