com.goldencode.p2j.persist.orm

Class TenantManager.Tenant

java.lang.Object

com.goldencode.p2j.persist.orm.TenantManager.Tenant

Enclosing class:

TenantManager

public static class TenantManager.Tenant
extends java.lang.Object

Inner class responsible with storing information about a tenant.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,TenantDatabaseDescriptor>	dbLogicalInstances A map that stores database settings for a specific database based on the database logical name.
private java.util.Map<java.lang.String,TenantDatabaseDescriptor>	dbPhysicalInstances A map that stores database settings for a specific database based on the database physical name.
private boolean	status The status of the tenant (enabled/disabled).
private java.util.UUID	tenantId The tenant ID.
private java.lang.String	tenantName The name of the tenant.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Tenant(java.lang.String tenantName, java.util.List<TenantDatabaseDescriptor> databases) Constructor that generates a random UUID for the tenant.
private	Tenant(TenantManager.Tenant other) Copy constructor.
private	Tenant(java.util.UUID tenantId, java.lang.String tenantName, java.util.List<TenantDatabaseDescriptor> databases) Constructor that sets all the fields required by a tenant, including the tenant id UUID.

Method Summary

Modifier and Type	Method and Description
private void	addDatabaseInstance(java.lang.String pdbName, TenantDatabaseDescriptor db) Add a database configuration for this tenant.
java.util.Map<java.lang.String,TenantDatabaseDescriptor>	getDatabaseCredentials() Get all the database settings/credentials assigned to this tenant.
TenantDatabaseDescriptor	getDatabaseCredentials(java.lang.String dbName, boolean physical) Get the database settings/credentials of a given database.
java.util.UUID	getId() Getter for the tenant ID.
boolean	getStatus() Getter for the status field (enabled/disabled).
java.lang.String	getTenantName() Getter for the tenant name.
private void	removeDatabaseInstance(java.lang.String pdbName) Remove the database configuration for this tenant.
void	setField(java.lang.String pdbName, java.lang.String fieldName, java.lang.String value) Set a specific field for this tenant.
void	setStatus(boolean value) Setter for the status field.

Methods inherited from class java.lang.Object

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

Field Detail

tenantId

private final java.util.UUID tenantId

The tenant ID.

tenantName

private java.lang.String tenantName

The name of the tenant.

dbPhysicalInstances

private java.util.Map<java.lang.String,TenantDatabaseDescriptor> dbPhysicalInstances

A map that stores database settings for a specific database based on the database physical name.

dbLogicalInstances

private java.util.Map<java.lang.String,TenantDatabaseDescriptor> dbLogicalInstances

A map that stores database settings for a specific database based on the database logical name.

status

private boolean status

The status of the tenant (enabled/disabled).

Constructor Detail

Tenant

private Tenant(java.lang.String tenantName,
               java.util.List<TenantDatabaseDescriptor> databases)

Constructor that generates a random UUID for the tenant.

Parameters:

tenantName - The name of the tenant.

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

Tenant

private Tenant(java.util.UUID tenantId,
               java.lang.String tenantName,
               java.util.List<TenantDatabaseDescriptor> databases)

Constructor that sets all the fields required by a tenant, including the tenant id UUID.

Parameters:

tenantId - The ID of the tenant.

tenantName - The name of the tenant.

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

Tenant

private Tenant(TenantManager.Tenant other)

Copy constructor.

Parameters:

other - The other instance from which to copy the information.

Method Detail

getTenantName

public java.lang.String getTenantName()

Getter for the tenant name.

Returns:

The name of this tenant.

getDatabaseCredentials

public TenantDatabaseDescriptor getDatabaseCredentials(java.lang.String dbName,
                                                       boolean physical)

Get the database settings/credentials of a given database.

Parameters:

dbName - The name of the database for which to retrieve the information.

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

Returns:

A TenantDatabaseDescriptor that stores the information for the given database.

getDatabaseCredentials

public java.util.Map<java.lang.String,TenantDatabaseDescriptor> getDatabaseCredentials()

Get all the database settings/credentials assigned to this tenant.

Returns:

A map with the information for all the databases.

getId

public java.util.UUID getId()

Getter for the tenant ID.

Returns:

The ID used by this tenant.

getStatus

public boolean getStatus()

Getter for the status field (enabled/disabled).

Returns:

true if the tenant is enabled, false otherwise.

setField

public void setField(java.lang.String pdbName,
                     java.lang.String fieldName,
                     java.lang.String value)

Set a specific field for this tenant. Possible values for the fieldName parameter are:

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

Parameters:

pdbName - The physical name of the database for which to perform the update.

fieldName - The name of the field to be updated.

value - The new value for the given field.

setStatus

public void setStatus(boolean value)

Setter for the status field. A value of true denotes the enabling of this tenant, while false denotes disabling this tenant.

Parameters:

value - The new value for the status field.

addDatabaseInstance

private void addDatabaseInstance(java.lang.String pdbName,
                                 TenantDatabaseDescriptor db)

Add a database configuration for this tenant.

Parameters:

pdbName - The physical name of the database.

db - The database information to be added.

removeDatabaseInstance

private void removeDatabaseInstance(java.lang.String pdbName)

Remove the database configuration for this tenant.

Parameters:

pdbName - The physical name of the database for which to remove the configuration.