Inheritance diagram for org.objectweb.joram.client.jms.admin.User:
Public Member Functions | |
| User () | |
| User (String name, String proxyId) | |
| String | toString () |
| String | getName () |
| boolean | equals (Object o) |
| void | update (String newName, String newPassword) throws ConnectException, AdminException |
| void | delete () throws ConnectException, AdminException |
| void | setDMQ (DeadMQueue dmq) throws ConnectException, AdminException |
| void | setDMQId (String dmqId) throws ConnectException, AdminException |
| void | setThreshold (int thresh) throws ConnectException, AdminException |
| DeadMQueue | getDMQ () throws ConnectException, AdminException |
| String | getDMQId () throws ConnectException, AdminException |
| int | getThreshold () throws ConnectException, AdminException |
| void | setNbMaxMsg (String subName, int nbMaxMsg) throws ConnectException, AdminException |
| int | getNbMaxMsg (String subName) throws ConnectException, AdminException |
| Subscription[] | getSubscriptions () throws AdminException, ConnectException |
| List | getSubscriptionList () throws AdminException, ConnectException |
| Subscription | getSubscription (String subName) throws AdminException, ConnectException |
| String | getSubscriptionString (String subName) throws AdminException, ConnectException |
| String[] | getMessageIds (String subName) throws AdminException, ConnectException |
| Message | readMessage (String subName, String msgId) throws AdminException, ConnectException, JMSException |
| void | deleteMessage (String subName, String msgId) throws AdminException, ConnectException |
| void | clearSubscription (String subName) throws AdminException, ConnectException |
| String | getProxyId () |
| void | toReference (Reference ref) throws NamingException |
| void | fromReference (Reference ref) throws NamingException |
| Hashtable | code () |
| void | decode (Hashtable h) |
Static Public Member Functions | |
| static User | create (String name, String password, int serverId) throws ConnectException, AdminException |
| static User | create (String name, String password) throws ConnectException, AdminException |
Package Attributes | |
| String | name |
| String | proxyId |
User class is a utility class needed for administering JORAM users.
Definition at line 46 of file User.java.
| org.objectweb.joram.client.jms.admin.User.User | ( | String | name, | |
| String | proxyId | |||
| ) |
| String org.objectweb.joram.client.jms.admin.User.toString | ( | ) |
Returns a string view of this User instance.
Implements org.objectweb.joram.client.jms.admin.UserMBean.
Definition at line 72 of file User.java.
References org.objectweb.joram.client.jms.admin.User.name, and org.objectweb.joram.client.jms.admin.User.proxyId.
| String org.objectweb.joram.client.jms.admin.User.getName | ( | ) |
Returns the user name.
Implements org.objectweb.joram.client.jms.admin.UserMBean.
Definition at line 78 of file User.java.
References org.objectweb.joram.client.jms.admin.User.name.
Referenced by org.objectweb.joram.client.tools.admin.UserTreeNode.UserTreeNode().
| boolean org.objectweb.joram.client.jms.admin.User.equals | ( | Object | o | ) |
Provides a reliable way to compare User instances.
Definition at line 83 of file User.java.
References org.objectweb.joram.client.jms.admin.User.proxyId.
| static User org.objectweb.joram.client.jms.admin.User.create | ( | String | name, | |
| String | password, | |||
| int | serverId | |||
| ) | throws ConnectException, AdminException [static] |
Admin method creating a user for a given server and instanciating the corresponding User object.
If the user has already been set on this server, the method simply returns the corresponding User object. Its fails if the target server does not belong to the platform, or if a proxy could not be deployed server side for a new user.
| name | Name of the user. | |
| password | Password of the user. | |
| serverId | The identifier of the user's server. |
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 108 of file User.java.
References org.objectweb.joram.client.jms.admin.User.getProxyId(), org.objectweb.joram.client.jms.admin.User.name, and org.objectweb.joram.client.jms.admin.User.User().
Referenced by org.objectweb.joram.client.jms.admin.User.create().
Here is the call graph for this function:
| static User org.objectweb.joram.client.jms.admin.User.create | ( | String | name, | |
| String | password | |||
| ) | throws ConnectException, AdminException [static] |
Admin method creating a user on the local server and instanciating the corresponding User object.
If the user has already been set on this server, the method simply returns the corresponding User object. It fails if a proxy could not be deployed server side for a new user.
| name | Name of the user. | |
| password | Password of the user. |
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 140 of file User.java.
References org.objectweb.joram.client.jms.admin.User.create(), and org.objectweb.joram.client.jms.admin.User.name.
Here is the call graph for this function:
| void org.objectweb.joram.client.jms.admin.User.update | ( | String | newName, | |
| String | newPassword | |||
| ) | throws ConnectException, AdminException |
Admin method updating this user identification.
The request fails if the user does not exist server side, or if the new identification is already taken by a user on the same server.
| newName | The new name of the user. | |
| newPassword | The new password of the user. |
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 157 of file User.java.
References org.objectweb.joram.client.jms.admin.User.name, and org.objectweb.joram.client.jms.admin.User.proxyId.
| void org.objectweb.joram.client.jms.admin.User.delete | ( | ) | throws ConnectException, AdminException |
Removes this user.
| ConnectException | If the connection fails. | |
| AdminException | Never thrown. |
Implements org.objectweb.joram.client.jms.admin.UserMBean.
Definition at line 169 of file User.java.
References org.objectweb.joram.client.jms.admin.User.name, and org.objectweb.joram.client.jms.admin.User.proxyId.
| void org.objectweb.joram.client.jms.admin.User.setDMQ | ( | DeadMQueue | dmq | ) | throws ConnectException, AdminException |
Admin method setting a given dead message queue for this user.
The request fails if the user is deleted server side.
| dmq | The dead message queue to be set. |
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 192 of file User.java.
References org.objectweb.joram.client.jms.admin.User.setDMQId().
Here is the call graph for this function:
| void org.objectweb.joram.client.jms.admin.User.setDMQId | ( | String | dmqId | ) | throws ConnectException, AdminException |
Admin method setting a given dead message queue for this user.
The request fails if the user is deleted server side.
| dmqId | The dead message queue Id to be set. |
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Implements org.objectweb.joram.client.jms.admin.UserMBean.
Definition at line 206 of file User.java.
References org.objectweb.joram.client.jms.admin.User.proxyId.
Referenced by org.objectweb.joram.client.jms.admin.User.setDMQ().
| void org.objectweb.joram.client.jms.admin.User.setThreshold | ( | int | thresh | ) | throws ConnectException, AdminException |
Admin method setting a given value as the threshold for this user.
The request fails if the user is deleted server side.
| threshold | The threshold value to be set. |
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Implements org.objectweb.joram.client.jms.admin.UserMBean.
Definition at line 220 of file User.java.
References org.objectweb.joram.client.jms.admin.User.proxyId.
| DeadMQueue org.objectweb.joram.client.jms.admin.User.getDMQ | ( | ) | throws ConnectException, AdminException |
Returns the dead message queue for this user, null if not set.
The request fails if the user is deleted server side.
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Definition at line 232 of file User.java.
References org.objectweb.joram.shared.admin.Monitor_GetDMQSettingsRep.getDMQName(), and org.objectweb.joram.client.jms.admin.User.proxyId.
Referenced by org.objectweb.joram.client.jms.admin.User.getDMQId().
Here is the call graph for this function:
| String org.objectweb.joram.client.jms.admin.User.getDMQId | ( | ) | throws ConnectException, AdminException |
Returns the dead message queue Id for this user, null if not set.
The request fails if the user is deleted server side.
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Implements org.objectweb.joram.client.jms.admin.UserMBean.
Definition at line 252 of file User.java.
References org.objectweb.joram.client.jms.admin.User.getDMQ(), and org.objectweb.joram.client.jms.Destination.getName().
Here is the call graph for this function:
| int org.objectweb.joram.client.jms.admin.User.getThreshold | ( | ) | throws ConnectException, AdminException |
Returns the threshold for this user, -1 if not set.
The request fails if the user is deleted server side.
| ConnectException | If the connection fails. | |
| AdminException | If the request fails. |
Implements org.objectweb.joram.client.jms.admin.UserMBean.
Definition at line 268 of file User.java.
References org.objectweb.joram.shared.admin.Monitor_GetDMQSettingsRep.getThreshold(), and org.objectweb.joram.client.jms.admin.User.proxyId.
Here is the call graph for this function:
| void org.objectweb.joram.client.jms.admin.User.setNbMaxMsg | ( | String | subName, | |
| int | nbMaxMsg | |||
| ) | throws ConnectException, AdminException |
Admin method setting nbMaxMsg for this subscription.
The request fails if the sub is deleted server side.
| subName | the name of the subscription. | |
| nbMaxMsg | nb Max of Message (-1 no limit). |
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Implements org.objectweb.joram.client.jms.admin.UserMBean.
Definition at line 291 of file User.java.
References org.objectweb.joram.client.jms.admin.User.proxyId.
| int org.objectweb.joram.client.jms.admin.User.getNbMaxMsg | ( | String | subName | ) | throws ConnectException, AdminException |
Monitoring method returning the nbMaxMsg of this subscription, -1 if no limit.
The request fails if the sub is deleted server side.
| subName | the name of the subscription. |
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Implements org.objectweb.joram.client.jms.admin.UserMBean.
Definition at line 307 of file User.java.
References org.objectweb.joram.shared.admin.Monitor_GetNbMaxMsgRep.getNbMaxMsg(), and org.objectweb.joram.client.jms.admin.User.proxyId.
Here is the call graph for this function:
| Subscription [] org.objectweb.joram.client.jms.admin.User.getSubscriptions | ( | ) | throws AdminException, ConnectException |
Returns the subscriptions owned by a user.
| serverId | the identifier of the server where the user has been created. | |
| userName | name of the user. |
| AdminException | If an error is raised by the administration operation. | |
| ConnectException | If the admin connection is not established. |
Implements org.objectweb.joram.client.jms.admin.UserMBean.
Definition at line 329 of file User.java.
References org.objectweb.joram.shared.admin.GetSubscriptionsRep.getDurable(), org.objectweb.joram.shared.admin.GetSubscriptionsRep.getMessageCounts(), org.objectweb.joram.shared.admin.GetSubscriptionsRep.getSubNames(), org.objectweb.joram.shared.admin.GetSubscriptionsRep.getTopicIds(), and org.objectweb.joram.client.jms.admin.User.proxyId.
Referenced by org.objectweb.joram.client.jms.admin.User.getSubscriptionList().
Here is the call graph for this function:
| List org.objectweb.joram.client.jms.admin.User.getSubscriptionList | ( | ) | throws AdminException, ConnectException |
used by MBean jmx
Implements org.objectweb.joram.client.jms.admin.UserMBean.
Definition at line 349 of file User.java.
References org.objectweb.joram.client.jms.admin.User.getSubscriptions(), and org.objectweb.joram.client.jms.admin.Subscription.toString().
Here is the call graph for this function:
| Subscription org.objectweb.joram.client.jms.admin.User.getSubscription | ( | String | subName | ) | throws AdminException, ConnectException |
Returns a subscription.
| serverId | the identifier of the server where the user owner of the subscription has been created. | |
| userName | name of the user that owns the subscription. | |
| subName | the name of the subscription. |
| AdminException | If an error is raised by the administration operation. | |
| ConnectException | If the admin connection is not established. |
Implements org.objectweb.joram.client.jms.admin.UserMBean.
Definition at line 374 of file User.java.
References org.objectweb.joram.shared.admin.GetSubscriptionRep.getDurable(), org.objectweb.joram.shared.admin.GetSubscriptionRep.getMessageCount(), org.objectweb.joram.shared.admin.GetSubscriptionRep.getTopicId(), and org.objectweb.joram.client.jms.admin.User.proxyId.
Referenced by org.objectweb.joram.client.jms.admin.User.getSubscriptionString().
Here is the call graph for this function:
| String org.objectweb.joram.client.jms.admin.User.getSubscriptionString | ( | String | subName | ) | throws AdminException, ConnectException |
Returns a subscription.
Implements org.objectweb.joram.client.jms.admin.UserMBean.
Definition at line 382 of file User.java.
References org.objectweb.joram.client.jms.admin.User.getSubscription(), and org.objectweb.joram.client.jms.admin.Subscription.toString().
Here is the call graph for this function:
| String org.objectweb.joram.client.jms.admin.User.getProxyId | ( | ) |
Returns the identifier of the user's proxy.
Implements org.objectweb.joram.client.jms.admin.UserMBean.
Definition at line 418 of file User.java.
References org.objectweb.joram.client.jms.admin.User.proxyId.
Referenced by org.objectweb.joram.client.jms.admin.User.create(), and org.objectweb.joram.client.tools.admin.UserTreeNode.UserTreeNode().
| void org.objectweb.joram.client.jms.admin.User.toReference | ( | Reference | ref | ) | throws NamingException [virtual] |
Sets the naming reference of a connection factory.
Implements org.objectweb.joram.client.jms.admin.AdministeredObject.
Definition at line 423 of file User.java.
References org.objectweb.joram.client.jms.admin.User.name, and org.objectweb.joram.client.jms.admin.User.proxyId.
| void org.objectweb.joram.client.jms.admin.User.fromReference | ( | Reference | ref | ) | throws NamingException [virtual] |
Restores the administered object from a naming reference.
Implements org.objectweb.joram.client.jms.admin.AdministeredObject.
Definition at line 429 of file User.java.
References org.objectweb.joram.client.jms.admin.User.name, and org.objectweb.joram.client.jms.admin.User.proxyId.
| Hashtable org.objectweb.joram.client.jms.admin.User.code | ( | ) |
Codes an User instance as a Hashtable for travelling through the SOAP protocol.
Implements fr.dyade.aaa.jndi2.soap.SoapObjectItf.
Definition at line 438 of file User.java.
References org.objectweb.joram.client.jms.admin.User.name, and org.objectweb.joram.client.jms.admin.User.proxyId.
Referenced by org.objectweb.joram.client.tools.admin.UserTreeNode.getUserName(), and org.objectweb.joram.client.tools.admin.UserPanel.setUser().
| void org.objectweb.joram.client.jms.admin.User.decode | ( | Hashtable | h | ) |
Decodes an User which travelled through the SOAP protocol.
Implements fr.dyade.aaa.jndi2.soap.SoapObjectItf.
Definition at line 448 of file User.java.
References org.objectweb.joram.client.jms.admin.User.name, and org.objectweb.joram.client.jms.admin.User.proxyId.
String org.objectweb.joram.client.jms.admin.User.name [package] |
The name of the user.
Definition at line 52 of file User.java.
Referenced by org.objectweb.joram.client.jms.admin.User.code(), org.objectweb.joram.client.jms.admin.User.create(), org.objectweb.joram.client.jms.admin.User.decode(), org.objectweb.joram.client.jms.admin.User.delete(), org.objectweb.joram.client.jms.admin.User.fromReference(), org.objectweb.joram.client.jms.admin.User.getName(), org.objectweb.joram.client.jms.admin.User.toReference(), org.objectweb.joram.client.jms.admin.User.toString(), and org.objectweb.joram.client.jms.admin.User.update().
String org.objectweb.joram.client.jms.admin.User.proxyId [package] |
Identifier of the user's proxy agent.
Definition at line 54 of file User.java.
Referenced by org.objectweb.joram.client.jms.admin.User.clearSubscription(), org.objectweb.joram.client.jms.admin.User.code(), org.objectweb.joram.client.jms.admin.User.decode(), org.objectweb.joram.client.jms.admin.User.delete(), org.objectweb.joram.client.jms.admin.User.deleteMessage(), org.objectweb.joram.client.jms.admin.User.equals(), org.objectweb.joram.client.jms.admin.User.fromReference(), org.objectweb.joram.client.jms.admin.User.getDMQ(), org.objectweb.joram.client.jms.admin.User.getMessageIds(), org.objectweb.joram.client.jms.admin.User.getNbMaxMsg(), org.objectweb.joram.client.jms.admin.User.getProxyId(), org.objectweb.joram.client.jms.admin.User.getSubscription(), org.objectweb.joram.client.jms.admin.User.getSubscriptions(), org.objectweb.joram.client.jms.admin.User.getThreshold(), org.objectweb.joram.client.jms.admin.User.readMessage(), org.objectweb.joram.client.jms.admin.User.setDMQId(), org.objectweb.joram.client.jms.admin.User.setNbMaxMsg(), org.objectweb.joram.client.jms.admin.User.setThreshold(), org.objectweb.joram.client.jms.admin.User.toReference(), org.objectweb.joram.client.jms.admin.User.toString(), and org.objectweb.joram.client.jms.admin.User.update().
1.5.0