com.sap.cds.services.runtime

Interface CdsRuntime

public interface CdsRuntime

Interface for Protocol Adapters to get access to Service instances and CdsModel. It can be used to define Request and ChangeSet boundaries.

Method Summary

Modifier and Type	Method and Description
ChangeSetContextRunner	changeSetContext() Starts a new ChangeSetContext which defines the transactional boundaries
com.sap.cds.reflect.CdsModel	getCdsModel()
default com.sap.cds.reflect.CdsModel	getCdsModel(String tenant)
com.sap.cds.reflect.CdsModel	getCdsModel(UserInfo userInfo, FeatureTogglesInfo featureTogglesInfo)
CdsEnvironment	getEnvironment()
FeatureTogglesInfo	getFeatureTogglesInfo(UserInfo userInfo, ParameterInfo parameterInfo)
String	getLocalizedMessage(String code, Object[] args, Locale locale) Returns the localized message for the given code, arguments and locale if existing, null otherwise.
AuthenticationInfo	getProvidedAuthenticationInfo()
ParameterInfo	getProvidedParameterInfo()
UserInfo	getProvidedUserInfo()
ServiceCatalog	getServiceCatalog()
RequestContextRunner	requestContext() Starts a new RequestContext which defines the context of parameters (reflecting the user, request parameters etc.)
default void	runInChangeSetContext(Consumer<ChangeSetContext> changeSetHandler) Deprecated.
<T> T	runInChangeSetContext(Function<ChangeSetContext,T> changeSetHandler) Deprecated.
default void	runInRequestContext(Request request, Consumer<RequestContext> requestHandler) Deprecated.
<T> T	runInRequestContext(Request request, Function<RequestContext,T> requestHandler) Deprecated.

Method Detail

getEnvironment

CdsEnvironment getEnvironment()

Returns:

The CdsEnvironment built from the environment providers

getServiceCatalog

ServiceCatalog getServiceCatalog()

Returns:

The ServiceCatalog containing all registered Service instances

getCdsModel

com.sap.cds.reflect.CdsModel getCdsModel()

Returns:

The common CdsModel as read from CSN file

getCdsModel

default com.sap.cds.reflect.CdsModel getCdsModel(String tenant)

Parameters:

tenant - the tenant

Returns:

the CDS model for a specific tenant or the default model if tenant is null

getCdsModel

com.sap.cds.reflect.CdsModel getCdsModel(UserInfo userInfo,
                                         FeatureTogglesInfo featureTogglesInfo)

Parameters:

userInfo - the UserInfo

featureTogglesInfo - the FeatureTogglesInfo

Returns:

The CDS model for a specific tenant and FeatureTogglesInfo or the default model if the tenant is null

getProvidedParameterInfo

ParameterInfo getProvidedParameterInfo()

Returns:

The ParameterInfo retrieved from the registered ParameterInfoProvider or an empty ParameterInfo.

getProvidedUserInfo

UserInfo getProvidedUserInfo()

Returns:

The UserInfo retrieved from the registered UserInfoProvider or an anonymous UserInfo.

getProvidedAuthenticationInfo

AuthenticationInfo getProvidedAuthenticationInfo()

Returns:

The AuthenticationInfo retrieved from the registered AuthenticationInfoProvider or null if no authentication was provided.

getFeatureTogglesInfo

FeatureTogglesInfo getFeatureTogglesInfo(UserInfo userInfo,
                                         ParameterInfo parameterInfo)

Parameters:

userInfo - the UserInfo object

parameterInfo - the ParameterInfo

Returns:

The FeatureTogglesInfo retrieved from the registered FeatureTogglesInfoProvider

getLocalizedMessage

String getLocalizedMessage(String code,
                           Object[] args,
                           Locale locale)

Returns the localized message for the given code, arguments and locale if existing, null otherwise. The method does not throw and returns code in case of any errors.

Parameters:

code - The code which is used as key for the format string in the defined bundles.

args - The argument objects for the format string

locale - The locale to be used. If no locale is set the default locale is taken.

Returns:

The localized message or null if the code is not resolvable.

runInRequestContext

@Deprecated
<T> T runInRequestContext(Request request,
                                      Function<RequestContext,T> requestHandler)

Deprecated.

Opens a RequestContext and runs the given handler within its scope. The RequestContext will be propagated to all EventContext instances in the service call hierarchy.

Type Parameters:

T - The type of the response

Parameters:

request - A Request object describing the context of the request like parameters, user etc.

requestHandler - The handler for processing the request within the context

Returns:

A generic response object of the handler

runInRequestContext

@Deprecated
default void runInRequestContext(Request request,
                                             Consumer<RequestContext> requestHandler)

Deprecated.

Opens a RequestContext and runs the given handler within its scope. The RequestContext will be propagated to all EventContext instances in the service call hierarchy.

Parameters:

request - A Request object describing the context of the request like parameters, user etc.

requestHandler - The handler for processing the request within the context

requestContext

RequestContextRunner requestContext()

Starts a new RequestContext which defines the context of parameters (reflecting the user, request parameters etc.)

Returns:

the RequestContextRunner used to open the context.

runInChangeSetContext

@Deprecated
<T> T runInChangeSetContext(Function<ChangeSetContext,T> changeSetHandler)

Deprecated.

Opens a ChangeSetContext and runs the given handler within its scope. The ChangeSetContext marks a scope in which all opened transactions etc. are committed cancelled together. Note that single transactions may fail during commit but others might be successful.

The ChangeSetContext will be propagated to all EventContext instances in the service call hierarchy.

Type Parameters:

T - The type of the response

Parameters:

changeSetHandler - The handler for processing the request within the context

Returns:

A generic response object of the handler

runInChangeSetContext

@Deprecated
default void runInChangeSetContext(Consumer<ChangeSetContext> changeSetHandler)

Deprecated.

Opens a ChangeSetContext and runs the given handler within its scope. The ChangeSetContext marks a scope in which all opened transactions etc. are committed cancelled together. Note that single transactions may fail during commit but others might be successful.

The ChangeSetContext will be propagated to all EventContext instances in the service call hierarchy.

Parameters:

changeSetHandler - The handler for processing the request within the context

changeSetContext

ChangeSetContextRunner changeSetContext()

Starts a new ChangeSetContext which defines the transactional boundaries

Returns:

the ChangeSetContextRunner used to open the context.