Package com.sap.cds.services

Interface CoreFactory

public interface CoreFactory

Factory to create various objects for API interfaces. This class should never be used directly by application code and is only intended for internal usage in cds-services-api. Applications rather should use the specific create methods on the target interfaces.

The implementation of the factory is loaded via ExtendedServiceLoader and is therefore pluggable.

Field Summary

Fields

Modifier and Type	Field	Description
static final CoreFactory	INSTANCE	The instance loaded via ExtendedServiceLoader.

Method Summary

Modifier and Type	Method	Description
CdsRuntimeConfigurer	createCdsRuntimeConfigurer(PropertiesProvider propertiesProvider)	The factory method to create a new CdsRuntimeConfigurer with the given properties.
ChangeSetContextAccessor	createChangeSetContextAccessor()	The factory method to create a new ChangeSetContextAccessor.
ChangeSetContextSPI	createChangeSetContextSPI()	The factory method to create a new ChangeSetContextSPI.
EventContext	createEventContext(String event, String entityName)	The factory method to create a new EventContext.
FeatureTogglesInfo	createFeatureTogglesInfo(List<FeatureToggle> featureToggles)	Creates a FeatureTogglesInfo object.
FeatureTogglesInfo	createFeatureTogglesInfo(Map<String,Boolean> featureToggles)	Creates a FeatureTogglesInfo object.
Message	createMessage(Message.Severity severity, String text)	Creates a Message object.
Message	createMessage(Message.Severity severity, String text, Message message)	Creates a Message object.
Message	createMessage(String text, ServiceException exception)	Creates a Message object.
MessageLookup	createMessageLookup(String messageOrKey, Object[] args)	Application code should use MessageLookup.create(String, Object[]) instead.
MessageTarget	createMessageTarget(com.sap.cds.ql.cqn.Path path, com.sap.cds.reflect.CdsElement element)	Application code should use MessageTarget.create(Path, CdsElement) instead.
MessageTarget	createMessageTarget(String target)	Application code should use MessageTarget.create(String) instead.
MessageTarget	createMessageTarget(String parameter, com.sap.cds.ql.cqn.CqnReference ref)	Application code should use MessageTarget.create(String, CqnReference) instead.
<E extends com.sap.cds.ql.StructuredType<E>> MessageTarget	createMessageTarget(String parameter, Class<E> type, Function<E,Object> path)	Application code should use MessageTarget.create(Class, Function) or MessageTarget.create(String, Class, Function) instead.
MessageTarget	createMessageTarget(String parameter, Function<com.sap.cds.ql.StructuredType<?>,Object> path)	Application code should use MessageTarget.create(Function) or MessageTarget.create(String, Function) instead.
ModifiableParameterInfo	createParameterInfo(ParameterInfo parameterInfo)	Creates a ModifiableParameterInfo based on the passed ParameterInfo.
RequestContextAccessor	createRequestContextAccessor()	The factory method to create a new RequestContextAccessor.
Service	createService(String name)	The factory method to create a new Service.
Service	createService(String name, Service delegator)	The factory method to create a new Service with a given delegator Service.
ServiceExceptionUtils	createServiceExceptionUtils()	The factory method to create a new ServiceExceptionUtils.
ModifiableUserInfo	createUserInfo(UserInfo userInfo)	Creates a ModifiableUserInfo based on the passed UserInfo.
<S extends Service> S	unboxed(S service)	Removes an outbox wrapper from the given service.

Field Details

INSTANCE

static final CoreFactory INSTANCE

The instance loaded via ExtendedServiceLoader.

Method Details

createEventContext

EventContext createEventContext(String event,
 String entityName)

The factory method to create a new EventContext.

Application code should use EventContext.create(String, String) instead.

Parameters:

event - the name of the event

entityName - the name of the entity

Returns:

the EventContext

createService

Service createService(String name)

The factory method to create a new Service.

Application code should use EventContext.create(String, String) instead.

Parameters:

name - the name of the service

Returns:

the Service

createService

Service createService(String name,
 Service delegator)

The factory method to create a new Service with a given delegator Service.

This method is intended to be used only by ServiceDelegator.

Parameters:

name - the name of the service

delegator - the delegator Service

Returns:

the Service

createCdsRuntimeConfigurer

CdsRuntimeConfigurer createCdsRuntimeConfigurer(PropertiesProvider propertiesProvider)

The factory method to create a new CdsRuntimeConfigurer with the given properties.

Application code should use CdsRuntimeConfigurer.create() or CdsRuntimeConfigurer.create(PropertiesProvider) instead.

Parameters:

propertiesProvider - the PropertiesProvider, may be null, which means a simple PropertiesProvider providing default CdsProperties is used

Returns:

the CdsRuntimeConfigurer

createRequestContextAccessor

RequestContextAccessor createRequestContextAccessor()

The factory method to create a new RequestContextAccessor.

This method is intended to be used only by RequestContext.

Returns:

the RequestContextAccessor

createChangeSetContextAccessor

ChangeSetContextAccessor createChangeSetContextAccessor()

The factory method to create a new ChangeSetContextAccessor.

This method is intended to be used only by ChangeSetContext.

Returns:

the ChangeSetContextAccessor

createChangeSetContextSPI

ChangeSetContextSPI createChangeSetContextSPI()

The factory method to create a new ChangeSetContextSPI.

Application code should use ChangeSetContextSPI.open() instead.

Returns:

the ChangeSetContextSPI

createParameterInfo

ModifiableParameterInfo createParameterInfo(ParameterInfo parameterInfo)

Creates a ModifiableParameterInfo based on the passed ParameterInfo. If parameterInfo is null, a ModifiableParameterInfo based on default values of a clear ParameterInfo is returned.

Application code should use ParameterInfo.create() or ParameterInfo.copy() instead.

Parameters:

parameterInfo - The ParameterInfo as basis.

Returns:

The created ModifiableParameterInfo instance.

createUserInfo

ModifiableUserInfo createUserInfo(UserInfo userInfo)

Creates a ModifiableUserInfo based on the passed UserInfo. If userInfo is null, a ModifiableUserInfo based on default values of a clear UserInfo is returned.

Application code should use UserInfo.create() or UserInfo.copy() instead.

Parameters:

userInfo - The UserInfo as basis.

Returns:

The created ModifiableUserInfo instance.

createFeatureTogglesInfo

FeatureTogglesInfo createFeatureTogglesInfo(List<FeatureToggle> featureToggles)

Creates a FeatureTogglesInfo object.

Application code should use FeatureTogglesInfo.create(List) instead.

Parameters:

featureToggles - A List of feature toggles

Returns:

A FeatureTogglesInfo object containing all provided feature toggles in the stream

createFeatureTogglesInfo

FeatureTogglesInfo createFeatureTogglesInfo(Map<String,Boolean> featureToggles)

Creates a FeatureTogglesInfo object.

Application code should use FeatureTogglesInfo.create(Map) instead.

Parameters:

featureToggles - A Map where the key is the feature name and the value indicates if the feature is enable or not

Returns:

A FeatureTogglesInfo object containing the feature toggles created from the map entries

createServiceExceptionUtils

ServiceExceptionUtils createServiceExceptionUtils()

The factory method to create a new ServiceExceptionUtils.

This method is intended to be used only by ServiceException.

Returns:

the ServiceExceptionUtils

createMessage

Message createMessage(Message.Severity severity,
 String text)

Creates a Message object.

Application code should use Message.create(Severity, String) instead.

Parameters:

severity - the Message.Severity of the Message

text - the final text of the message

Returns:

the Message

createMessage

Message createMessage(String text,
 ServiceException exception)

Creates a Message object.

Application code should use Message.create(String, ServiceException) instead.

Parameters:

text - the final text of the message

exception - the ServiceException to copy optional arguments from

Returns:

the Message

createMessage

Message createMessage(Message.Severity severity,
 String text,
 Message message)

Creates a Message object.

Application code should use Message.create(Severity, String, Message) instead.

Parameters:

severity - the Message.Severity of the Message

text - the final text of the message

message - the Message

Returns:

the Message

createMessageTarget

MessageTarget createMessageTarget(String target)

Application code should use MessageTarget.create(String) instead.

Parameters:

target -

Returns:

createMessageTarget

MessageTarget createMessageTarget(String parameter,
 Function<com.sap.cds.ql.StructuredType<?>,Object> path)

Application code should use MessageTarget.create(Function) or MessageTarget.create(String, Function) instead.

Parameters:

parameter -

path -

Returns:

createMessageTarget

<E extends com.sap.cds.ql.StructuredType<E>>
MessageTarget createMessageTarget(String parameter,
 Class<E> type,
 Function<E,Object> path)

Application code should use MessageTarget.create(Class, Function) or MessageTarget.create(String, Class, Function) instead.

Type Parameters:

E -

Parameters:

parameter -

type -

path -

Returns:

createMessageTarget

MessageTarget createMessageTarget(com.sap.cds.ql.cqn.Path path,
 com.sap.cds.reflect.CdsElement element)

Application code should use MessageTarget.create(Path, CdsElement) instead.

Parameters:

path -

element -

Returns:

createMessageTarget

MessageTarget createMessageTarget(String parameter,
 com.sap.cds.ql.cqn.CqnReference ref)

Application code should use MessageTarget.create(String, CqnReference) instead.

Parameters:

parameter -

ref -

Returns:

createMessageLookup

MessageLookup createMessageLookup(String messageOrKey,
 Object[] args)

Application code should use MessageLookup.create(String, Object[]) instead.

Parameters:

messageOrKey -

args -

Returns:

unboxed

<S extends Service> S unboxed(S service)

Removes an outbox wrapper from the given service.

Application code should use OutboxService.unboxed(Service) instead.

Type Parameters:

S - the type of service

Parameters:

service - the service to unwrap from outbox wrapping

Returns:

the underlying service of the outbox wrapped service.