com.sap.cloud.sdk.s4hana.connectivity

Class ErpEndpoint

java.lang.Object

com.sap.cloud.sdk.s4hana.connectivity.ErpEndpoint

All Implemented Interfaces:

WithDestinationName

public class ErpEndpoint
extends Object

Endpoint for sending various types of queries to an ERP system.

Caution: This class is not thread-safe. Threads must create their own instances of this class.

Constructor Summary

Constructors

Constructor and Description
ErpEndpoint() Construct a new ERP endpoint using the default ErpConfigContext, which uses default ERP destination name ErpDestination.getDefaultName(), default SAP client destination property ErpConfigContext.DEFAULT_SAP_CLIENT_PROPERTY for DestinationType.HTTP or ErpConfigContext.DEFAULT_SAP_CLIENT_PROPERTY_RFC for DestinationType.RFC if available - otherwise SapClient.DEFAULT.
ErpEndpoint(ErpConfigContext erpConfigContext) Construct a new ERP endpoint based on the given ErpConfigContext.
ErpEndpoint(ErpConfigContext erpConfigContext, ErpQuerySignerFactory querySignerFactory) Construct a new ERP endpoint based on the given ErpConfigContext and ErpQuerySignerFactory.

Method Summary

Modifier and Type	Method and Description
void	assertMinInterfaceVersion(int minVersionRequired) Deprecated. No longer supported, do not use.
<QueryT extends Query<QueryT,QueryResultT>,QueryResultT extends QueryResult<QueryT,QueryResultT>,QuerySerializerT extends QuerySerializer<QueryT,QueryResultT>> QueryResultT	executeQuery(QueryT query, QuerySerializerT querySerializer) Executes the given query, writes an audit log entry, and measures the execution time.
<QueryT extends Query<QueryT,QueryResultT>,QueryResultT extends QueryResult<QueryT,QueryResultT>> SerializedQueryResult<QueryT>	executeQuery(SerializedQuery<QueryT> serializedQuery) Executes the given query, writes an audit log entry, and measures the execution time.
ErpConfigContext	getConfigContext()
String	getDestinationName()
ErpSystemInfo	getErpSystemInfo() Deprecated. No longer supported, do not use.
com.google.common.base.Optional<ErpSystemInfo>	getErpSystemInfoIfPresent() Deprecated. No longer supported, do not use.
ErpSystemInfo	getErpSystemInfoIgnoringCache() Deprecated. No longer supported, do not use.
QueryExecutionMeasurements	getMeasurements()

Methods inherited from class java.lang.Object

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

Constructor Detail

ErpEndpoint

public ErpEndpoint()

Construct a new ERP endpoint using the default ErpConfigContext, which uses

• default ERP destination name ErpDestination.getDefaultName(),
• default SAP client destination property
  • ErpConfigContext.DEFAULT_SAP_CLIENT_PROPERTY for DestinationType.HTTP or
  • ErpConfigContext.DEFAULT_SAP_CLIENT_PROPERTY_RFC for DestinationType.RFC
  if available - otherwise SapClient.DEFAULT.
• default locale destination property
  • ErpConfigContext.DEFAULT_LOCALE_PROPERTY for DestinationType.HTTP or
  • ErpConfigContext.DEFAULT_LOCALE_PROPERTY_RFC for DestinationType.RFC
  if available - otherwise locale LocaleAccessor.getCurrentLocale().

See Also:

ErpConfigContext.ErpConfigContext()

ErpEndpoint

public ErpEndpoint(@Nullable
                   ErpConfigContext erpConfigContext)

Construct a new ERP endpoint based on the given ErpConfigContext.

Parameters:

erpConfigContext - The ErpConfigContext to be used. If null, this corresponds to invoking the default constructor ErpEndpoint().

ErpEndpoint

public ErpEndpoint(@Nullable
                   ErpConfigContext erpConfigContext,
                   @Nullable
                   ErpQuerySignerFactory querySignerFactory)

Construct a new ERP endpoint based on the given ErpConfigContext and ErpQuerySignerFactory.

Parameters:

erpConfigContext - The ErpConfigContext to be used. If null, this corresponds to invoking the default constructor ErpEndpoint().

querySignerFactory - The ErpQuerySignerFactory to be used. If null, the StrategyBasedErpQuerySignerFactory is used.

Method Detail

assertMinInterfaceVersion

@Deprecated
public void assertMinInterfaceVersion(int minVersionRequired)
                                           throws QueryExecutionException

Deprecated. No longer supported, do not use.

Asserts that the given ABAP interface version is available.

Throws:

QueryExecutionException - If there was an error while retrieving the ABAP interface version.

AbapInterfaceNotSupportedException - If the given ABAP interface version is not supported.

getErpSystemInfo

@Deprecated
public ErpSystemInfo getErpSystemInfo()
                                           throws QueryExecutionException,
                                                  DestinationNotFoundException,
                                                  DestinationAccessException

Deprecated. No longer supported, do not use.

Retrieves the ErpSystemInfo by querying the ABAP interface. The result may be cached.

Throws:

QueryExecutionException - If the interface is not available or the ErpSystemInfo cannot be retrieved correctly.

DestinationNotFoundException

DestinationAccessException

getErpSystemInfoIfPresent

@Deprecated
public com.google.common.base.Optional<ErpSystemInfo> getErpSystemInfoIfPresent()

Deprecated. No longer supported, do not use.

Retrieves the ErpSystemInfo by querying the ABAP interface. The result may be cached.

Returns:

The ErpSystemInfo, if available.

getErpSystemInfoIgnoringCache

@Deprecated
public ErpSystemInfo getErpSystemInfoIgnoringCache()
                                                        throws QueryExecutionException,
                                                               DestinationNotFoundException,
                                                               DestinationAccessException

Deprecated. No longer supported, do not use.

Retrieves the ErpSystemInfo by querying the ABAP interface without using any cached results.

Note:This always executes an InfoQuery against the ERP.

Throws:

QueryExecutionException - If the interface is not available or the ErpSystemInfo cannot be retrieved correctly.

DestinationNotFoundException

DestinationAccessException

executeQuery

public <QueryT extends Query<QueryT,QueryResultT>,QueryResultT extends QueryResult<QueryT,QueryResultT>,QuerySerializerT extends QuerySerializer<QueryT,QueryResultT>> QueryResultT executeQuery(QueryT query,
                                                                                                                                                                                                 QuerySerializerT querySerializer)
                                                                                                                                                                                          throws QuerySerializationException,
                                                                                                                                                                                                 QueryExecutionException,
                                                                                                                                                                                                 DestinationNotFoundException,
                                                                                                                                                                                                 DestinationAccessException

Executes the given query, writes an audit log entry, and measures the execution time. For internal use only.

Throws:

QuerySerializationException

QueryExecutionException

DestinationNotFoundException

DestinationAccessException

executeQuery

public <QueryT extends Query<QueryT,QueryResultT>,QueryResultT extends QueryResult<QueryT,QueryResultT>> SerializedQueryResult<QueryT> executeQuery(SerializedQuery<QueryT> serializedQuery)
                                                                                                                                             throws QuerySerializationException,
                                                                                                                                                    QueryExecutionException

Executes the given query, writes an audit log entry, and measures the execution time. For internal use only.

Throws:

QuerySerializationException

QueryExecutionException

getMeasurements

@Generated(value="lombok")
public QueryExecutionMeasurements getMeasurements()

getConfigContext

public final ErpConfigContext getConfigContext()

getDestinationName

public String getDestinationName()

Specified by:

getDestinationName in interface WithDestinationName