Commit 9f5b7402 authored by Andre Freyssinet's avatar Andre Freyssinet

Javadoc enhancements and fixes.

parent 08bcd910
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2019 ScalAgent Distributed Technologies
* Copyright (C) 2001 - 2020 ScalAgent Distributed Technologies
* Copyright (C) 2004 France Telecom R&D
* Copyright (C) 2003 - 2004 Bull SA
* Copyright (C) 1996 - 2000 Dyade
......@@ -3750,7 +3750,7 @@ public final class UserAgent extends Agent implements UserAgentMBean, ProxyAgent
* Method used for sending an <code>AbstractJmsReply</code> back to an
* external client within the active context.
*
* @param rep The reply to send.
* @param reply The reply to send.
*/
private void doReply(AbstractJmsReply reply) {
sendToClient(activeCtxId, reply);
......@@ -3801,7 +3801,7 @@ public final class UserAgent extends Agent implements UserAgentMBean, ProxyAgent
* denying the non acknowledged messages, deleting the temporary
* destinations, removing the subscriptions.
*
* @exception Exception If the requester is not an administrator.
* @param not the request.
*/
private void deleteProxy(FwdAdminRequestNot not) {
if (logger.isLoggable(BasicLevel.DEBUG))
......
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2013 - 2019 ScalAgent Distributed Technologies
* Copyright (C) 2013 - 2020 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
......@@ -75,7 +75,7 @@ public class UserAgentArrivalState implements Encodable, Serializable {
/**
* Saves this state if modified.
* @throws Exception
* @throws IOException if an error occurs.
*/
public void save() throws IOException {
if (modified) {
......
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2004 - 2016 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.proxies;
import fr.dyade.aaa.agent.AgentMBean;
public interface UserAgentMBean extends AgentMBean {
/**
* Returns the name of this queue, or its id if not set.
*
* @return the name of this queue; its id if not set.
*/
String getName();
/**
* 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 list of subscriptions for this user. Each subscription is
* identified by its unique 'symbolic' name.
*
* @return The list of subscriptions for this user.
*/
String[] getSubscriptionNames();
/**
* Returns a string representation of this user's proxy.
*/
String toString();
/**
* Returns the number of erroneous messages forwarded to the DMQ since
* creation time of this proxy..
*
* @return the number of erroneous messages forwarded to the DMQ.
*/
long getNbMsgsSentToDMQSinceCreation();
/**
* Returns the default DMQ for subscription of this user.
* @return the default DMQ for subscription of this user.
*/
String getDMQId();
/**
* 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.
*/
int getThreshold();
/**
* 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.
*/
void setThreshold(int threshold);
/**
* 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.
*/
int getNbMaxMsg();
/**
* Sets the maximum number of message for the subscription of this user.
*
* @param nbMaxMsg the maximum number of message (-1 set no limit).
*/
void setNbMaxMsg(int nbMaxMsg);
/**
* Deletes this proxy.
*/
void delete();
/**
* Returns the amount of memory consumed by the message table.
*/
int getMessageTableConsumedMemory();
/**
* Return the reDeliveryDelay (unit: second)
*/
int getRedeliveryDelay();
/**
* @param reDeliveryDelay the reDeliveryDelay to set(unit: second)
*/
void setRedeliveryDelay(int redeliveryDelay);
}
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2004 - 2020 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.proxies;
import fr.dyade.aaa.agent.AgentMBean;
public interface UserAgentMBean extends AgentMBean {
/**
* Returns the name of this queue, or its id if not set.
*
* @return the name of this queue; its id if not set.
*/
String getName();
/**
* 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 list of subscriptions for this user. Each subscription is
* identified by its unique 'symbolic' name.
*
* @return The list of subscriptions for this user.
*/
String[] getSubscriptionNames();
/**
* Returns a string representation of this user's proxy.
*/
String toString();
/**
* Returns the number of erroneous messages forwarded to the DMQ since
* creation time of this proxy..
*
* @return the number of erroneous messages forwarded to the DMQ.
*/
long getNbMsgsSentToDMQSinceCreation();
/**
* Returns the default DMQ for subscription of this user.
* @return the default DMQ for subscription of this user.
*/
String getDMQId();
/**
* 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.
*/
int getThreshold();
/**
* 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.
*/
void setThreshold(int threshold);
/**
* 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.
*/
int getNbMaxMsg();
/**
* Sets the maximum number of message for the subscription of this user.
*
* @param nbMaxMsg the maximum number of message (-1 set no limit).
*/
void setNbMaxMsg(int nbMaxMsg);
/**
* Deletes this proxy.
*/
void delete();
/**
* Returns the amount of memory consumed by the message table.
*/
int getMessageTableConsumedMemory();
/**
* Return the reDeliveryDelay (unit: second)
*/
int getRedeliveryDelay();
/**
* Sets the redelivery delay.
* @param redeliveryDelay the redelivery delay to set(unit: second)
*/
void setRedeliveryDelay(int redeliveryDelay);
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment