TenantConfig.java

/*
** Module   : TenantConfig.java
** Abstract : Class that stores multi-tenancy configuration information
**
** Copyright (c) 2024-2025, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 RAA 20240423 Created initial version.
**     RAA 20240702 Removed logging as it was not required here.
**     RAA 20240710 Added database parameter to initialize.
**     RAA 20240717 Adjusted the way initialization takes place.
**     RAA 20240719 If landlord database URL is null, honor single-tenant mode.
**     RAA 20240723 Surrounded landlordURL initialization with try-finally block.
**     RAA 20240807 Split initialization method into two: enable and initialize.
** 002 OM  20250116 Added support for additional dialects for landlord database.
** 003 OM  20250320 Added isActive() method.
*/

/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
** 
** Additional terms under GNU Affero GPL version 3 section 7:
** 
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
** 
**   0. Attribution Requirement.
** 
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
** 
**   1. No License To Use Trademarks.
** 
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
** 
**   2. No Misrepresentation of Affiliation.
** 
**     You may not represent yourself as Golden Code Development Corporation or FWD.
** 
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
** 
**   3. No Misrepresentation of Source or Origin.
** 
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/

package com.goldencode.p2j.persist.orm;

import com.goldencode.p2j.directory.DirectoryService;
import com.goldencode.p2j.util.Utils;

/**
 * Class that stores information regarding the multi-tenancy configuration.
 */
public class TenantConfig
{
   /** Flag that denotes if multi-tenancy configuration has already been initialized. */
   private static boolean alreadyInitialized = false;
   
   /** Flag that denotes if multi-tenancy is enabled. */
   private static boolean enabled = false;
   
   /** The JDBC URL to the landlord database. */
   private static String landlordURL = null;
   
   /** The JDBC User for access to the landlord database. */
   private static String landlordUser = null;
   
   /** The JDBC Password for access to the landlord database. */
   private static String landlordPassword = null;
   
   /**
    * Default constructor.
    */
   public TenantConfig()
   {
   }
   
   /**
    * Enable the support for multi-tenancy. This involves gathering from the directory the URL
    * of the landlord database.
    */
   public static void enableMultiTenancy()
   {
      if (alreadyInitialized)
      {
         return;
      }
      
      DirectoryService ds = DirectoryService.getInstance();
      if (!ds.bind())
      {
         throw new RuntimeException("Directory bind failed");
      }
      
      try
      {
         landlordURL = Utils.getDirectoryNodeString(ds, "persistence/landlord_database_url", null, false);
         if (landlordURL != null)
         {
            landlordUser = 
                  Utils.getDirectoryNodeString(ds, "persistence/landlord_database_user", null, false);
            landlordPassword = 
                  Utils.getDirectoryNodeString(ds, "persistence/landlord_database_password", null, false);
         }
      }
      finally
      {
         ds.unbind();
      }
      
      alreadyInitialized = true;
      if (landlordURL == null)
      {
         return;
      }
      
      TenantManager.enable();
      enabled = true;
   }
   
   /**
    * Initialize the required components of multi-tenancy.
    */
   public static void initialize()
   {
      if (!enabled)
      {
         return;
      }
      
      TenantManager.initialize(landlordURL, landlordUser, landlordPassword);
   }
   
   /**
    * Getter for the {@code enabled} field.
    * 
    * @return  {@code true} if multi-tenancy is enabled, {@code false} otherwise.
    */
   public static boolean isEnabled()
   {
      return enabled;
   }
   
   /**
    * Check whether the multi-tenancy is active..
    * 
    * @return  {@code true} if multi-tenancy is active, {@code false} otherwise.
    */
   public static boolean isActive()
   {
      return landlordURL != null;
   }
}