org.argeo.cms/src/org/argeo/cms/internal/kernel/CmsState.java

   1 package org.argeo.cms.internal.kernel;
   2
   3 import static bitronix.tm.TransactionManagerServices.getTransactionManager;
   4 import static bitronix.tm.TransactionManagerServices.getTransactionSynchronizationRegistry;
   5 import static java.util.Locale.ENGLISH;
   6
   7 import java.io.File;
   8 import java.net.InetAddress;
   9 import java.net.UnknownHostException;
  10 import java.util.ArrayList;
  11 import java.util.Dictionary;
  12 import java.util.Hashtable;
  13 import java.util.List;
  14 import java.util.Locale;
  15 import java.util.UUID;
  16
  17 import javax.jcr.RepositoryFactory;
  18 import javax.transaction.TransactionManager;
  19 import javax.transaction.TransactionSynchronizationRegistry;
  20 import javax.transaction.UserTransaction;
  21
  22 import org.apache.commons.logging.Log;
  23 import org.apache.commons.logging.LogFactory;
  24 import org.argeo.cms.auth.AuthConstants;
  25 import org.argeo.cms.i18n.LocaleUtils;
  26 import org.argeo.node.NodeConstants;
  27 import org.argeo.node.NodeState;
  28 import org.argeo.util.LangUtils;
  29 import org.osgi.framework.Bundle;
  30 import org.osgi.framework.BundleContext;
  31 import org.osgi.framework.Constants;
  32 import org.osgi.framework.FrameworkUtil;
  33 import org.osgi.framework.ServiceReference;
  34 import org.osgi.service.cm.ManagedServiceFactory;
  35
  36 import bitronix.tm.BitronixTransactionManager;
  37 import bitronix.tm.BitronixTransactionSynchronizationRegistry;
  38 import bitronix.tm.TransactionManagerServices;
  39
  40 public class CmsState implements NodeState {
  41         private final Log log = LogFactory.getLog(CmsState.class);
  42         private final BundleContext bc = FrameworkUtil.getBundle(CmsState.class).getBundleContext();
  43
  44         // REFERENCES
  45         private Long availableSince;
  46
  47         // i18n
  48         private Locale defaultLocale;
  49         private List<Locale> locales = null;
  50
  51         private ThreadGroup threadGroup = new ThreadGroup("CMS");
  52         private KernelThread kernelThread;
  53         private List<Runnable> shutdownHooks = new ArrayList<>();
  54
  55         private final String stateUuid;
  56         private final boolean cleanState;
  57         private String hostname;
  58
  59         public CmsState(String stateUuid) {
  60                 this.stateUuid = stateUuid;
  61                 String frameworkUuid = KernelUtils.getFrameworkProp(Constants.FRAMEWORK_UUID);
  62                 this.cleanState = stateUuid.equals(frameworkUuid);
  63                 try {
  64                         this.hostname = InetAddress.getLocalHost().getHostName();
  65                 } catch (UnknownHostException e) {
  66                         log.error("Cannot set hostname", e);
  67                 }
  68
  69                 availableSince = System.currentTimeMillis();
  70                 if (log.isDebugEnabled())
  71                         log.debug("## CMS STARTED " + this.stateUuid + (cleanState ? " (clean state) " : " "));
  72
  73                 initI18n();
  74                 initServices();
  75
  76                 // kernel thread
  77                 kernelThread = new KernelThread(threadGroup, "Kernel Thread");
  78                 kernelThread.setContextClassLoader(getClass().getClassLoader());
  79                 kernelThread.start();
  80         }
  81
  82         private void initI18n() {
  83                 Object defaultLocaleValue = KernelUtils.getFrameworkProp(NodeConstants.I18N_DEFAULT_LOCALE);
  84                 defaultLocale = defaultLocaleValue != null ? new Locale(defaultLocaleValue.toString())
  85                                 : new Locale(ENGLISH.getLanguage());
  86                 locales = LocaleUtils.asLocaleList(KernelUtils.getFrameworkProp(NodeConstants.I18N_LOCALES));
  87         }
  88
  89         private void initServices() {
  90                 // JTA
  91                 initTransactionManager();
  92
  93                 // JCR
  94                 RepositoryServiceFactory repositoryServiceFactory = new RepositoryServiceFactory();
  95                 shutdownHooks.add(() -> repositoryServiceFactory.shutdown());
  96                 bc.registerService(ManagedServiceFactory.class, repositoryServiceFactory,
  97                                 LangUtils.init(Constants.SERVICE_PID, NodeConstants.NODE_REPOS_FACTORY_PID));
  98
  99                 NodeRepositoryFactory repositoryFactory = new NodeRepositoryFactory();
 100                 bc.registerService(RepositoryFactory.class, repositoryFactory, null);
 101
 102                 // Security
 103                 NodeUserAdmin userAdmin = new NodeUserAdmin(AuthConstants.ROLES_BASEDN);
 104                 shutdownHooks.add(() -> userAdmin.destroy());
 105                 Dictionary<String, Object> props = new Hashtable<>();
 106                 props.put(Constants.SERVICE_PID, NodeConstants.NODE_USER_ADMIN_PID);
 107                 bc.registerService(ManagedServiceFactory.class, userAdmin, props);
 108         }
 109
 110         private void initTransactionManager() {
 111                 // TODO manage it in a managed service, as startup could be long
 112                 ServiceReference<TransactionManager> existingTm = bc.getServiceReference(TransactionManager.class);
 113                 if (existingTm != null) {
 114                         if (log.isDebugEnabled())
 115                                 log.debug("Using provided transaction manager " + existingTm);
 116                 }
 117                 bitronix.tm.Configuration tmConf = TransactionManagerServices.getConfiguration();
 118                 tmConf.setServerId(UUID.randomUUID().toString());
 119
 120                 Bundle bitronixBundle = FrameworkUtil.getBundle(bitronix.tm.Configuration.class);
 121                 File tmBaseDir = bitronixBundle.getDataFile(KernelConstants.DIR_TRANSACTIONS);
 122                 File tmDir1 = new File(tmBaseDir, "btm1");
 123                 tmDir1.mkdirs();
 124                 tmConf.setLogPart1Filename(new File(tmDir1, tmDir1.getName() + ".tlog").getAbsolutePath());
 125                 File tmDir2 = new File(tmBaseDir, "btm2");
 126                 tmDir2.mkdirs();
 127                 tmConf.setLogPart2Filename(new File(tmDir2, tmDir2.getName() + ".tlog").getAbsolutePath());
 128
 129                 BitronixTransactionManager transactionManager = getTransactionManager();
 130                 shutdownHooks.add(() -> transactionManager.shutdown());
 131                 BitronixTransactionSynchronizationRegistry transactionSynchronizationRegistry = getTransactionSynchronizationRegistry();
 132                 // register
 133                 bc.registerService(TransactionManager.class, transactionManager, null);
 134                 bc.registerService(UserTransaction.class, transactionManager, null);
 135                 bc.registerService(TransactionSynchronizationRegistry.class, transactionSynchronizationRegistry, null);
 136                 if (log.isDebugEnabled())
 137                         log.debug("Initialised default Bitronix transaction manager");
 138         }
 139
 140         void shutdown() {
 141                 applyShutdownHooks();
 142
 143                 if (kernelThread != null)
 144                         kernelThread.destroyAndJoin();
 145
 146                 if (log.isDebugEnabled())
 147                         log.debug("## CMS STOPPED");
 148         }
 149
 150         /** Apply shutdown hoos in reverse order. */
 151         private void applyShutdownHooks() {
 152                 for (int i = shutdownHooks.size() - 1; i >= 0; i--) {
 153                         try {
 154                                 shutdownHooks.get(i).run();
 155                         } catch (Exception e) {
 156                                 log.error("Could not run shutdown hook #" + i);
 157                         }
 158                 }
 159                 // Clean hanging Gogo shell thread
 160                 new GogoShellKiller().start();
 161         }
 162
 163         @Override
 164         public boolean isClean() {
 165                 return cleanState;
 166         }
 167
 168         @Override
 169         public Long getAvailableSince() {
 170                 return availableSince;
 171         }
 172
 173         /*
 174          * ACCESSORS
 175          */
 176         public Locale getDefaultLocale() {
 177                 return defaultLocale;
 178         }
 179
 180         public List<Locale> getLocales() {
 181                 return locales;
 182         }
 183
 184         public String getHostname() {
 185                 return hostname;
 186         }
 187
 188         /** Workaround for blocking Gogo shell by system shutdown. */
 189         private class GogoShellKiller extends Thread {
 190
 191                 public GogoShellKiller() {
 192                         super("Gogo Shell Killer");
 193                         setDaemon(true);
 194                 }
 195
 196                 @Override
 197                 public void run() {
 198                         ThreadGroup rootTg = getRootThreadGroup(null);
 199                         Thread gogoShellThread = findGogoShellThread(rootTg);
 200                         if (gogoShellThread == null)
 201                                 return;
 202                         while (getNonDaemonCount(rootTg) > 2) {
 203                                 try {
 204                                         Thread.sleep(100);
 205                                 } catch (InterruptedException e) {
 206                                         // silent
 207                                 }
 208                         }
 209                         gogoShellThread = findGogoShellThread(rootTg);
 210                         if (gogoShellThread == null)
 211                                 return;
 212                         System.exit(0);
 213                 }
 214         }
 215
 216         private static ThreadGroup getRootThreadGroup(ThreadGroup tg) {
 217                 if (tg == null)
 218                         tg = Thread.currentThread().getThreadGroup();
 219                 if (tg.getParent() == null)
 220                         return tg;
 221                 else
 222                         return getRootThreadGroup(tg.getParent());
 223         }
 224
 225         private static int getNonDaemonCount(ThreadGroup rootThreadGroup) {
 226                 Thread[] threads = new Thread[rootThreadGroup.activeCount()];
 227                 rootThreadGroup.enumerate(threads);
 228                 int nonDameonCount = 0;
 229                 for (Thread t : threads)
 230                         if (t != null && !t.isDaemon())
 231                                 nonDameonCount++;
 232                 return nonDameonCount;
 233         }
 234
 235         private static Thread findGogoShellThread(ThreadGroup rootThreadGroup) {
 236                 Thread[] threads = new Thread[rootThreadGroup.activeCount()];
 237                 rootThreadGroup.enumerate(threads, true);
 238                 for (Thread thread : threads) {
 239                         if (thread.getName().equals("Gogo shell"))
 240                                 return thread;
 241                 }
 242                 return null;
 243         }
 244
 245 }