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
static ODataFormat	DEFAULT_FORMAT Default ODataFormat that will be used if none is specified.

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.
int	hashCode()
void	setCsrfTokenRetriever(CsrfTokenRetriever csrfTokenRetriever)
void	setResponseFormat(ODataFormat responseFormat) Set the response format of this request.

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

DEFAULT_FORMAT

public static final ODataFormat DEFAULT_FORMAT

Default ODataFormat that will be used if none is specified.

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.

setResponseFormat

public void setResponseFormat(@Nullable
                              ODataFormat responseFormat)

Set the response format of this request.

Parameters:

responseFormat - The response format to use.

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.

Parameters:

key - The parameter key.

value - The parameter value.

getRequestQuery

@Nonnull
public String getRequestQuery()

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

Returns:

The request query.

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

getProtocol

public ODataProtocol getProtocol()

The OData protocol version of this request.

setCsrfTokenRetriever

public void setCsrfTokenRetriever(@Nullable
                                  CsrfTokenRetriever csrfTokenRetriever)

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.