com.sap.cloud.sdk.cloudplatform.tenant

Class AbstractTenantFacade

java.lang.Object

com.sap.cloud.sdk.cloudplatform.tenant.AbstractTenantFacade

All Implemented Interfaces:

TenantFacade

Direct Known Subclasses:

ScpCfTenantFacade, ScpNeoTenantFacade

public abstract class AbstractTenantFacade
extends Object
implements TenantFacade

Abstract base class for TenantFacades which allows to use a mocked Tenant if the environment variable "USE_MOCKED_TENANT" is set to "true".

Constructor Summary

Constructors

Constructor and Description
AbstractTenantFacade()

Method Summary

Modifier and Type	Method and Description
Tenant	getCurrentTenant() Returns the current Tenant.
Optional<Tenant>	getCurrentTenantIfAvailable() Returns the current Tenant, if available.
Optional<Tenant>	getMockedTenant() Returns a mocked Tenant, if the environment variable "USE_MOCKED_TENANT" is set to "true".
protected abstract Tenant	newMockedTenant() Instantiates a mocked Tenant.
io.vavr.control.Try<Tenant>	tryGetCurrentTenant() Returns a Try for the current Tenant.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sap.cloud.sdk.cloudplatform.tenant.TenantFacade

getTenantClass, resolveCurrentTenant

Constructor Detail

AbstractTenantFacade

public AbstractTenantFacade()

Method Detail

newMockedTenant

@Nonnull
protected abstract Tenant newMockedTenant()

Instantiates a mocked Tenant.

Returns:

A new mocked Tenant.

getMockedTenant

@Nonnull
public Optional<Tenant> getMockedTenant()

Returns a mocked Tenant, if the environment variable "USE_MOCKED_TENANT" is set to "true".

Returns:

The mocked Tenant, if present.

getCurrentTenant

@Nonnull
public Tenant getCurrentTenant()
                                 throws TenantNotAvailableException,
                                        TenantAccessException

Returns the current Tenant.

Specified by:

getCurrentTenant in interface TenantFacade

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 TenantFacade.getCurrentTenantIfAvailable().

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

getCurrentTenantIfAvailable

@Nonnull
public 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". As a fallback a JWT will be retrieved from a bound XSUAA instance.	A request is not available, no "Authorization" header is present in the current request, the JWT bearer does not hold a field "zid", or there is no XSUAA service bound to this application.
SAP Cloud Platform Neo	Successful JNDI lookup of TenantContext.	Never. If correctly configured, a TenantContext is always available. If not, a TenantAccessException is thrown.

Specified by:

getCurrentTenantIfAvailable in interface TenantFacade

Returns:

An Optional of the current Tenant.

Throws:

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

tryGetCurrentTenant

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

Returns a Try for the current Tenant.

Specified by:

tryGetCurrentTenant in interface TenantFacade

Returns:

A Try for the current Tenant.