com.sap.cloud.sdk.cloudplatform.tenant

Class TenantAccessor

java.lang.Object

com.sap.cloud.sdk.cloudplatform.tenant.TenantAccessor

public final class TenantAccessor
extends Object

Constructor Summary

Constructors

Constructor and Description
TenantAccessor()

Method Summary

Modifier and Type	Method and Description
static Tenant	getCurrentTenant() Returns the current Tenant.
static Optional<Tenant>	getCurrentTenantIfAvailable() Returns the current Tenant, if available.
static TenantFacade	getTenantFacade() The TenantFacade instance.
static void	setTenantFacade(TenantFacade tenantFacade) Replaces the default TenantFacade instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

TenantAccessor

public TenantAccessor()

Method Detail

setTenantFacade

public static void setTenantFacade(@Nonnull
                                   TenantFacade tenantFacade)

Replaces the default TenantFacade instance. This method is for internal use only.

getCurrentTenant

@Nonnull
public static 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 the availability of a tenant, refer to getCurrentTenantIfAvailable().

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

getCurrentTenantIfAvailable

@Nonnull
public static 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.

getTenantFacade

@Nullable
public static TenantFacade getTenantFacade()

The TenantFacade instance. For internal use only.