queueimplmbean.java

一个类似于openJMS分布在ObjectWeb之下的JMS消息中间件。

/*
 * JORAM: Java(TM) Open Reliable Asynchronous Messaging
 * Copyright (C) 2004 - 2005 ScalAgent Distributed Technologies
 *
 * 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): ScalAgent Distributed Technologies
 * Contributor(s): 
 */
package org.objectweb.joram.mom.dest;

public interface QueueImplMBean extends DestinationImplMBean {
  /**
   * Returns  the period value of this queue, -1 if not set.
   *
   * @return the period value of this queue; -1 if not set.
   */
  long getPeriod();

  /**
   * Sets or unsets the period for this queue.
   *
   * @param period The period value to be set or -1 for unsetting previous
   *               value.
   */
  void setPeriod(long period);

  /**
   * Returns  the threshold value of this queue, -1 if not set.
   *
   * @return the threshold valcdue of this queue; -1 if not set.
   */
  int getThreshold();

  /**
   * Sets or unsets the threshold for this queue.
   *
   * @param threshold The threshold value to be set or -1 for unsetting
   *                  previous value.
   */
  void setThreshold(int threshold);

  /**
   * Returns the number of messages received since creation time.
   *
   * @return The number of received messages.
   */
  int getMessageCounter();

  /**
   * Returns the number of waiting requests in the queue.
   *
   * @return The number of waiting requests.
   */
  int getWaitingRequestCount();

//   /**
//    * Removes all request that the expiration time is expired.
//    */
//   void cleanWaitingRequest();

  /**
   * Returns the number of pending messages in the queue.
   *
   * @return The number of pending messages.
   */
  int getPendingMessageCount();

//   /**
//    * Removes all messages that the time-to-live is expired.
//    */
//   void cleanPendingMessage();

  /**
   * Returns the number of messages delivered and waiting for acknowledge.
   *
   * @return The number of messages delivered.
   */
  int getDeliveredMessageCount();

  /**
   * Returns the maximum number of message for the destination.
   * If the limit is unset the method returns -1.
   *
   * @return the maximum number of message for subscription if set;
   *	     -1 otherwise.
   */
  int getNbMaxMsg();

  /**
   * Sets the maximum number of message for the destination.
   *
   * @param nbMaxMsg the maximum number of message (-1 set no limit).
   */
  void setNbMaxMsg(int nbMaxMsg);
}