com.sap.cloud.sdk.s4hana.connectivity

Class Request<RequestT extends Request<RequestT,RequestResultT>,RequestResultT extends RequestResult<RequestT,RequestResultT>>

java.lang.Object

com.sap.cloud.sdk.s4hana.connectivity.Request<RequestT,RequestResultT>

Direct Known Subclasses:

AbstractRemoteFunctionRequest

public abstract class Request<RequestT extends Request<RequestT,RequestResultT>,RequestResultT extends RequestResult<RequestT,RequestResultT>>
extends Object

Common interface for ERP queries.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Request()

Method Summary

Modifier and Type	Method and Description
abstract RequestResultT	execute(Destination destination) Executes a given request using the given Destination.
abstract String	getConstructedByMethod()
List<Header>	getCustomHttpHeaders() Set of HTTP headers to send to the underlying request executor.
Duration	getLongRunningRequestThreshold() Custom execution duration threshold indicating that the request is long running.
String	getReadAccessData()
long	getRequestId() Represents an identifier that allows to correlate queries between the Cloud cloudplatform and the ERP.
protected RequestT	getThis()
void	setLongRunningRequestThreshold(Duration longRunningRequestThreshold) Custom execution duration threshold indicating that the request is long running.
RequestT	withHeader(Header header) Fluent method which adds a custom header to this request.
RequestT	withHeader(String name, String value) Fluent method which adds a custom HTTP header to this request.
RequestT	withSameCustomHttpHeadersAs(Request<?,?> otherRequest) Fluent method which adds the custom headers from another request into this request.

Methods inherited from class java.lang.Object

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

Constructor Detail

Request

protected Request()

Method Detail

getConstructedByMethod

@Nonnull
public abstract String getConstructedByMethod()

Returns:

The method name that originally constructed this ERP request. This information is used for debugging.

getReadAccessData

@Nullable
public String getReadAccessData()

Returns:

A optional String representation of the data being access by this request. If present, an audit log entry is written using the given data.

getThis

@Nonnull
protected RequestT getThis()

withHeader

@Nonnull
public RequestT withHeader(@Nonnull
                                    String name,
                                    @Nullable
                                    String value)

Fluent method which adds a custom HTTP header to this request. Note that these headers will only be added to HTTP-based queries. If the header with the provided name already exists, the value is overwritten.

Parameters:

name - Header parameter name.

value - Header parameter value.

Returns:

The same Request instance, so that this method can be used again in a fluent API style.

withHeader

@Nonnull
public RequestT withHeader(@Nonnull
                                    Header header)

Fluent method which adds a custom header to this request. Note that these headers will only be added to HTTP-based queries. If the header with the provided name already exists, the value is overwritten.

Parameters:

header - The custom header.

Returns:

The same Request instance, so that this method can be used again in a fluent API style.

withSameCustomHttpHeadersAs

@Nonnull
public RequestT withSameCustomHttpHeadersAs(@Nonnull
                                                     Request<?,?> otherRequest)

Fluent method which adds the custom headers from another request into this request. Note that these headers will only be added to HTTP-based queries. If any headers in the other request already exist in this request, the values will be overwritten.

Parameters:

otherRequest - Other request to get header parameters from.

Returns:

The same Request instance, so that this method can be used again in a fluent API style.

execute

@Nonnull
public abstract RequestResultT execute(@Nonnull
                                                Destination destination)
                                         throws RequestSerializationException,
                                                RequestExecutionException,
                                                DestinationNotFoundException,
                                                DestinationAccessException

Executes a given request using the given Destination.

Parameters:

destination - The Destination to be used for request execution.

Throws:

RequestSerializationException - If there is an issue while serializing the request.

RequestExecutionException - If there is an issue while executing the request.

DestinationNotFoundException - If no destination with the name specified in the Destination can be found.

DestinationAccessException - If there is an issue while accessing destination information.

getRequestId

public long getRequestId()

Represents an identifier that allows to correlate queries between the Cloud cloudplatform and the ERP.

Important: The identifier does not provide any guarantees with respect to persistence across the application lifecycle. In particular, the identifier will be reset to 1 when restarting the application.

getLongRunningRequestThreshold

@Nullable
public Duration getLongRunningRequestThreshold()

Custom execution duration threshold indicating that the request is long running.

setLongRunningRequestThreshold

public void setLongRunningRequestThreshold(@Nullable
                                           Duration longRunningRequestThreshold)

Custom execution duration threshold indicating that the request is long running.

getCustomHttpHeaders

@Nonnull
public List<Header> getCustomHttpHeaders()

Set of HTTP headers to send to the underlying request executor. Note that these headers will only be added to HTTP-based queries.