Package com.sap.cds.services.mt

Interface TenantProviderService

All Superinterfaces:

Service

public interface TenantProviderService
extends Service

Interface for a Service that provides tenant information.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_NAME
static final String	EVENT_READ_PROVIDER_TENANT
static final String	EVENT_READ_TENANTS

Method Summary

Modifier and Type	Method	Description
String	readProviderTenant()
default List<String>	readTenants()
List<TenantInfo>	readTenantsInfo()
List<TenantInfo>	readTenantsInfo(Set<String> fields)

Methods inherited from interface com.sap.cds.services.Service

after, after, after, after, before, before, before, before, emit, getName, on, on, on, on

Field Details

DEFAULT_NAME

static final String DEFAULT_NAME

See Also:

• Constant Field Values

EVENT_READ_TENANTS

static final String EVENT_READ_TENANTS

See Also:

• Constant Field Values

EVENT_READ_PROVIDER_TENANT

static final String EVENT_READ_PROVIDER_TENANT

See Also:

• Constant Field Values

Method Details

readTenants

default List<String> readTenants()

Returns:

A list of tenant identifiers that are currently subscribed to this application. In single tenant scenario the list contains a single null value representing the provider tenant.

readTenantsInfo

List<TenantInfo> readTenantsInfo(Set<String> fields)

Parameters:

fields - A set of fields to retain from the TenantInfo object.

Returns:

A list of TenantInfo for all tenants that are currently subscribed to this application. In single tenant scenario the list contains a single TenantInfo object with tenant null representing the provider tenant.

readTenantsInfo

List<TenantInfo> readTenantsInfo()

Returns:

A list of TenantInfo for all tenants that are currently subscribed to this application. In single tenant scenario the list contains a single TenantInfo object with tenant null representing the provider tenant.

readProviderTenant

String readProviderTenant()

Returns:

The tenant identifier of the tenant that provides this application. In single tenant scenario the value null is returned.