Package com.sap.cds.services.runtime

Interface RequestContextRunner

public interface RequestContextRunner

RequestContextRunner is the main entry to spawn a new RequestContext with adapted UserInfo or ParameterInfo. The current parameters of the calling RequestContext are not affected.

Method Summary

Modifier and Type	Method	Description
RequestContextRunner	anonymousUser()	Sets the UserInfo for the RequestContext to the anonymous user.
RequestContextRunner	clearMessages()	Resets the Messages for the RequestContext being opened.
RequestContextRunner	clearParameters()	Resets the ParameterInfo for the RequestContext being opened.
default RequestContextRunner	clearUser()	Resets the UserInfo for the RequestContext being opened.
RequestContextRunner	featureToggles(FeatureTogglesInfo featureTogglesInfo)	Sets a dedicated FeatureTogglesInfo for the RequestContext being opened.
RequestContextRunner	modifyParameters(Consumer<ModifiableParameterInfo> contextParameters)	Opens a RequestContext with an adapted ParameterInfo.
RequestContextRunner	modifyUser(Consumer<ModifiableUserInfo> contextUser)	Opens a RequestContext with an adapted UserInfo.
RequestContextRunner	parameters(ParameterInfo parameterInfo)	Sets a dedicated ParameterInfo for the RequestContext being opened.
RequestContextRunner	privilegedUser()	Sets the UserInfo for the RequestContext to the internal privileged user who passes all authorization checks.
RequestContextRunner	providedParameters()	Sets the ParameterInfo for the RequestContext as provided by the ParameterInfoProvider.
RequestContextRunner	providedUser()	Sets the UserInfo for the RequestContext as provided by the UserInfoProvider.
void	run(Consumer<RequestContext> requestHandler)	Opens a RequestContext and runs the given handler within its scope.
<T> T	run(Function<RequestContext,T> requestHandler)	Opens a RequestContext and runs the given handler within its scope.
RequestContextRunner	systemUser()	Sets the UserInfo for the RequestContext to the system user.
RequestContextRunner	systemUser(String tenantId)	Sets the UserInfo for the RequestContext to the system user of the specified subscriber account.
RequestContextRunner	systemUserProvider()	Sets the UserInfo for the RequestContext to the system user of the provider account.
RequestContextRunner	user(UserInfo userInfo)	Sets a dedicated UserInfo for the RequestContext being opened.

Method Details

user

RequestContextRunner user(UserInfo userInfo)

Sets a dedicated UserInfo for the RequestContext being opened.

Parameters:

userInfo - The UserInfo.

Returns:

this instance

clearUser

default RequestContextRunner clearUser()

Resets the UserInfo for the RequestContext being opened. The empty user is anonymous.

Returns:

this instance

anonymousUser

RequestContextRunner anonymousUser()

Sets the UserInfo for the RequestContext to the anonymous user. This user is the base-line also used by clearUser().

Returns:

this instance

providedUser

RequestContextRunner providedUser()

Sets the UserInfo for the RequestContext as provided by the UserInfoProvider. By default this means the UserInfo is resolved from the HTTP request. You may override the default provider during runtime configuration phase by means of CdsRuntimeConfigurer.provider(UserInfoProvider).

Returns:

this instance

systemUserProvider

RequestContextRunner systemUserProvider()

Sets the UserInfo for the RequestContext to the system user of the provider account. This is equivalent to calling systemUser(null)

Returns:

this instance

systemUser

RequestContextRunner systemUser()

Sets the UserInfo for the RequestContext to the system user. The tenant will be automatically propagated from the current UserInfo. This is equivalent to calling systemUser(userInfo.getTenant()).

Returns:

this instance

systemUser

RequestContextRunner systemUser(String tenantId)

Sets the UserInfo for the RequestContext to the system user of the specified subscriber account.

Parameters:

tenantId - Tenant in which the RequestContext will be executed

Returns:

this instance

privilegedUser

RequestContextRunner privilegedUser()

Sets the UserInfo for the RequestContext to the internal privileged user who passes all authorization checks.

Returns:

this instance

modifyUser

RequestContextRunner modifyUser(Consumer<ModifiableUserInfo> contextUser)

Opens a RequestContext with an adapted UserInfo. The passed ModifiableUserInfo API can be used to define modifications which are valid within the scope of the new RequestContext.

The modifications are done on the UserInfo of the outer RequestContext if existing. Otherwise they are done on the provided UserInfo from UserInfoProvider.

Parameters:

contextUser - the ModifiableUserInfo as modification layer on top of current UserInfo

Returns:

this instance

parameters

RequestContextRunner parameters(ParameterInfo parameterInfo)

Sets a dedicated ParameterInfo for the RequestContext being opened.

Parameters:

parameterInfo - the ParameterInfo.

Returns:

this instance

featureToggles

RequestContextRunner featureToggles(FeatureTogglesInfo featureTogglesInfo)

Sets a dedicated FeatureTogglesInfo for the RequestContext being opened. Throws an exception in case the RequestContext being opened has a parent (i.e. is nested).

Parameters:

featureTogglesInfo - the FeatureTogglesInfo.

Returns:

this instance

clearParameters

RequestContextRunner clearParameters()

Resets the ParameterInfo for the RequestContext being opened.

Returns:

this instance

providedParameters

RequestContextRunner providedParameters()

Sets the ParameterInfo for the RequestContext as provided by the ParameterInfoProvider. By default this means the ParameterInfo is resolved from the HTTP request. You may override the default provider during runtime configuration phase by means of CdsRuntimeConfigurer.provider(ParameterInfoProvider).

Returns:

this instance

modifyParameters

RequestContextRunner modifyParameters(Consumer<ModifiableParameterInfo> contextParameters)

Opens a RequestContext with an adapted ParameterInfo. The passed ModifiableParameterInfo API can be used to define modifications which are valid within the scope of the new RequestContext.

The modifications are done on the ParameterInfo of the outer RequestContext if existing. Otherwise they are done on the provided ParameterInfo from ParameterInfoProvider.

Parameters:

contextParameters - the ModifiableParameterInfo as modification layer on top of current ParameterInfo

Returns:

this instance

clearMessages

RequestContextRunner clearMessages()

Resets the Messages for the RequestContext being opened.

Returns:

this instance

run

<T> T run(Function<RequestContext,T> requestHandler)

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:

requestHandler - The handler for processing the request within the context

Returns:

A generic response object of the handler

run

void run(Consumer<RequestContext> requestHandler)

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.

If UserInfo has not been specified explicitly, it is taken from the outer RequestContext or, if there is no outer context, from UserInfoProvider. The same holds for ParameterInfo.

Parameters:

requestHandler - The handler for processing the request within the context