com.goldencode.p2j.persist.orm

Class TenantManager

java.lang.Object

com.goldencode.p2j.persist.orm.TenantManager

public class TenantManager
extends java.lang.Object

Class responsible with handling tenants.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TenantManager.Tenant Inner class responsible with storing information about a tenant.
private static class	TenantManager.TenantSQL Inner class responsible with storing SQLs that will be further used to manage tenants.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.sql.PreparedStatement	addTenantDatabasesStmt PreparedStatement for adding a database to a tenant.
private static java.sql.PreparedStatement	addTenantStmt PreparedStatement for adding a tenant.
private static java.sql.Connection	conn Active JDBC connection of the landlord database.
private static java.lang.String	DEFAULT_TENANT_NAME The name of the default tenant.
private static java.sql.PreparedStatement	deleteTenantDatabasesStmt PreparedStatement for deleting all the databases of a certain tenant.
private static java.sql.PreparedStatement	deleteTenantDatabaseStmt PreparedStatement for deleting a database of a certain tenant.
private static java.sql.PreparedStatement	deleteTenantStmt PreparedStatement for deleting a tenant.
private static java.sql.PreparedStatement	enableTenantStmt PreparedStatement for enabling/disabling a tenant.
private static boolean	init Flag for determining if this class has been initialized or not.
private static java.sql.PreparedStatement	isTenantEnabledStmt PreparedStatement for checking if a tenant is enabled or not.
private static java.lang.Object	lock The lock used to synchronize calls.
private static CentralLogger	LOG Logger
private static java.sql.PreparedStatement	selectTenantDatabasesStmt PreparedStatement for selecting all the databases of a certain tenant.
private static java.sql.PreparedStatement	selectTenantDatabaseStmt PreparedStatement for selecting a database of a certain tenant.
private static java.util.Map<java.lang.String,TenantManager.Tenant>	tenants Map for retrieving a tenant based on its id.
private static java.util.Map<java.lang.String,java.sql.PreparedStatement>	updateStmts Map of update statements for the master table based on the column name given.

Constructor Summary

Constructors

Constructor and Description
TenantManager() Default constructor.

Method Summary

Modifier and Type	Method and Description
static void	addDatabaseToDefaultTenant(TenantDatabaseDescriptor db) Add a database to the default tenant.
static boolean	addDatabaseToTenant(java.lang.String tenantName, TenantDatabaseDescriptor db) Function for adding a database instance to a tenant.
private static void	addDefaultTenant() Method used for initializing the default tenant.
static boolean	addTenant(java.lang.String tenantName, java.util.List<TenantDatabaseDescriptor> databases) Insert a tenant into the master table.
static boolean	changeTenantStatus(java.lang.String tenantName, boolean enable) Enable/Disable a specific tenant.
private static void	connectAll() Method for logically connecting the tenants to their databases.
private static void	connectTenantImpl(TenantManager.Tenant tenant) Logically connect the tenant to its respective databases.
private static void	createTables() Method used for executing SQLs in order to create the required tables in the landlord database.
static boolean	deleteDatabaseFromTenant(java.lang.String tenantName, java.lang.String pdbName) Delete a database instance that is assigned to a tenant.
static boolean	deleteTenant(java.lang.String tenantName) Function for deleting a tenant from the master table.
static void	enable() Enable the support for multi-tenancy.
static Database	getDatabase(java.lang.String tenantName, java.lang.String dbName, boolean physical) Get the database instance of a tenant based on the tenant name and the database physical name.
static java.util.List<java.lang.String>	getDatabaseSettings(java.lang.String tenantName, java.lang.String pdbName) Get the database settings of a specific database of a specific tenant.
static java.lang.String	getDefaultTenantName() Get the name of the default tenant.
static TenantManager.Tenant	getTenant(java.lang.String tenantName) Get a tenant from the tenants map.
static java.lang.String	getTenantName(java.lang.String domainName, java.lang.String ldbName) Retrieve the tenant name from the given domain.
static void	initialize(java.lang.String landlordURL) Initialize multi-tenancy.
private static void	initializeStatements() Initialize the tenant managing statements.
static boolean	isTenantEnabled(java.lang.String tenantName) Check if a specific tenant is enabled or not.
static java.util.List<TenantManager.Tenant>	listTenants() Get a list with all the tenants.
static void	readDomains(java.lang.String ldbName, SecurityOps.WorkArea wa) Method that reads the domains from the authentication tables and adds them into the given context.
static boolean	updateTenant(java.lang.String tenantName, java.lang.String pdbName, java.util.Map<java.lang.String,java.lang.String> values) Update a tenant from the master table.
private static boolean	updateTenantImpl(java.lang.String tenantName, java.lang.String pdbName, java.lang.String column, java.lang.String newValue) Update a tenant from the master table.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

Logger

DEFAULT_TENANT_NAME

private static final java.lang.String DEFAULT_TENANT_NAME

The name of the default tenant.

See Also:

Constant Field Values

lock

private static final java.lang.Object lock

The lock used to synchronize calls.

conn

private static java.sql.Connection conn

Active JDBC connection of the landlord database.

tenants

private static java.util.Map<java.lang.String,TenantManager.Tenant> tenants

Map for retrieving a tenant based on its id.

updateStmts

private static java.util.Map<java.lang.String,java.sql.PreparedStatement> updateStmts

Map of update statements for the master table based on the column name given.

addTenantStmt

private static java.sql.PreparedStatement addTenantStmt

PreparedStatement for adding a tenant.

addTenantDatabasesStmt

private static java.sql.PreparedStatement addTenantDatabasesStmt

PreparedStatement for adding a database to a tenant.

selectTenantDatabaseStmt

private static java.sql.PreparedStatement selectTenantDatabaseStmt

PreparedStatement for selecting a database of a certain tenant.

selectTenantDatabasesStmt

private static java.sql.PreparedStatement selectTenantDatabasesStmt

PreparedStatement for selecting all the databases of a certain tenant.

enableTenantStmt

private static java.sql.PreparedStatement enableTenantStmt

PreparedStatement for enabling/disabling a tenant.

isTenantEnabledStmt

private static java.sql.PreparedStatement isTenantEnabledStmt

PreparedStatement for checking if a tenant is enabled or not.

deleteTenantStmt

private static java.sql.PreparedStatement deleteTenantStmt

PreparedStatement for deleting a tenant.

deleteTenantDatabaseStmt

private static java.sql.PreparedStatement deleteTenantDatabaseStmt

PreparedStatement for deleting a database of a certain tenant.

deleteTenantDatabasesStmt

private static java.sql.PreparedStatement deleteTenantDatabasesStmt

PreparedStatement for deleting all the databases of a certain tenant.

init

private static volatile boolean init

Flag for determining if this class has been initialized or not.

Constructor Detail

TenantManager

public TenantManager()

Default constructor.

Method Detail

enable

public static void enable()

Enable the support for multi-tenancy. This process also involves creating the default tenant.

initialize

public static void initialize(java.lang.String landlordURL)

Initialize multi-tenancy. This process involves:

1. Creating the required tables if they don't already exist.
2. Initializing the statements that can be of type prepared.
3. Logically connecting the tenants that are stored in the master table.

Parameters:

landlordURL - The URL of the landlord database.

listTenants

public static java.util.List<TenantManager.Tenant> listTenants()

Get a list with all the tenants.

Returns:

A list with the registered tenants.

addTenant

public static boolean addTenant(java.lang.String tenantName,
                                java.util.List<TenantDatabaseDescriptor> databases)

Insert a tenant into the master table.

Parameters:

tenantName - The name of the tenant.

databases - A list of the databases that will be used by the tenant.

Returns:

true if the operation is performed successfully, false otherwise.

addDatabaseToTenant

public static boolean addDatabaseToTenant(java.lang.String tenantName,
                                          TenantDatabaseDescriptor db)

Function for adding a database instance to a tenant.

Parameters:

tenantName - The tenant for which to add the database instance.

db - The database information to be added.

Returns:

true if the operation is performed successfully, false otherwise.

addDatabaseToDefaultTenant

public static void addDatabaseToDefaultTenant(TenantDatabaseDescriptor db)

Add a database to the default tenant.

Parameters:

db - The database descriptor which stores information about the database to be added.

updateTenant

public static boolean updateTenant(java.lang.String tenantName,
                                   java.lang.String pdbName,
                                   java.util.Map<java.lang.String,java.lang.String> values)

Update a tenant from the master table. This method allows one or multiple column values to be edited. Possible column values/names are:

• tenant_name - the name of the tenant.
• db_name - the name of a database instance that this tenant uses.
• url - the URL of a database instance.
• username - the username required in order to access a database instance.
• password - the password required in order to access a database instance.

Parameters:

tenantName - The name of the tenant that is targeted by the update.

pdbName - The physical name of the database that is targeted by the update.

values - A Map with pairs (column name - new value) that are intended for the update.

Returns:

true if all the updates are performed successfully, false if there is at least an update that fails.

deleteTenant

public static boolean deleteTenant(java.lang.String tenantName)

Function for deleting a tenant from the master table.

Parameters:

tenantName - The name of the tenant that is targeted by the delete.

Returns:

true if the operation was successful, false otherwise.

deleteDatabaseFromTenant

public static boolean deleteDatabaseFromTenant(java.lang.String tenantName,
                                               java.lang.String pdbName)

Delete a database instance that is assigned to a tenant.

Parameters:

tenantName - The tenant for which to remove the database instance.

pdbName - The database physical name of the database to be deleted.

Returns:

true if the operation was successful, false otherwise.

changeTenantStatus

public static boolean changeTenantStatus(java.lang.String tenantName,
                                         boolean enable)

Enable/Disable a specific tenant.

Parameters:

tenantName - The tenant to work with.

enable - true if the intent is to enable the tenant, false otherwise.

Returns:

true if the operation is performed successfully, false otherwise.

isTenantEnabled

public static boolean isTenantEnabled(java.lang.String tenantName)

Check if a specific tenant is enabled or not.

Parameters:

tenantName - The tenant to work with.

Returns:

true if the tenant is enabled, false otherwise.

getTenant

public static TenantManager.Tenant getTenant(java.lang.String tenantName)

Get a tenant from the tenants map.

Parameters:

tenantName - The name of the tenant.

Returns:

The instance of Tenant that holds other information.

getDatabase

public static Database getDatabase(java.lang.String tenantName,
                                   java.lang.String dbName,
                                   boolean physical)

Get the database instance of a tenant based on the tenant name and the database physical name.

Parameters:

tenantName - The name of the tenant for which to retrieve the database.

dbName - The name of the database instance to be retrieved.

physical - true if the given database name is the physical one, false if the database name is the logical one.

Returns:

The database instance, if it exists.

getDatabaseSettings

public static java.util.List<java.lang.String> getDatabaseSettings(java.lang.String tenantName,
                                                                   java.lang.String pdbName)

Get the database settings of a specific database of a specific tenant.

Parameters:

tenantName - The tenant to work with.

pdbName - The database physical name for which to retrieve the settings.

Returns:

A list with the database settings.

readDomains

public static void readDomains(java.lang.String ldbName,
                               SecurityOps.WorkArea wa)
                        throws java.sql.SQLException

Method that reads the domains from the authentication tables and adds them into the given context.

Parameters:

ldbName - The logical database name used when adding a domain.

wa - The context in which to add the domains.

Throws:

java.sql.SQLException

getTenantName

public static java.lang.String getTenantName(java.lang.String domainName,
                                             java.lang.String ldbName)

Retrieve the tenant name from the given domain.

Parameters:

domainName - The name of the domain from which to retrieve the tenant name.

ldbName - The logical name of the database.

Returns:

The name of the tenant that was assigned to the given domain.

getDefaultTenantName

public static java.lang.String getDefaultTenantName()

Get the name of the default tenant.

Returns:

The default tenant name.

initializeStatements

private static void initializeStatements()
                                  throws java.sql.SQLException

Initialize the tenant managing statements.

Throws:

java.sql.SQLException

createTables

private static void createTables()
                          throws java.sql.SQLException

Method used for executing SQLs in order to create the required tables in the landlord database.

Throws:

java.sql.SQLException

addDefaultTenant

private static void addDefaultTenant()

Method used for initializing the default tenant.

connectAll

private static void connectAll()
                        throws java.sql.SQLException

Method for logically connecting the tenants to their databases.

Throws:

java.sql.SQLException

connectTenantImpl

private static void connectTenantImpl(TenantManager.Tenant tenant)

Logically connect the tenant to its respective databases.

Parameters:

tenant - The tenant to be connected to the database.

updateTenantImpl

private static boolean updateTenantImpl(java.lang.String tenantName,
                                        java.lang.String pdbName,
                                        java.lang.String column,
                                        java.lang.String newValue)

Update a tenant from the master table.

Parameters:

tenantName - The name of the tenant that is targeted by the update.

pdbName - The physical name of the database that is targeted by the update.

column - The column that will be updated.

newValue - The value that will replace the one from the table.

Returns:

true if the operation was successful, false otherwise.