com.sap.cloud.sdk.s4hana.connectivity

Class Query<QueryT extends Query<QueryT,QueryResultT>,QueryResultT extends QueryResult<QueryT,QueryResultT>>

java.lang.Object

com.sap.cloud.sdk.s4hana.connectivity.Query<QueryT,QueryResultT>

Direct Known Subclasses:

AbstractRemoteFunctionQuery

public abstract class Query<QueryT extends Query<QueryT,QueryResultT>,QueryResultT extends QueryResult<QueryT,QueryResultT>>
extends Object

Common interface for ERP queries.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Query()

Method Summary

Modifier and Type	Method and Description
QueryResultT	execute() Executes a given query using the default ErpConfigContext.
abstract QueryResultT	execute(ErpConfigContext configContext) Executes a given query using the given ErpConfigContext.
abstract String	getConstructedByMethod()
List<Header>	getCustomHttpHeaders() Set of HTTP headers to send to the underlying query executor.
List<Header>	getHeaderParameters() Deprecated. Use getCustomHttpHeaders() instead. Will be removed in one of the next releases.
Duration	getLongRunningRequestThreshold() Custom execution duration threshold indicating that the query is long running.
String	getReadAccessData()
long	getRequestId() Represents an identifier that allows to correlate queries between the Cloud cloudplatform and the ERP.
protected QueryT	getThis()
void	setLongRunningRequestThreshold(Duration longRunningRequestThreshold) Custom execution duration threshold indicating that the query is long running.
QueryT	withCustomHttpHeader(Header header) Fluent method which adds a custom header to this query.
QueryT	withCustomHttpHeader(String name, String value) Fluent method which adds a custom HTTP header to this query.
QueryT	withSameCustomHttpHeadersAs(Query<?,?> otherQuery) Fluent method which adds the custom headers from another query into this query.

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

protected Query()

Method Detail

getConstructedByMethod

@Nonnull
public abstract String getConstructedByMethod()

Returns:

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

getReadAccessData

@Nullable
public String getReadAccessData()

Returns:

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

getThis

@Nonnull
protected QueryT getThis()

getHeaderParameters

@Deprecated
 @Nonnull
public List<Header> getHeaderParameters()

Deprecated. Use getCustomHttpHeaders() instead. Will be removed in one of the next releases.

withCustomHttpHeader

@Nonnull
public QueryT withCustomHttpHeader(@Nonnull
                                            String name,
                                            @Nullable
                                            String value)

Fluent method which adds a custom HTTP header to this query. 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 Query instance, so that this method can be used again in a fluent API style.

withCustomHttpHeader

@Nonnull
public QueryT withCustomHttpHeader(@Nonnull
                                            Header header)

Fluent method which adds a custom header to this query. 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 Query instance, so that this method can be used again in a fluent API style.

withSameCustomHttpHeadersAs

@Nonnull
public QueryT withSameCustomHttpHeadersAs(@Nonnull
                                                   Query<?,?> otherQuery)

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

Parameters:

otherQuery - Other query to get header parameters from.

Returns:

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

execute

@Nonnull
public abstract QueryResultT execute(@Nonnull
                                              ErpConfigContext configContext)
                                       throws QuerySerializationException,
                                              QueryExecutionException,
                                              DestinationNotFoundException,
                                              DestinationAccessException

Executes a given query using the given ErpConfigContext.

Parameters:

configContext - The ErpConfigContext to be used for query execution.

Throws:

QuerySerializationException - If there is an issue while serializing the query.

QueryExecutionException - If there is an issue while executing the query.

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

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

execute

@Nonnull
public QueryResultT execute()
                              throws QuerySerializationException,
                                     QueryExecutionException,
                                     DestinationNotFoundException,
                                     DestinationAccessException

Executes a given query using the default ErpConfigContext. The default ErpConfigContext can be instantiated with new ErpConfigContext().

Throws:

QuerySerializationException - If there is an issue while serializing the query.

QueryExecutionException - If there is an issue while executing the query.

DestinationNotFoundException - If no destination with the name specified in the ErpConfigContext 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 query is long running.

setLongRunningRequestThreshold

public void setLongRunningRequestThreshold(@Nullable
                                           Duration longRunningRequestThreshold)

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

getCustomHttpHeaders

@Nonnull
public List<Header> getCustomHttpHeaders()

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