Name:      RequestBroker.java

Project:   xmlBlaster.org

Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file

Comment:   Handling the Client data

Author:    xmlBlaster@marcelruff.info

------------------------------------------------------------------------------*/

* This is the central message broker, all requests are routed through this singleton.

* <p>

* The interface I_ClientListener informs about Client login/logout<br />

* <p>

* Most events are fired from the RequestBroker

* <p>

* See <a href="http://www.xmlBlaster.org/xmlBlaster/src/java/org/xmlBlaster/protocol/corba/xmlBlaster.idl">xmlBlaster.idl</a>,

* the CORBA access interface on how clients can access xmlBlaster.

*

* @author <a href="mailto:xmlBlaster@marcelruff.info">Marcel Ruff</a>

*/

        implements I_ClientListener, /*I_AdminNode,*/ RequestBrokerMBean,

                     I_RunlevelListener, I_LogListener

   private String ME = "RequestBroker";

   private final ServerScope glob;

   private static Logger log = Logger.getLogger(RequestBroker.class.getName());

   /**

    * Contains total count of published messages and get() invocations.

    */

   private DispatchStatistic dispatchStatistic = new DispatchStatistic();

   private String lastWarning = "";

   private String lastError = "";

   /** the authentication service */

   private Authenticate authenticate;

   private final Set remotePropertiesListeners = new TreeSet();

   /**

    * Store configuration of all topics in xmlBlaster for recovery

    */

   private I_Map topicStore;

   /**

    * This client is only for internal use, it is un secure to pass it outside because

    * there is no authentication.<br />

    * The login name "__RequestBroker_internal__" is reserved!<br />

    * TODO: security discussion

    */

   private final SessionInfo unsecureSessionInfo;

   private final SessionName myselfLoginName; // "__RequestBroker_internal[heron]";

   public final static String internalLoginNamePrefix = "__RequestBroker_internal";

   /**

    * Helper to handle the subscriptions

    */

   private final ClientSubscriptions clientSubscriptions;

   /**

    * For listeners who want to be informed about subscribe/unsubscribe events.

    * The key is an Integer number where the lowest is the first invoked on subscribe and the

    * last invoked on unsubscribe.

    */

   private final Map subscriptionListenerMap = new TreeMap();

   /**

    * This is a handle on the big DOM tree with all XmlKey keys (all message meta data)

    */

   private BigXmlKeyDOM bigXmlKeyDOM = null;

   /**

    * This Interface allows to hook in you own persistence driver, configure it through xmlBlaster.properties

    */

   // private I_PersistenceDriver persistenceDriver = null;

   /** Flag for performance reasons only */

   private boolean useOldStylePersistence;

   /** The messageUnit for a login event */

   private boolean publishLoginEvent = true;

   private MsgKeyData xmlKeyLoginEvent = null;

   private org.xmlBlaster.client.qos.PublishQos publishQosForEvents;

   private PublishQosServer publishQosLoginEvent;

   /** Initialize a messageUnit for a userList event */

   private boolean publishUserList = true;

   private MsgKeyData xmlKeyUserListEvent = null;

   /** Initialize a messageUnit for a logout event */

   private boolean publishLogoutEvent = true;

   private MsgKeyData xmlKeyLogoutEvent = null;

   private PublishQosServer publishQosLogoutEvent;

   //private Timeout burstModeTimer;

   private AccessPluginManager accessPluginManager = null;

   private PublishPluginManager publishPluginManager = null;

   // Enforced by I_AdminNode

   /** Incarnation time of this object instance in millis */

   private long startupTime;

   /** State during construction */

   private static final int UNDEF = -1;

   private static final int ALIVE = 0;

   private int state = UNDEF;

   /** My JMX registration */

   private JmxMBeanHandle mbeanHandle;

   /**

    * One instance of this represents one xmlBlaster server.

    * @param authenticate The authentication service

    */

   public RequestBroker(Authenticate authenticate) throws XmlBlasterException

   {

      this.authenticate = authenticate;

      this.glob = this.authenticate.getGlobal();

      glob.setRequestBroker(this);

      glob.setTopicAccessor(new TopicAccessor(this.glob));

      this.startupTime = System.currentTimeMillis();

      this.mbeanHandle = this.glob.registerMBean(this.glob.getContextNode(), this);

      XbNotifyHandler.instance().register(Level.WARNING.intValue(), this);

      XbNotifyHandler.instance().register(Level.SEVERE.intValue(), this);

      this.useOldStylePersistence = glob.getProperty().get("useOldStylePersistence", false);

      if (this.useOldStylePersistence) {

         log.warning("Old style fielstorage is switched on which is deprecated (-useOldStylePersistence true).");

      }

      glob.getRunlevelManager().addRunlevelListener(this);

      //this.burstModeTimer = new Timeout("BurstmodeTimer");

      myselfLoginName = new SessionName(glob, glob.getNodeId(), internalLoginNamePrefix + "[" + glob.getId() + "]/1");

      initHelperQos();

      org.xmlBlaster.client.qos.ConnectQos connectQos = new org.xmlBlaster.client.qos.ConnectQos(glob);

      connectQos.setSessionName(myselfLoginName);

      connectQos.getSessionQos().setSessionTimeout(0L);  // Lasts forever

      this.unsecureSessionInfo = authenticate.unsecureCreateSession(connectQos);

      this.glob.setInternalSessionInfo(this.unsecureSessionInfo);

      try {

         glob.getCommandManager(this.unsecureSessionInfo);

      }

      catch(XmlBlasterException e) {

         log.severe(e.toString());

      }

      this.ME = "RequestBroker" + glob.getLogPrefixDashed();

      accessPluginManager = new AccessPluginManager(glob);

      publishPluginManager = new PublishPluginManager(glob);

      this.clientSubscriptions = new ClientSubscriptions(glob, this, authenticate);

      this.bigXmlKeyDOM = new BigXmlKeyDOM(this, authenticate);

      authenticate.addClientListener(this);

      this.state = ALIVE;

      if (log.isLoggable(Level.FINER)) log.finer("Server " + glob.getInstanceId() + " instance is created");

   }

   Authenticate getAuthenticate() {

      return this.authenticate;

   }

   /**

    * Put this code in a generic internal message producer class (future release)

    */

   private void initHelperQos() throws XmlBlasterException {

      // Create properties with infinite life time, forceUpdate and historySize=1

      org.xmlBlaster.client.qos.PublishQos publishQos = new org.xmlBlaster.client.qos.PublishQos(glob);

      publishQos.setLifeTime(-1L);

      publishQos.setForceUpdate(true);

      TopicProperty topicProperty = new TopicProperty(glob);

      HistoryQueueProperty historyQueueProperty = new HistoryQueueProperty(glob, glob.getId());

      historyQueueProperty.setMaxEntriesCache(2);

      historyQueueProperty.setMaxEntries(2);

      topicProperty.setHistoryQueueProperty(historyQueueProperty);

      publishQos.setTopicProperty(topicProperty);

      this.publishQosForEvents = publishQos;

      // Should we configure historyQueue and msgUnitStore to be RAM based only?

      this.publishLoginEvent = glob.getProperty().get("loginEvent", true);

      if (this.publishLoginEvent) {

         // Key '__sys__Login' for login event (allows you to subscribe on new clients which do a login)

         org.xmlBlaster.client.key.PublishKey publishKey = new org.xmlBlaster.client.key.PublishKey(glob, Constants.EVENT_OID_LOGIN/*"__sys__Login"*/, "text/plain");

         this.xmlKeyLoginEvent = publishKey.getData();

         this.publishQosLoginEvent = new PublishQosServer(glob, publishQos.getData().toXml(), false); // take copy

      }

      this.publishLogoutEvent = glob.getProperty().get("logoutEvent", true);

      if (this.publishLogoutEvent) {

         // Key '__sys__Logout' for logout event (allows you to subscribe on clients which do a logout)

         org.xmlBlaster.client.key.PublishKey publishKey = new org.xmlBlaster.client.key.PublishKey(glob, Constants.EVENT_OID_LOGOUT/*"__sys__Logout"*/, "text/plain");

         this.xmlKeyLogoutEvent = publishKey.getData();

         this.publishQosLogoutEvent = new PublishQosServer(glob, publishQos.getData().toXml(), false);

      }

      this.publishUserList = glob.getProperty().get("userListEvent", true);

      if (this.publishUserList) {

         // Key '__sys__UserList' for login/logout event

         org.xmlBlaster.client.key.PublishKey publishKey = new org.xmlBlaster.client.key.PublishKey(glob, Constants.EVENT_OID_USERLIST/*"__sys__UserList"*/, "text/plain");

         publishKey.setClientTags("<__sys__internal/>");

         this.xmlKeyUserListEvent = publishKey.getData();

      }

   }

   /**

    * A human readable name of the listener for logging.

    * <p />

    * Enforced by I_RunlevelListener

    */

   public String getName() {

      return ME;

   }

   BigXmlKeyDOM getBigXmlKeyDOM() {

      return  this.bigXmlKeyDOM;

   }

   /**

    * Holds all subscriptions.

    * @return Is never null

    */

   public ClientSubscriptions getClientSubscriptions() {

      return this.clientSubscriptions;

   }

   /**

    * Invoked on run level change, see RunlevelManager.RUNLEVEL_HALTED and RunlevelManager.RUNLEVEL_RUNNING

    * <p />

    * Enforced by I_RunlevelListener

    */

   public void runlevelChange(int from, int to, boolean force) throws org.xmlBlaster.util.XmlBlasterException {

      //if (log.isLoggable(Level.FINER)) log.call(ME, "Changing from run level=" + from + " to level=" + to + " with force=" + force);

      if (to == from)

         return;

      if (to > from) { // startup

         if (to == RunlevelManager.RUNLEVEL_STANDBY_PRE) {

           startupTopicStore();

         }

           // Load all persistent topics from persistent storage

//           loadPersistentMessages();

//         }

      }

      if (to < from) { // shutdown

         if (to == RunlevelManager.RUNLEVEL_HALTED) {

            XbNotifyHandler.instance().unregister(Level.WARNING.intValue(), this);

            XbNotifyHandler.instance().unregister(Level.SEVERE.intValue(), this);

            this.glob.unregisterMBean(this.mbeanHandle);

         }

      }

   }

   /**

    * Access the ServerScope handle.

    * @return The ServerScope instance of this xmlBlaster server

    */

   public final ServerScope getServerScope() {

      return this.glob;

   }

   /**

    * @return The handle on the persistence storage for all topics

    */

   I_Map getTopicStore() {

      return this.topicStore;

   }

   /**

    * This stores the topics configuration (the publish administrative message - the MsgUnit data struct)

    */

   private void startupTopicStore() throws XmlBlasterException   {

      if (log.isLoggable(Level.FINER)) log.finer("Entering startupTopicStore(), looking for persisted topics");

      boolean wipeOutJdbcDB = glob.getProperty().get("wipeOutJdbcDB", false);

      if (wipeOutJdbcDB) {

         this.glob.setWipeOutDB(wipeOutJdbcDB);

         // it is now the responsability of the QueuePlugin (see JdbcQueueCommonTable) to

         // really perform the wipeout, the request broker only gives him an order to do so.

         String tableNamePrefix = "XMLBLASTER";

         tableNamePrefix = glob.getProperty().get("queue.persistent.tableNamePrefix", tableNamePrefix).toUpperCase();

         log.warn(ME, "You have set '-wipeOutJdbcDB true', we will destroy now the complete JDBC persistence store entries of prefix="+tableNamePrefix);

         try {

            java.util.Properties prop = new java.util.Properties();

            prop.put("tableNamePrefix", tableNamePrefix);

            JdbcManagerCommonTable.wipeOutDB(glob, "JDBC", "1.0", prop, true);

         }

          catch (XmlBlasterException e) {

          log.error(ME, "Wipe out of JDBC database entries failed: " + e.getMessage());

         }

*/

      }

      boolean useTopicStore = glob.getProperty().get("useTopicStore", true);

      if (!useTopicStore) {

         log.warning("Persistent and recoverable topics are switched off with '-useTopicStore false', topics are handled RAM based only.");

         return;

      }

      synchronized (this) {

         // TODO: get TopicStoreProperty from administrator

         //TopicStoreProperty topicStoreProperty = this.topicProperty.getTopicStoreProperty();

         TopicStoreProperty topicStoreProperty = new TopicStoreProperty(glob, glob.getStrippedId());

         if (this.topicStore == null) {

            String type = topicStoreProperty.getType();

            String version = topicStoreProperty.getVersion();

            // e.g. "topicStore:/node/heron" is the unique name of the data store:

            StorageId topicStoreId = new StorageId(glob, glob.getDatabaseNodeStr(), Constants.RELATING_TOPICSTORE, "");

            // old xb_entries:

            // StorageId topicStoreId = new StorageId(glob, "topicStore",

            // glob.getStrippedId());

            // Todo: This loads 2 entries into the cache which should be avoided

            // as some line below getAll() gets all of them!

            this.topicStore = glob.getStoragePluginManager().getPlugin(type, version, topicStoreId, topicStoreProperty);

            //this.topicStore = new org.xmlBlaster.engine.msgstore.ram.MapPlugin();

            log.info("Activated storage '" + this.topicStore.getStorageId() + "' for persistent topics, found " + this.topicStore.getNumOfEntries() + " topics to recover.");

            MsgUnitStoreProperty limitM = new MsgUnitStoreProperty(glob, null); // The current limit from xmlBlaster.properties

            HistoryQueueProperty limitH = new HistoryQueueProperty(glob, null); // The current limit

            I_MapEntry[] mapEntryArr = this.topicStore.getAll(null);

            boolean fromPersistenceStore = true;

            for(int i=0; i<mapEntryArr.length; i++) {

               TopicEntry topicEntry = (TopicEntry)mapEntryArr[i];

               PublishQosServer publishQosServer = new PublishQosServer(glob,

                       (MsgQosData)topicEntry.getMsgUnit().getQosData(), fromPersistenceStore);

               publishQosServer.setTopicEntry(topicEntry); // Misuse PublishQosServer to transport the topicEntry

               boolean existsAlready = (glob.getTopicAccessor().accessDirtyRead(topicEntry.getKeyOid()) != null);

               if (existsAlready) {

                  log.warning("Removing duplicate of topic '" + topicEntry.getLogId() + "' from persistence store");

                  try {

                     this.topicStore.remove(topicEntry);

                  }

                  catch (XmlBlasterException e) {

                     log.severe("Removing duplicate of topic '" + topicEntry.getLogId() + "' from persistence store makes problems: " + e.getMessage());

                  }

                  continue;

               }

               try {

                  // Check limits

                  TopicProperty topicProps = ((MsgQosData)topicEntry.getMsgUnit().getQosData()).getTopicProperty();

                  if (topicProps != null && topicProps.getMsgUnitStoreProperty() != null) {

                     MsgUnitStoreProperty p = topicProps.getMsgUnitStoreProperty();

                     if (p.getMaxBytes() > limitM.getMaxBytes()) { // How to prevent a smaller limit than actual bytes on HD?

                        p.setMaxBytes(limitM.getMaxBytes());

                     }

                     if (p.getMaxBytesCache() > limitM.getMaxBytesCache()) {

                        p.setMaxBytesCache(limitM.getMaxBytesCache());

                     }

                     if (p.getMaxEntries() > limitM.getMaxEntries()) { // How to prevent a smaller limit than actual entries on HD?