com.sap.cloud.sdk.cloudplatform.tenant

Interface TenantFacade

All Known Implementing Classes:

AbstractTenantFacade, ScpCfTenantFacade, ScpNeoTenantFacade

public interface TenantFacade

Facade interface encapsulating the logic to access Tenant information.

Method Summary

Modifier and Type	Method and Description
Tenant	getCurrentTenant() Returns the current Tenant.
Optional<Tenant>	getCurrentTenantIfAvailable() Returns the current Tenant, if available.
Class<? extends Tenant>	getTenantClass() Returns the platform-specific implementation class of Tenant.
Optional<Tenant>	resolveCurrentTenant() Resolves the current Tenant using the platform-specific lookup.
io.vavr.control.Try<Tenant>	tryGetCurrentTenant() Returns a Try for the current Tenant.

Method Detail

getTenantClass

@Nonnull
Class<? extends Tenant> getTenantClass()

Returns the platform-specific implementation class of Tenant. For internal use only.

Returns:

The type of the platform-specific implementation.

resolveCurrentTenant

@Nonnull
Optional<Tenant> resolveCurrentTenant()
                                        throws TenantAccessException

Resolves the current Tenant using the platform-specific lookup. For more details on the availability of a tenant, refer to getCurrentTenantIfAvailable().

For internal use only.

Caution: This method must only be invoked within the container-managed thread of a request.

Returns:

An Optional of the current Tenant.

Throws:

TenantAccessException - If there is an issue while resolving the Tenant.

See Also:

TenantRequestContextListener

getCurrentTenant

@Nonnull
Tenant getCurrentTenant()
                          throws TenantNotAvailableException,
                                 TenantAccessException

Returns the current Tenant.

Returns:

The current Tenant.

Throws:

TenantNotAvailableException - If there is currently no Tenant available. This typically occurs when trying to access the tenant within code that is running outside any tenant context, e.g., within a background task. For more details on how the availability of a tenant is defined, refer to getCurrentTenantIfAvailable().

TenantAccessException - If there is an issue while accessing the Tenant.

getCurrentTenantIfAvailable

@Nonnull
Optional<Tenant> getCurrentTenantIfAvailable()
                                               throws TenantAccessException

Returns the current Tenant, if available.

The availability of the tenant is defined as follows:

	Tenant available	Tenant not available
SAP Cloud Platform Cloud Foundry	A request is present with an "Authorization" header that contains a valid JWT bearer with field "zid".	A request is not available, no "Authorization" header is present in the current request, or the JWT bearer does not hold a field "zid".
SAP Cloud Platform Neo	Successful JNDI lookup of TenantContext.	Never. If correctly configured, a TenantContext is always available. If not, a TenantAccessException is thrown.

Returns:

An Optional of the current Tenant.

Throws:

TenantAccessException - If there is an issue while accessing the Tenant.

tryGetCurrentTenant

@Nonnull
io.vavr.control.Try<Tenant> tryGetCurrentTenant()

Returns a Try for the current Tenant.

Returns:

A Try for the current Tenant.