SettingsMigration.java

package org.exoplatform.commons.migration;

import static java.lang.Math.max;

import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import java.util.concurrent.Callable;

import javax.servlet.ServletContext;

import org.exoplatform.commons.api.persistence.ExoTransactional;
import org.exoplatform.commons.api.settings.SettingValue;
import org.exoplatform.commons.api.settings.data.Context;
import org.exoplatform.commons.api.settings.data.Scope;
import org.exoplatform.commons.chromattic.ChromatticLifeCycle;
import org.exoplatform.commons.chromattic.ChromatticManager;
import org.exoplatform.commons.chromattic.SessionContext;
import org.exoplatform.commons.cluster.StartableClusterAware;
import org.exoplatform.commons.notification.impl.AbstractService;
import org.exoplatform.commons.utils.CommonsUtils;
import org.exoplatform.commons.utils.ListAccess;
import org.exoplatform.commons.utils.RDBMSMigrationUtils;
import org.exoplatform.container.ExoContainer;
import org.exoplatform.container.ExoContainerContext;
import org.exoplatform.container.PortalContainer;
import org.exoplatform.container.RootContainer;
import org.exoplatform.container.component.RequestLifeCycle;
import org.exoplatform.services.log.ExoLogger;
import org.exoplatform.services.log.Log;
import org.exoplatform.services.organization.OrganizationService;
import org.exoplatform.services.organization.User;
import org.exoplatform.services.organization.UserStatus;
import org.exoplatform.settings.chromattic.ScopeEntity;
import org.exoplatform.settings.chromattic.SimpleContextEntity;
import org.exoplatform.settings.chromattic.SubContextEntity;
import org.exoplatform.settings.chromattic.SynchronizationTask;
import org.exoplatform.settings.jpa.JPASettingServiceImpl;
import org.exoplatform.settings.jpa.JPAUserSettingServiceImpl;

public class SettingsMigration implements StartableClusterAware {

  private static final Log LOG = ExoLogger.getLogger(SettingsMigration.class);

  //Service
  private JPASettingServiceImpl jpaSettingService;
  private ChromatticLifeCycle chromatticLifeCycle;
  private OrganizationService organizationService;

  private static List<String> allUsers = new LinkedList<String>();
  private static List<String> errorUserSettings = new LinkedList<String>();
  private static List<String> errorGlobalSettings = new LinkedList<String>();
  private static List<String> nonRemovedGlobalSettings = new LinkedList<String>();
  private static List<String> nonRemovedUserSettings = new LinkedList<String>();
  //scope of user settings migration
  public static final String SETTINGS_MIGRATION_USER_KEY = "SETTINGS_MIGRATION_USER";
  //scope of global settings migration
  public static final String SETTINGS_MIGRATION_GLOBAL_KEY = "SETTINGS_MIGRATION_GLOBAL";
  //status of jcr user settings data (true if jcr user settings data is migrated)
  public static final String SETTINGS_JCR_DATA_USER_MIGRATED_KEY = "SETTINGS_JCR_DATA_USER_MIGRATED";
  //status of settings migration (true if migration completed successfully)
  public static final String SETTINGS_RDBMS_MIGRATION_DONE = "SETTINGS_RDBMS_MIGRATION_DONE";
  //status of settings cleanup from JCR (true if cleanup is completed successfully)
  public static final String SETTINGS_RDBMS_CLEANUP_DONE = "SETTINGS_RDBMS_CLEANUP_DONE";


  public SettingsMigration(ChromatticManager chromatticManager,
                           OrganizationService organizationService) {
    this.chromatticLifeCycle = (ChromatticLifeCycle) chromatticManager.getLifeCycle("setting");
    this.organizationService = organizationService;
  }

  @Override
  public void start() {
    if(getJpaSettingService() == null) {
      throw new IllegalStateException("Cannot find JPASettingServiceImpl service instance");
    }

    //First check to see if the JCR still contains settings data. If not, migration is skipped
    if (hasGlobalSettingsToMigrate()) {
      migrateGlobalSettings();
    } else {
      LOG.info("No global settings data to migrate from JCR to RDBMS");
    }
    if (hasUserSettingsToMigrate()) {
      migrateUserSettings();
    } else {
      LOG.info("No user settings data to migrate from JCR to RDBMS");
    }
  }

  public void cleanup() {
    PortalContainer.addInitTask(PortalContainer.getInstance().getPortalContext(), new RootContainer.PortalContainerPostInitTask() {
      @Override
      public void execute(ServletContext context, PortalContainer portalContainer) {
        //Deletion of settings data in JCR is done as a background task
        RDBMSMigrationUtils.getExecutorService().submit(new Callable<Void>() {
          @Override
          public Void call() throws Exception {
            PortalContainer currentContainer = PortalContainer.getInstance();
            ExoContainerContext.setCurrentContainer(currentContainer);
            RequestLifeCycle.begin(currentContainer);
            try {
              boolean globalSettingsCleaned = isGlobalSettingsCleanupDone();
              if (!globalSettingsCleaned) {
                LOG.info("=== Start cleaning Global Settings data from JCR");
                long startTime = System.currentTimeMillis();
                boolean successfulCleaning = deleteJcrGlobalSettings();
                long endTime = System.currentTimeMillis();
                if(successfulCleaning) {
                  setGlobalSettingsCleanupDone();
                  LOG.info("=== Global Settings JCR data cleaning due to RDBMS migration done in " + (endTime - startTime) + " ms");
                } else {
                  LOG.error("=== Global Settings JCR data cleaning due to RDBMS migration failed in " + (endTime - startTime) + " ms");
                }
              }
              boolean userSettingsCleaned = isUserSettingsCleanupDone();
              if(!userSettingsCleaned) {
                LOG.info("=== Start cleaning User Settings data from JCR");
                long startTime = System.currentTimeMillis();
                boolean successfulCleaning = deleteJcrUserSettings();
                long endTime = System.currentTimeMillis();
                if(successfulCleaning) {
                  setUserSettingsCleanupDone();
                  LOG.info("=== User Settings JCR data cleaning due to RDBMS migration done in " + (endTime - startTime) + " ms");
                } else {
                  LOG.error("=== User Settings JCR data cleaning due to RDBMS migration failed in " + (endTime - startTime) + " ms");
                }
                if (chromatticLifeCycle.getManager().getSynchronization() != null) {
                  chromatticLifeCycle.getManager().endRequest(true);
                }
              }
              if (!globalSettingsCleaned || !userSettingsCleaned) {
                reportSettingsMigration();
              }
            } catch (Exception e) {
              LOG.error("Error while cleaning Settings data from JCR", e);
            } finally {
              RequestLifeCycle.end();
            }
            return null;
          }
        });
      }
    });
  }

  private void reportSettingsMigration() {
    long notMigrated = getJpaSettingService().countSettingsByNameAndValueAndScope(Scope.APPLICATION.id(SETTINGS_MIGRATION_USER_KEY), SETTINGS_RDBMS_MIGRATION_DONE, "false");
    int error = errorUserSettings.size();
    LOG.info(" === User Settings Migration from JCR to RDBBMS report: ");
    LOG.info("           - " + max(notMigrated, error) + " User Settings nodes are not migrated to RDBMS ");
    LOG.info("           - " + nonRemovedUserSettings.size() + " User Settings nodes are migrated but not removed from JCR");
  }

  private Boolean deleteJcrGlobalSettings() {
    return new SynchronizationTask<Boolean>() {
      @Override
      protected Boolean execute(SessionContext ctx) {
        try {
          Set<String> globalSettings = getGlobalSettings();
          for (String scope : globalSettings) {
            if (!errorGlobalSettings.contains(scope)) {
              deleteGlobalSettings(scope);
            }
          }
          LOG.info(" === Global Settings Migration from JCR to RDBBMS report: ");
          LOG.info("           - " + globalSettings.size() + " Global Settings nodes are cleaned from JCR ");
          LOG.info("           - " + errorGlobalSettings.size() + " Global Settings nodes are not migrated to RDBMS ");
          LOG.info("           - " + nonRemovedGlobalSettings.size() + " Global Settings nodes are migrated but not removed from JCR");
          return true;
        } catch (Exception e) {
          LOG.error("Error while cleaning JCR global settings : " + e.getMessage(), e);
          return false;
        }
      }
    }.executeWith(chromatticLifeCycle);
  }

  private Boolean deleteJcrUserSettings() {
    try {
      PortalContainer currentContainer = PortalContainer.getInstance();
      ExoContainerContext.setCurrentContainer(currentContainer);

      RequestLifeCycle.begin(currentContainer);

      int deletedCounter = 0;
      Set<String> jcrSettingsToRemove = getJCRUserSettings();
      if(jcrSettingsToRemove != null) {
        int i = 0, totalSize = jcrSettingsToRemove.size();
        for (String user : jcrSettingsToRemove) {
          i++;
          try {
            // delete settings of users which have been migrated successfully or of non-existing users (deleted)
            if (!errorUserSettings.contains(user)
                    && (isSettingsMigrated(user) || organizationService.getUserHandler().findUserByName(user, UserStatus.ANY) == null)) {
              if (deleteUserSettings(user)) {
                deletedCounter++;
                getJpaSettingService().remove(Context.USER.id(user), Scope.APPLICATION.id(SETTINGS_MIGRATION_USER_KEY), SETTINGS_RDBMS_MIGRATION_DONE);
              }
            }
            if (i % 100 == 0) {
              LOG.info("User settings JCR cleanup - progression = {}/{}", i, totalSize);
              RequestLifeCycle.end();
              RequestLifeCycle.begin(currentContainer);
            }
          } catch (Exception e) {
            LOG.error("Error while cleaning settings of user " + user + " : " + e.getMessage(), e);
          }
        }
      }
      LOG.info(" === User settings Migration & Cleanup from JCR to RDBMS report: ");
      LOG.info("           - " + deletedCounter + " Users with settings are cleaned from JCR ");
      LOG.info("           - " + errorUserSettings.size() + " User settings nodes are not migrated to RDBMS ");
      LOG.info("           - " + nonRemovedUserSettings.size() + " Global Settings nodes are migrated but not removed from JCR");
      return true;
    } catch (Exception e) {
      LOG.error("Error while cleaning users settings : " + e.getMessage(), e);
      return false;
    } finally {
      RequestLifeCycle.end();
    }
  }
  private Boolean migrateGlobalSettings() {
    return new SynchronizationTask<Boolean>() {
      @Override
      protected Boolean execute(SessionContext ctx) {
        LOG.info("=== Start migration of Global Settings data from JCR to RDBMS");
        long startTime = System.currentTimeMillis();
        for (String scope : getGlobalSettings()) {
          migrateGlobalSettingsOfGlobalScopes(scope);
          migrateGlobalSettingsOfGlobalSpecificScopes(scope);
        }
        long endTime = System.currentTimeMillis();
        LOG.info("Global Settings data migrated in " + (endTime - startTime) + " ms");
        return true;
      }
    }.executeWith(chromatticLifeCycle);
  }

  private Boolean migrateUserSettings() {
    int pageSize = 20;
    int current = 0;
    try {
      ListAccess<User> allUsersListAccess = organizationService.getUserHandler().findAllUsers(UserStatus.ANY);
      ExoContainerContext.setCurrentContainer(PortalContainer.getInstance());
      int totalUsers = allUsersListAccess.getSize();
      LOG.info("    Number of users = " + totalUsers);
      User[] users;
      LOG.info("=== Start migration of User Settings data from JCR");
      ExoContainer currentContainer = ExoContainerContext.getCurrentContainer();
      RequestLifeCycle.begin(currentContainer);
      long startTime = System.currentTimeMillis();
      do {
        LOG.info("    Progression of users settings migration : {}/{} users", current, totalUsers);
        if (current + pageSize > totalUsers) {
          pageSize = totalUsers - current;
        }
        users = allUsersListAccess.load(current, pageSize);
        for (User user : users) {
          RequestLifeCycle.end();
          RequestLifeCycle.begin(currentContainer);
          String userName = user.getUserName();
          if (!isSettingsMigrated(userName)) {
            for (String userScope : getUserScopesSettings(userName)) {
              migrateUserSettingsOfGlobalScope(userName, userScope);
              migrateUserSettingsOfSpecificScope(userName, userScope);
            }
            allUsers.add(userName);
            if (errorUserSettings.contains(userName)) {
              getJpaSettingService().set(Context.USER.id(userName), Scope.APPLICATION.id(SETTINGS_MIGRATION_USER_KEY), SETTINGS_RDBMS_MIGRATION_DONE, SettingValue.create("false"));
            } else {
              getJpaSettingService().set(Context.USER.id(userName), Scope.APPLICATION.id(SETTINGS_MIGRATION_USER_KEY), SETTINGS_RDBMS_MIGRATION_DONE, SettingValue.create("true"));
            }
          }
        }
        current += users.length;
      } while(users != null && users.length > 0);
      long endTime = System.currentTimeMillis();
      LOG.info("User Settings data migrated in " + (endTime - startTime) + " ms");
      if (!errorUserSettings.isEmpty()) {
        getJpaSettingService().set(Context.GLOBAL, Scope.APPLICATION.id(SETTINGS_MIGRATION_USER_KEY), SETTINGS_JCR_DATA_USER_MIGRATED_KEY, SettingValue.create("true"));
      } else {
        getJpaSettingService().set(Context.GLOBAL, Scope.APPLICATION.id(SETTINGS_MIGRATION_USER_KEY), SETTINGS_JCR_DATA_USER_MIGRATED_KEY, SettingValue.create("false"));
      }
      return true;
    } catch (Exception e) {
      LOG.error("Error while migrating user settings data from JCR to RDBMS - Cause : " + e.getMessage(), e);
      return false;
    } finally {
      RequestLifeCycle.end();
      if (chromatticLifeCycle.getManager().getSynchronization() != null) {
        chromatticLifeCycle.getManager().endRequest(true);
      }
    }
  }

  private boolean isSettingsMigrated(String userName) {
    SettingValue<?> setting = getJpaSettingService().get(Context.USER.id(userName), Scope.APPLICATION.id(SETTINGS_MIGRATION_USER_KEY), SETTINGS_RDBMS_MIGRATION_DONE);
    return (setting != null && setting.getValue().equals("true"));
  }

  private Set<String> getUserScopesSettings(String user) {
    return new SynchronizationTask<Set<String>>() {
      @Override
      protected Set<String> execute(SessionContext ctx) {
        SimpleContextEntity userSettings = ctx.getSession().findByPath(SimpleContextEntity.class, "settings/user/" + user);
        return (userSettings == null ? new HashSet<String>() : userSettings.getScopes().keySet());
      }
    }.executeWith(chromatticLifeCycle);
  }

  private ScopeEntity getSpecificScope(String scope) {
    return new SynchronizationTask<ScopeEntity>() {
      @Override
      protected ScopeEntity execute(SessionContext ctx) {
        ScopeEntity globalSettings = ctx.getSession().findByPath(ScopeEntity.class, "settings/global/" + scope);
        return globalSettings;
      }
    }.executeWith(chromatticLifeCycle);
  }

  @ExoTransactional
  private Boolean migrateGlobalSettingsOfGlobalSpecificScopes(String scope) {
    ScopeEntity scopeEntity = getSpecificScope(scope);
    for (String instance : scopeEntity.getInstances().keySet()) {
      Scope specificScope = getScope(scope, instance);
      for (String key : scopeEntity.getInstance(instance).getProperties().keySet()) {
        try {
          getJpaSettingService().set(Context.GLOBAL, specificScope, key, new SettingValue<>(scopeEntity.getInstance(instance).getValue(key)));
        } catch (Exception e) {
          errorGlobalSettings.add(scope);
          LOG.error("Cannot migrate Global Settings data of specific scope: "+scope+" - cause: " +e.getMessage(), e);
          continue;
        }
      }
    }
    return true;
  }

  private Boolean deleteGlobalSettings(String scope) {
    return new SynchronizationTask<Boolean>() {
      @Override
      protected Boolean execute(SessionContext ctx) {
        try {
          ctx.getSession().remove(ctx.getSession().findByPath(ScopeEntity.class, "settings/global/" + scope));
          ctx.getSession().save();
          return true;
        } catch (Exception e) {
          LOG.error("Cannot remove JCR settings of scope: " + scope + " - cause: " + e.getCause(), e);
          nonRemovedGlobalSettings.add(scope);
          return false;
        }
      }
    }.executeWith(chromatticLifeCycle);
  }

  private Boolean deleteUserSettings(String user) {
    return new SynchronizationTask<Boolean>() {
      @Override
      protected Boolean execute(SessionContext ctx) {
        try {
          ctx.getSession().remove(ctx.getSession().findByPath(SimpleContextEntity.class, "settings/user/" + user));
          ctx.getSession().save();
          return true;
        } catch (Exception e) {
          LOG.error("Cannot remove JCR settings of user: " + user + " - cause: " + e.getCause(), e);
          nonRemovedUserSettings.add(user);
          return false;
        }
      }
    }.executeWith(chromatticLifeCycle);
  }

  private ScopeEntity getScopeOfUser(String user, String scope) {
    return new SynchronizationTask<ScopeEntity>() {
      @Override
      protected ScopeEntity execute(SessionContext ctx) {
        ScopeEntity globalSettings = ctx.getSession().findByPath(ScopeEntity.class, "settings/user/" + user + "/" + scope);
        return globalSettings;
      }
    }.executeWith(chromatticLifeCycle);
  }

  @ExoTransactional
  private Boolean migrateUserSettingsOfSpecificScope(String user, String scope) {
    ScopeEntity scopeEntity = getScopeOfUser(user, scope);
    if (scopeEntity != null) {
      for (String instance : scopeEntity.getInstances().keySet()) {
        Scope specificScope = getScope(scope, instance);
        for (String key : scopeEntity.getInstance(instance).getProperties().keySet()) {
          try {
            Scope settingScope = specificScope;
            if (key.equals(AbstractService.EXO_IS_ENABLED)) {
              settingScope = Scope.GLOBAL.id(null);
            }
            getJpaSettingService().set(Context.USER.id(user), settingScope, key, new SettingValue<>(scopeEntity.getInstance(instance).getValue(key)));
          } catch (Exception e) {
            errorUserSettings.add(user);
            LOG.error("Cannot migrate User Settings data of user: " + user + " and scope: " + scope + " - cause: " + e.getMessage(), e);
            continue;
          }
        }
      }
    }
    return true;
  }

  private Boolean hasGlobalSettingsToMigrate() {
    return new SynchronizationTask<Boolean>() {
      @Override
      protected Boolean execute(SessionContext ctx) {
        SimpleContextEntity settings = ctx.getSession().findByPath(SimpleContextEntity.class, "settings/global");
        return (settings!=null && settings.getScopes().size() > 0);
      }
    }.executeWith(chromatticLifeCycle);
  }

  private Boolean hasUserSettingsToMigrate() {
    try {
      SettingValue<?> setting = getJpaSettingService().get(Context.GLOBAL, Scope.APPLICATION.id(SETTINGS_MIGRATION_USER_KEY), SETTINGS_JCR_DATA_USER_MIGRATED_KEY);
      if (setting != null) {
        return setting.getValue().equals("true");
      } else {
        return new SynchronizationTask<Boolean>() {
          @Override
          protected Boolean execute(SessionContext ctx) {
            Set userSettingsToRemove = getJCRUserSettings();
            return userSettingsToRemove != null && userSettingsToRemove.size() > 0;
          }
        }.executeWith(chromatticLifeCycle);
      }
    } catch (Exception e) {
      LOG.error("Error when defining if there is user settings to migrate in jcr - cause: " + e.getMessage(), e);
      return false;
    }
  }

  private Set<String> getJCRUserSettings() {
    return new SynchronizationTask<Set<String>>() {
      @Override
      protected Set<String> execute(SessionContext ctx) {
        SubContextEntity settings = ctx.getSession().findByPath(SubContextEntity.class, "settings/user");
        return (settings!=null ? settings.getContexts().keySet() : null);
      }
    }.executeWith(chromatticLifeCycle);
  }

  private void setUserSettingsCleanupDone() {
    getJpaSettingService().set(Context.GLOBAL, Scope.APPLICATION.id(SETTINGS_MIGRATION_USER_KEY), SETTINGS_RDBMS_CLEANUP_DONE, SettingValue.create("true"));
  }

  private void setGlobalSettingsCleanupDone() {
    getJpaSettingService().set(Context.GLOBAL, Scope.APPLICATION.id(SETTINGS_MIGRATION_GLOBAL_KEY), SETTINGS_RDBMS_CLEANUP_DONE, SettingValue.create("true"));
  }

  private boolean isUserSettingsCleanupDone() {
    SettingValue<?> setting = getJpaSettingService().get(Context.GLOBAL, Scope.APPLICATION.id(SETTINGS_MIGRATION_USER_KEY), SETTINGS_RDBMS_CLEANUP_DONE);
    return (setting != null && setting.getValue().equals("true"));
  }

  private boolean isGlobalSettingsCleanupDone() {
    SettingValue<?> setting = getJpaSettingService().get(Context.GLOBAL, Scope.APPLICATION.id(SETTINGS_MIGRATION_GLOBAL_KEY), SETTINGS_RDBMS_CLEANUP_DONE);
    return (setting != null && setting.getValue().equals("true"));
  }

  @Override
  public boolean isDone() {
    return false;
  }

  @Override
  public void stop() {
    RDBMSMigrationUtils.getExecutorService().shutdown();
  }

  public Set<String> getGlobalSettings() {

    return new SynchronizationTask<Set<String>>() {
      @Override
      protected Set<String> execute(SessionContext ctx) {
        SimpleContextEntity globalSettings = ctx.getSession().findByPath(SimpleContextEntity.class, "settings/global");
        if (globalSettings != null) {
          return globalSettings.getScopes().keySet();
        } else {
          return new HashSet<String>();
        }
      }
    }.executeWith(chromatticLifeCycle);
  }

  public ScopeEntity getGlobalScope(String scope) {
    return new SynchronizationTask<ScopeEntity>() {
      @Override
      protected ScopeEntity execute(SessionContext ctx) {
        ScopeEntity globalSettings = ctx.getSession().findByPath(ScopeEntity.class, "settings/global/" + scope);
        return globalSettings;
      }
    }.executeWith(chromatticLifeCycle);
  }

  @ExoTransactional
  public Boolean migrateGlobalSettingsOfGlobalScopes(String scope) {
    ScopeEntity scopeEntity = getGlobalScope(scope);
    Scope globalScope = getScope(scope, null);
    for (String key : scopeEntity.getProperties().keySet()) {
      try {
        getJpaSettingService().set(Context.GLOBAL, globalScope, key, new SettingValue<>(scopeEntity.getValue(key)));
      } catch (Exception e) {
        errorGlobalSettings.add(scope);
        LOG.error("Cannot migrate Global Settings data of scope: "+scope+" - cause: " +e.getMessage(), e);
        continue;
      }
    }
    return true;
  }

  public ScopeEntity getGlobalScopeOfUser(String user, String scope) {
    return new SynchronizationTask<ScopeEntity>() {
      @Override
      protected ScopeEntity execute(SessionContext ctx) {
        ScopeEntity globalSettings = ctx.getSession().findByPath(ScopeEntity.class, "settings/user/" + user + "/" + scope);
        return globalSettings;
      }
    }.executeWith(chromatticLifeCycle);
  }

  @ExoTransactional
  public Boolean migrateUserSettingsOfGlobalScope(String user, String scope) {
    ScopeEntity scopeEntity = getGlobalScopeOfUser(user, scope);
    Scope globalScope = getScope(scope, null);
    if (scopeEntity != null) {
      for (String key : scopeEntity.getProperties().keySet()) {
        try {
          Scope settingScope = globalScope;
          if (key.equals(AbstractService.EXO_LAST_READ_DATE) || key.equals(AbstractService.EXO_DAILY)
              || key.equals(AbstractService.EXO_WEEKLY) || key.equals(AbstractService.EXO_IS_ACTIVE)
              || (key.startsWith("exo:") && key.endsWith("Channel"))) {
            settingScope = JPAUserSettingServiceImpl.NOTIFICATION_SCOPE;
          }
          getJpaSettingService().set(Context.USER.id(user), settingScope, key, new SettingValue<>(scopeEntity.getValue(key)));
        } catch (Exception e) {
          errorUserSettings.add(user);
          LOG.error("Cannot migrate User Settings data of user: " + user + " and scope: " + scope + " - cause: " + e.getMessage(),
                    e);
          continue;
        }
      }
    }
    return true;
  }

  public JPASettingServiceImpl getJpaSettingService() {
    if (jpaSettingService == null) {
      jpaSettingService = CommonsUtils.getService(JPASettingServiceImpl.class);
    }
    return jpaSettingService;
  }

  private Scope getScope(String scope, String id) {
    switch (scope) {
      case "windows":
        return Scope.WINDOWS.id(id);
      case "page":
        return Scope.PAGE.id(id);
      case "space":
        return Scope.SPACE.id(id);
      case "site":
        return Scope.SITE.id(id);
      case "portal":
        return Scope.PORTAL.id(id);
      case "application":
        return Scope.APPLICATION.id(id);
      case "global":
        return Scope.GLOBAL.id(id);
    }
    return null;
  }
}