com.sap.cloud.sdk.frameworks.liquibase

Class SchemaPerTenantProvisioner

java.lang.Object

com.sap.cloud.sdk.frameworks.liquibase.SchemaPerTenantProvisioner

public class SchemaPerTenantProvisioner
extends Object

This class provides helper methods with the default implementation of the tenant on-boarding and off-boarding for schema per tenant multi-tenancy. JDBC connection and a path to a liquibase configuration file for a database schema migration need to be passed during initialization.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SCHEMA_PREFIX

Constructor Summary

Constructors

Constructor and Description
SchemaPerTenantProvisioner(Connection connection, String liquibaseConfigPath) Initializes the new instance based on the given JDBC connections and the path to a liquibase configuration file.
SchemaPerTenantProvisioner(Connection connection, String liquibaseConfigPath, String schemaPrefix) Initializes the new instance based on the given JDBC connections, the path to a liquibase configuration file, and the schema prefix given.

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Connection	getConnection()
String	getLiquibaseConfigPath()
com.sap.cloud.sdk.frameworks.liquibase.NameSanitizer	getNameSanitizer()
String	getSchemaPrefix()
int	hashCode()
void	subscribeTenant(String tenantId) This method provides the default implementation for the tenant onboarding for a given tenantId.
String	toString()
void	unsubscribeTenant(String tenantId) This method provides the default implementation for the tenant offboarding for a given tenantId.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SCHEMA_PREFIX

public static final String DEFAULT_SCHEMA_PREFIX

See Also:

Constant Field Values

Constructor Detail

SchemaPerTenantProvisioner

public SchemaPerTenantProvisioner(Connection connection,
                                  String liquibaseConfigPath)

Initializes the new instance based on the given JDBC connections and the path to a liquibase configuration file.

The default prefix for the schema used by this constructor is stored in DEFAULT_SCHEMA_PREFIX.

Parameters:

connection - The JDBC connection to the database to be managed.

liquibaseConfigPath - The path to a liquibase configuration file containing the schema to use.

SchemaPerTenantProvisioner

public SchemaPerTenantProvisioner(Connection connection,
                                  String liquibaseConfigPath,
                                  @Nullable
                                  String schemaPrefix)

Initializes the new instance based on the given JDBC connections, the path to a liquibase configuration file, and the schema prefix given.

Parameters:

connection - The JDBC connection to the database to be managed.

liquibaseConfigPath - The path to a liquibase configuration file containing the schema to use.

schemaPrefix - The prefix to be used for the name of each tenant schema.

Method Detail

subscribeTenant

public void subscribeTenant(String tenantId)
                     throws IllegalArgumentException,
                            SQLException,
                            liquibase.exception.LiquibaseException

This method provides the default implementation for the tenant onboarding for a given tenantId. The method creates a database schema for a tenantId based on a given connection and liquibase configuration. In this default implementation, the name of the schema is equal to tenantId. The tenant id may only contain alphanumerical characters as well as '_' and '-'.

Parameters:

tenantId - The id of the tenant to build the schema for.

Throws:

IllegalArgumentException - If the constructed schema name contains invalid characters.

SQLException - If there was a problem during the creation of the schema.

liquibase.exception.LiquibaseException - If there was a problem while applying the liquibase configuration.

unsubscribeTenant

public void unsubscribeTenant(String tenantId)
                       throws IllegalArgumentException,
                              SQLException

This method provides the default implementation for the tenant offboarding for a given tenantId. It removes a corresponding database schema and all related tables. The tenant id may only contain alphanumerical characters as well as '_' and '-'.

Parameters:

tenantId - The id of the tenant to drop the schema for.

Throws:

IllegalArgumentException - If the constructed schema name contains invalid characters.

SQLException - If there was a problem with the SQL command.

getNameSanitizer

public com.sap.cloud.sdk.frameworks.liquibase.NameSanitizer getNameSanitizer()

getConnection

public Connection getConnection()

getLiquibaseConfigPath

public String getLiquibaseConfigPath()

getSchemaPrefix

public String getSchemaPrefix()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object