com.sap.cloud.sdk.cloudplatform.tenant

Class ScpNeoTenantFacade

java.lang.Object

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

com.sap.cloud.sdk.cloudplatform.tenant.ScpNeoTenantFacade

All Implemented Interfaces:

TenantFacade, WithRuntimeDependencies

public class ScpNeoTenantFacade
extends AbstractTenantFacade
implements WithRuntimeDependencies

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

Constructor Summary

Constructors

Constructor and Description
ScpNeoTenantFacade()

Method Summary

Modifier and Type	Method and Description
void	assertRuntimeDependenciesExist() Asserts that required runtime dependencies are available on the class path.
Class<ScpNeoTenant>	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

ScpNeoTenantFacade

public ScpNeoTenantFacade()

Method Detail

getTenantClass

@Nonnull
public Class<ScpNeoTenant> getTenantClass()

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

Specified by:

getTenantClass in interface TenantFacade

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.

assertRuntimeDependenciesExist

public void assertRuntimeDependenciesExist()
                                    throws DependencyNotFoundException

Asserts that required runtime dependencies are available on the class path.

Specified by:

assertRuntimeDependenciesExist in interface WithRuntimeDependencies

Throws:

DependencyNotFoundException - If a required runtime dependency is not available.

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.

Specified by:

resolveCurrentTenant in interface TenantFacade

Returns:

An Optional of the current Tenant.

Throws:

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

See Also:

TenantRequestContextListener