CdsRuntimeConfigurer (CDS Services API 1.7.0 API)

```
public interface CdsRuntimeConfigurer
```

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`CdsRuntimeConfigurer`	`cdsModel()` Sets the default CDS model on the `CdsRuntime` of this `CdsRuntimeConfigurer`
`CdsRuntimeConfigurer`	`cdsModel(com.sap.cds.reflect.CdsModel model)` Sets the given `CdsModel` on the `CdsRuntime` of this `CdsRuntimeConfigurer`
`CdsRuntimeConfigurer`	`cdsModel(String csnPath)` Sets the CDS model from the specified CSN file path on the `CdsRuntime` of this `CdsRuntimeConfigurer`
`CdsRuntime`	`complete()` Completes the `CdsRuntimeConfigurer` to prevent any further modifications of the `CdsRuntime`
`CdsRuntimeConfigurer`	`configuration(CdsRuntimeConfiguration configuration)` Adds a given `CdsRuntimeConfiguration` to the `CdsRuntimeConfigurer`.
`static CdsRuntimeConfigurer`	`create()` Creates a new `CdsRuntimeConfigurer`.
`<T> CdsRuntimeConfigurer`	`eventHandler(Class<T> handlerClass, Supplier<T> handlerFactory)` Registers an event handler class with the `CdsRuntime`, given a factory to create instances of the event handler
`CdsRuntimeConfigurer`	`eventHandler(Object handler)` Registers an event handler instance with the `CdsRuntime`.
`CdsRuntimeConfigurer`	`eventHandlerConfigurations()` Applies all event handler configuration modules to the `CdsRuntime` of this `CdsRuntimeConfigurer`
`CdsRuntime`	`getCdsRuntime()` The `CdsRuntime` that is configured by this `CdsRuntimeConfigurer`.
`CdsRuntimeConfigurer`	`packageScan(String packageName)` Scans the given package for event handler classes and registers them on the `CdsRuntime`
`CdsRuntimeConfigurer`	`service(Service service)` Registers a given `Service` in the `ServiceCatalog` of the `CdsRuntime`.
`CdsRuntimeConfigurer`	`serviceConfigurations()` Applies all service configuration modules to the `CdsRuntime` of this `CdsRuntimeConfigurer`

- Method Detail
  - create
```
static CdsRuntimeConfigurer create()
```
    Creates a new CdsRuntimeConfigurer. In addition it automatically adds all CdsRuntimeConfiguration modules registered through ServiceLoader mechanisms.
    
    Returns:
    
    the CdsRuntimeConfigurer
  - getCdsRuntime
```
CdsRuntime getCdsRuntime()
```
    The CdsRuntime that is configured by this CdsRuntimeConfigurer. It can be retrieved at any time, although it might get enriched by subsequent calls to this CdsRuntimeConfigurer.
    
    Returns:
    
    the CdsRuntime
  - cdsModel
```
CdsRuntimeConfigurer cdsModel()
```
    Sets the default CDS model on the CdsRuntime of this CdsRuntimeConfigurer
    
    Returns:
    
    the CdsRuntimeConfigurer
  - cdsModel
```
CdsRuntimeConfigurer cdsModel(String csnPath)
```
    Sets the CDS model from the specified CSN file path on the CdsRuntime of this CdsRuntimeConfigurer
    
    Parameters:
    
    csnPath - the CSN file path
    
    Returns:
    
    the CdsRuntimeConfigurer
  - cdsModel
```
CdsRuntimeConfigurer cdsModel(com.sap.cds.reflect.CdsModel model)
```
    Sets the given CdsModel on the CdsRuntime of this CdsRuntimeConfigurer
    
    Parameters:
    
    model - the CdsModel
    
    Returns:
    
    the CdsRuntimeConfigurer
  - configuration
```
CdsRuntimeConfigurer configuration(CdsRuntimeConfiguration configuration)
```
    Adds a given CdsRuntimeConfiguration to the CdsRuntimeConfigurer. This configuration will be applied in parts, when the respective bulk operations are triggered, for example serviceConfigurations() or eventHandlerConfigurations()
    
    Parameters:
    
    configuration - the CdsRuntimeConfiguration
    
    Returns:
    
    the CdsRuntimeConfigurer
  - serviceConfigurations
```
CdsRuntimeConfigurer serviceConfigurations()
```
    Applies all service configuration modules to the CdsRuntime of this CdsRuntimeConfigurer
    
    Returns:
    
    the CdsRuntimeConfigurer
  - service
```
CdsRuntimeConfigurer service(Service service)
```
    Registers a given Service in the ServiceCatalog of the CdsRuntime.
    
    Parameters:
    
    service - the Service
    
    Returns:
    
    the CdsRuntimeConfigurer
  - eventHandlerConfigurations
```
CdsRuntimeConfigurer eventHandlerConfigurations()
```
    Applies all event handler configuration modules to the CdsRuntime of this CdsRuntimeConfigurer
    
    Returns:
    
    the CdsRuntimeConfigurer
  - eventHandler
```
CdsRuntimeConfigurer eventHandler(Object handler)
```
    Registers an event handler instance with the CdsRuntime.
    
    Parameters:
    
    handler - the event handler instance
    
    Returns:
    
    the CdsRuntimeConfigurer
  - eventHandler
```
<T> CdsRuntimeConfigurer eventHandler(Class<T> handlerClass,
                                      Supplier<T> handlerFactory)
```
    Registers an event handler class with the CdsRuntime, given a factory to create instances of the event handler
    
    Type Parameters:
    
    T - the event handler type
    
    Parameters:
    
    handlerClass - the event handler class
    
    handlerFactory - the supplier for instances of the event handler
    
    Returns:
    
    the CdsRuntimeConfigurer
  - packageScan
```
CdsRuntimeConfigurer packageScan(String packageName)
                          throws IOException
```
    Scans the given package for event handler classes and registers them on the CdsRuntime
    
    Parameters:
    
    packageName - the name of the package
    
    Returns:
    
    the CdsRuntimeConfigurer
    
    Throws:
    
    IOException - if the classes of the package can't be loaded from the classpath
  - complete
```
CdsRuntime complete()
```
    Completes the CdsRuntimeConfigurer to prevent any further modifications of the CdsRuntime
    
    Returns:
    
    the CdsRuntime in its final state

Interface CdsRuntimeConfigurer

Method Summary

Method Detail

create

getCdsRuntime

cdsModel

cdsModel

cdsModel

configuration

serviceConfigurations

service

eventHandlerConfigurations

eventHandler

eventHandler

packageScan

complete