* JORAM: Java(TM) Open Reliable Asynchronous Messaging

* Copyright (C) 2001 - 2011 ScalAgent Distributed Technologies

* Copyright (C) 2004 France Telecom R&D

* Copyright (C) 2003 - 2004 Bull SA

* Copyright (C) 1996 - 2000 Dyade

*

* This library is free software; you can redistribute it and/or

* modify it under the terms of the GNU Lesser General Public

* License as published by the Free Software Foundation; either

* version 2.1 of the License, or any later version.

*

* This library 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

* Lesser General Public License for more details.

*

* You should have received a copy of the GNU Lesser General Public

* License along with this library; if not, write to the Free Software

* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307

* USA.

*

* Initial developer(s): Frederic Maistre (INRIA)

* Contributor(s): ScalAgent Distributed Technologies

*/

* The <code>UserAgent</code> class implements the MOM proxy behaviour,

* basically forwarding client requests to MOM destinations and MOM

* destinations replies to clients.

*/

  /** define serialVersionUID for interoperability */

  private static final long serialVersionUID = 1L;

  public static Logger logger = Debug.getLogger(UserAgent.class.getName());

  /** the in and out interceptors list. */

  private String interceptors_in = null;

  private String interceptors_out = null;

  private transient List interceptorsOUT = null;

  private transient List interceptorsIN = null;

   

  /** period to run the cleaning task, by default 60s. */

  private long period = 60000L;

 

  /** the number of erroneous messages forwarded to the DMQ */

  private long nbMsgsSentToDMQSinceCreation = 0;

  /**

   * Returns  the period value of this queue, -1 if not set.

   *

   * @return the period value of this queue; -1 if not set.

   */

  public long getPeriod() {

    return period;

  }

  /**

   * Sets or unsets the period for this queue.

   *

   * @param period The period value to be set or -1 for unsetting previous

   *               value.

   */

  public void setPeriod(long period) {

    if (this.period != period) {

      // Schedule the task.

      WakeUpNot not = new WakeUpNot();

      not.update = true;

      Channel.sendTo(getId(), not);

      this.period = period;

    }

  }

  /**

   * Identifier of this proxy dead message queue, <code>null</code> for DMQ

   * not set.

   */

  private AgentId dmqId = null;

 

  /**

   * Returns the default DMQ for subscription of this user.

   * @return  the default DMQ for subscription of this user.

   */

  public String getDMQId() {

    if (dmqId != null) return dmqId.toString();

    return null;

  }

 

  /**

   *  Threshold above which messages are considered as undeliverable because

   * constantly denied.

   *  This value is used as default value at subscription creation.

   *  0 stands for no threshold, -1 for value not set (use server' default value).

   */

  private int threshold = -1;

  /**

   * Returns the default threshold for the subscription of this user.

   * 0 stands for no threshold, -1 for value not set.

   *

   * @return the maximum number of message if set; -1 otherwise.

   */

  public int getThreshold() {

    return threshold;

  }

  /**

   * Sets the default threshold for the subscription of this user.

   * 0 stands for no threshold, -1 for value not set.

   * 

   * @param threshold the threshold to set.

   */

  public void setThreshold(int threshold) {

    this.threshold = threshold;

  }

  /**

   *  Maximum number of Message store in subscriptions (-1 set no limit).

   *  This value is used as default value at subscription creation.

   */

  private int nbMaxMsg = -1;

  /**

   * Returns the default maximum number of message for the subscription of this user.

   * If the limit is unset the method returns -1.

   *

   * @return the maximum number of message if set; -1 otherwise.

   */

  public int getNbMaxMsg() {

    return nbMaxMsg;

  }

  /**

   * Sets the maximum number of message for the subscription of this user.

   *

   * @param nbMaxMsg the maximum number of message (-1 set no limit).

   */

  public void setNbMaxMsg(int nbMaxMsg) {

    this.nbMaxMsg = nbMaxMsg;

  }

  /**

   * Table of the proxy's <code>ClientContext</code> instances.

   * <p>

   * <b>Key:</b> context identifier<br>

   * <b>Value:</b> context

   */

  private Map contexts;

  /**

   * Table holding the <code>ClientSubscription</code> instances.

   * <p>

   * <b>Key:</b> subscription name<br>

   * <b>Value:</b> client subscription

   */

  private Map subsTable;

  /**

   * Table holding the recovered transactions branches.

   * <p>

   * <b>Key:</b> transaction identifier<br>

   * <b>Value:</b> <code>XACnxPrepare</code> instance

   */

  private Map recoveredTransactions;

  /** Counter of message arrivals from topics. */

  private long arrivalsCounter = 0;

  /**

   * Table holding the <code>TopicSubscription</code> instances.

   * <p>

   * <b>Key:</b> topic identifier<br>

   * <b>Value:</b> topic subscription

   */

  private transient Map topicsTable;

  /**

   * Table holding the subscriptions' messages.

   * <p>

   * <b>Key:</b> message identifier<br>

   * <b>Value:</b> message

   */

  private transient Map messagesTable;

  /**

   * Identifier of the active context.

   * Value -1 means that there's no active

   * context.

   */

  private transient int activeCtxId;

  /** Reference to the active <code>ClientContext</code> instance. */

  private transient ClientContext activeCtx;

  /**

   * Table that contains the user connections:

   * - key = <code>Integer</code> (connection key)

   * - value = <code></code>

   */

  private transient Hashtable connections;

  private transient Hashtable heartBeatTasks;

  /**

   * Counter of the connection keys

   */

  private int keyCounter = 0;

  private transient WakeUpTask cleaningTask;

  /** (Re)initializes the agent when (re)loading. */

  public void agentInitialize(boolean firstTime) throws Exception {

    if (logger.isLoggable(BasicLevel.DEBUG))

      logger.log(BasicLevel.DEBUG, "UserAgent.agentInitialize(" + firstTime + ')');

    super.agentInitialize(firstTime);

    initialize(firstTime);

    if (getPeriod() > 0)

      cleaningTask = new WakeUpTask(getId(), WakeUpNot.class, getPeriod());

    try {

      MXWrapper.registerMBean(this, getMBeanName().toString());

    } catch (Exception exc) {

      logger.log(BasicLevel.DEBUG, this + " jmx failed", exc);

    }

  }

  /** Finalizes the agent before it is garbaged. */

  public void agentFinalize(boolean lastTime) {

    if (cleaningTask != null)

      cleaningTask.cancel();

    try {

      MXWrapper.unregisterMBean(getMBeanName().toString());

    } catch (Exception exc) {

      logger.log(BasicLevel.DEBUG, this + " jmx failed", exc);

    }

    super.agentFinalize(lastTime);

  }

  private StringBuffer getMBeanName() {

    StringBuffer strbuf = new StringBuffer();

    strbuf.append("Joram#").append(AgentServer.getServerId());

    strbuf.append(':');

    strbuf.append("type=User,name=").append(getName());

    return strbuf;

  }

  /**

   * Overrides the <code>Agent</code> class <code>react</code> method for

   * providing the JMS client proxy with its specific behaviour.

   * <p>

   * A JMS proxy specifically reacts to the following notifications:

   * <ul>

   * <li><code>OpenConnectionNot</code></li>

   * </ul>

   */

  public void react(AgentId from, Notification not) throws Exception {

    if (logger.isLoggable(BasicLevel.DEBUG))

      logger.log(BasicLevel.DEBUG, "UserAgent.react(" + from + ',' + not + ')');

    // set agent no save: the default behavior is transient

    setNoSave();

    // Administration and monitoring requests:

//  if (not instanceof SetDMQRequest)

//    doReact(from, (SetDMQRequest) not);

//  else

//  if (not instanceof SetThresholdRequestNot)

//    doReact(from, (SetThresholdRequestNot) not);

//  else

//    if (not instanceof SetNbMaxMsgRequest)