com.sap.cloud.sdk.s4hana.connectivity

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

java.lang.Object

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

All Implemented Interfaces:

QueryExecutor<QueryT,QueryResultT>

Direct Known Subclasses:

JCoRemoteFunctionQueryExecutor, SoapRemoteFunctionQueryExecutor

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

Abstract base class for QueryExecutor implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Duration	DEFAULT_LONG_RUNNING_REQUEST_THRESHOLD
protected static int	MAX_UNCOMPRESSED_PAYLOAD_LENGTH

Constructor Summary

Constructors

Constructor and Description
AbstractQueryExecutor()

Method Summary

Modifier and Type	Method and Description
protected URI	appendQueryParam(URI uri, String queryParamKey, String queryParamValue)
protected QueryResultT	deserializeQuery(ErpConfigContext configContext, QueryT query, QuerySerializer<QueryT,QueryResultT> querySerializer, String responseBody)
protected QueryResultT	executeQuery(ErpConfigContext configContext, QueryT query, QuerySerializer<QueryT,QueryResultT> querySerializer)
protected String	executeRequest(ErpConfigContext configContext, SerializedQuery<QueryT> serializedQuery)
protected org.apache.http.entity.ByteArrayEntity	getBodyAsCompressedEntity(String body)
QueryExecutionMeasurements	getMeasurements()
protected String	getNonSensitiveHeadersAsString(List<Header> headers) Converts the given headers to a String while omitting sensitive headers to avoid leaking them to logs.
protected String	getQueryExecutionFailedMessage(QueryT query)
protected String	getRequestBody(ErpConfigContext configContext, Destination destination, SerializedQuery<QueryT> serializedQuery)
protected List<Header>	getRequestHeaders(ErpConfigContext configContext, Destination destination, SerializedQuery<QueryT> serializedQuery)
protected RequestMethod	getRequestMethod(ErpConfigContext configContext, Destination destination, SerializedQuery<QueryT> serializedQuery)
protected URI	getRequestUri(ErpConfigContext configContext, Destination destination, SerializedQuery<QueryT> serializedQuery)
protected void	handleBadGateway(String responseBody, List<Header> responseHeaders)
protected void	handleForbidden(String responseBody, List<Header> responseHeaders)
protected void	handleHttpError(ErpConfigContext configContext, int statusCode, String responseBody, List<Header> responseHeaders)
protected void	handleHttpStatus(ErpConfigContext configContext, int statusCode, String responseBody, List<Header> responseHeaders)
protected void	handleInternalServerError(String responseBody, List<Header> responseHeaders)
protected void	handleServiceUnavailableError(ErpConfigContext configContext, String responseBody, List<Header> responseHeaders)
protected void	handleUnauthorized(String responseBody, List<Header> responseHeaders)
protected void	logReadAccessAttempt(QueryT query)
protected org.apache.http.client.methods.HttpUriRequest	newRequest(ErpConfigContext configContext, RequestMethod requestMethod, URI requestUri, List<Header> requestHeaders, String requestBody)
protected void	recordExecutionDuration(SerializedQuery<QueryT> serializedQuery, org.apache.http.RequestLine requestLine, org.apache.http.StatusLine statusLine, List<Header> responseHeaders, String responseBody)
protected SerializedQuery<QueryT>	serializeQuery(ErpConfigContext configContext, QueryT query, QuerySerializer<QueryT,QueryResultT> querySerializer)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sap.cloud.sdk.s4hana.connectivity.QueryExecutor

execute

Field Detail

MAX_UNCOMPRESSED_PAYLOAD_LENGTH

protected static final int MAX_UNCOMPRESSED_PAYLOAD_LENGTH

See Also:

Constant Field Values

DEFAULT_LONG_RUNNING_REQUEST_THRESHOLD

protected static final Duration DEFAULT_LONG_RUNNING_REQUEST_THRESHOLD

Constructor Detail

AbstractQueryExecutor

public AbstractQueryExecutor()

Method Detail

getBodyAsCompressedEntity

protected org.apache.http.entity.ByteArrayEntity getBodyAsCompressedEntity(String body)
                                                                    throws QuerySerializationException

Throws:

QuerySerializationException

appendQueryParam

protected URI appendQueryParam(URI uri,
                               String queryParamKey,
                               String queryParamValue)
                        throws QuerySerializationException

Throws:

QuerySerializationException

handleHttpStatus

protected void handleHttpStatus(ErpConfigContext configContext,
                                int statusCode,
                                String responseBody,
                                List<Header> responseHeaders)
                         throws QueryExecutionException

Throws:

QueryExecutionException

handleHttpError

protected void handleHttpError(ErpConfigContext configContext,
                               int statusCode,
                               String responseBody,
                               List<Header> responseHeaders)
                        throws QueryExecutionException

Throws:

QueryExecutionException

handleUnauthorized

protected void handleUnauthorized(String responseBody,
                                  List<Header> responseHeaders)
                           throws LogonErrorException

Throws:

LogonErrorException

handleForbidden

protected void handleForbidden(String responseBody,
                               List<Header> responseHeaders)
                        throws AccessDeniedException

Throws:

AccessDeniedException

handleInternalServerError

protected void handleInternalServerError(String responseBody,
                                         List<Header> responseHeaders)
                                  throws QueryExecutionException

Throws:

QueryExecutionException

handleServiceUnavailableError

protected void handleServiceUnavailableError(ErpConfigContext configContext,
                                             String responseBody,
                                             List<Header> responseHeaders)
                                      throws QueryExecutionException

Throws:

QueryExecutionException

handleBadGateway

protected void handleBadGateway(String responseBody,
                                List<Header> responseHeaders)
                         throws QueryExecutionException

Throws:

QueryExecutionException

getNonSensitiveHeadersAsString

protected String getNonSensitiveHeadersAsString(List<Header> headers)

Converts the given headers to a String while omitting sensitive headers to avoid leaking them to logs.

executeQuery

@NonNull
protected QueryResultT executeQuery(ErpConfigContext configContext,
                                             QueryT query,
                                             QuerySerializer<QueryT,QueryResultT> querySerializer)
                                      throws QuerySerializationException,
                                             QueryExecutionException,
                                             DestinationNotFoundException,
                                             DestinationAccessException

Throws:

QuerySerializationException

QueryExecutionException

DestinationNotFoundException

DestinationAccessException

serializeQuery

@Nonnull
protected SerializedQuery<QueryT> serializeQuery(ErpConfigContext configContext,
                                                          QueryT query,
                                                          QuerySerializer<QueryT,QueryResultT> querySerializer)
                                                   throws QuerySerializationException,
                                                          QueryExecutionException,
                                                          DestinationNotFoundException,
                                                          DestinationAccessException

Throws:

QuerySerializationException

QueryExecutionException

DestinationNotFoundException

DestinationAccessException

deserializeQuery

@Nonnull
protected QueryResultT deserializeQuery(ErpConfigContext configContext,
                                                 QueryT query,
                                                 QuerySerializer<QueryT,QueryResultT> querySerializer,
                                                 String responseBody)
                                          throws QuerySerializationException,
                                                 QueryExecutionException,
                                                 DestinationNotFoundException,
                                                 DestinationAccessException

Throws:

QuerySerializationException

QueryExecutionException

DestinationNotFoundException

DestinationAccessException

getRequestMethod

@Nonnull
protected RequestMethod getRequestMethod(ErpConfigContext configContext,
                                                  Destination destination,
                                                  SerializedQuery<QueryT> serializedQuery)

getRequestUri

@Nonnull
protected URI getRequestUri(ErpConfigContext configContext,
                                     Destination destination,
                                     SerializedQuery<QueryT> serializedQuery)

getRequestHeaders

@Nonnull
protected List<Header> getRequestHeaders(ErpConfigContext configContext,
                                                  Destination destination,
                                                  SerializedQuery<QueryT> serializedQuery)

getRequestBody

@Nonnull
protected String getRequestBody(ErpConfigContext configContext,
                                         Destination destination,
                                         SerializedQuery<QueryT> serializedQuery)

newRequest

protected org.apache.http.client.methods.HttpUriRequest newRequest(ErpConfigContext configContext,
                                                                   RequestMethod requestMethod,
                                                                   URI requestUri,
                                                                   List<Header> requestHeaders,
                                                                   String requestBody)
                                                            throws QuerySerializationException

Throws:

QuerySerializationException

logReadAccessAttempt

protected void logReadAccessAttempt(QueryT query)

getQueryExecutionFailedMessage

protected String getQueryExecutionFailedMessage(QueryT query)

recordExecutionDuration

protected void recordExecutionDuration(SerializedQuery<QueryT> serializedQuery,
                                       org.apache.http.RequestLine requestLine,
                                       org.apache.http.StatusLine statusLine,
                                       List<Header> responseHeaders,
                                       String responseBody)

executeRequest

protected String executeRequest(ErpConfigContext configContext,
                                SerializedQuery<QueryT> serializedQuery)
                         throws QuerySerializationException,
                                QueryExecutionException,
                                DestinationNotFoundException,
                                DestinationAccessException

Throws:

QuerySerializationException

QueryExecutionException

DestinationNotFoundException

DestinationAccessException

getMeasurements

public QueryExecutionMeasurements getMeasurements()