com.sap.cloud.sdk.cloudplatform.tenant

Class ScpCfTenantFacade

java.lang.Object

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

com.sap.cloud.sdk.cloudplatform.tenant.ScpCfTenantFacade

All Implemented Interfaces:

TenantFacade

public class ScpCfTenantFacade
extends AbstractTenantFacade

Facade providing access to tenant information on SAP Cloud Platform Cloud Foundry.

Constructor Summary

Constructors

Constructor and Description
ScpCfTenantFacade()

Method Summary

Modifier and Type	Method and Description
protected Optional<Tenant>	getMockedTenantAsFallback() Returns a mocked Tenant as fallback, if the environment variable "ALLOW_MOCKED_AUTH_HEADER" is set to "true".
Class<ScpCfTenant>	getTenantClass() Returns the platform-specific implementation class of Tenant.
protected Tenant	newMockedTenant() Instantiates a mocked Tenant.
Optional<Tenant>	resolveCurrentTenant() Resolves the current Tenant using the platform-specific lookup.

Methods inherited from class com.sap.cloud.sdk.cloudplatform.tenant.AbstractTenantFacade

getCurrentTenant, getCurrentTenantIfAvailable, getMockedTenant

Methods inherited from class java.lang.Object

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

Constructor Detail

ScpCfTenantFacade

public ScpCfTenantFacade()

Method Detail

getTenantClass

@Nonnull
public Class<ScpCfTenant> getTenantClass()

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

Returns:

The type of the platform-specific implementation.

newMockedTenant

@Nonnull
protected Tenant newMockedTenant()

Instantiates a mocked Tenant.

Specified by:

newMockedTenant in class AbstractTenantFacade

Returns:

A new mocked Tenant.

getMockedTenantAsFallback

@Nonnull
protected Optional<Tenant> getMockedTenantAsFallback()

Returns a mocked Tenant as fallback, if the environment variable "ALLOW_MOCKED_AUTH_HEADER" is set to "true".

Returns:

The mocked Tenant.

resolveCurrentTenant

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