Inherited by org.objectweb.joram.client.jms.TemporaryTopic.
Inheritance diagram for org.objectweb.joram.client.jms.Topic:
Public Member Functions | |
| Topic () | |
| Topic (String name) | |
| String | getTopicName () throws JMSException |
| Topic | getHierarchicalFather () throws ConnectException, AdminException |
| List | getClusterFellows () throws ConnectException, AdminException |
| int | getSubscriptions () throws ConnectException, AdminException |
| String[] | getSubscriberIds () throws AdminException, ConnectException |
| void | addClusteredTopic (Topic addedTopic) throws ConnectException, AdminException |
| void | removeFromCluster () throws ConnectException, AdminException |
| void | setParent (Topic parent) throws ConnectException, AdminException |
| void | unsetParent () throws ConnectException, AdminException |
Static Public Member Functions | |
| static boolean | isTopic (String type) |
| static Topic | create (int serverId, String name, String className, Properties prop) throws ConnectException, AdminException |
| static Topic | create (int serverId, String className, Properties prop) throws ConnectException, AdminException |
| static Topic | create (int serverId, Properties prop) throws ConnectException, AdminException |
| static Topic | create (int serverId, String name) throws ConnectException, AdminException |
| static Topic | create (String name) throws ConnectException, AdminException |
| static Topic | create (int serverId) throws ConnectException, AdminException |
| static Topic | create () throws ConnectException, AdminException |
Protected Member Functions | |
| Topic (String name, String type) | |
javax.jms.Topic interface and provides Joram specific administration and monitoring methods. This is a proxy object a client uses to specify the destination of messages it is sending and the source of messages it receives.
Definition at line 50 of file Topic.java.
| String org.objectweb.joram.client.jms.Topic.getTopicName | ( | ) | throws JMSException |
Gets the The Joram's internal unique identifier of this topic. API method.
| JMSException | Actually never thrown. |
Definition at line 79 of file Topic.java.
References org.objectweb.joram.client.jms.Destination.getName().
Here is the call graph for this function:
| static Topic org.objectweb.joram.client.jms.Topic.create | ( | int | serverId, | |
| String | name, | |||
| String | className, | |||
| Properties | prop | |||
| ) | throws ConnectException, AdminException [static] |
Admin method creating and deploying (or retrieving) a topic on a given server. First a destination with the specified name is searched on the given server, if it does not exist it is created. In any case, its provider-specific address is returned.
The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.
| serverId | The identifier of the server where deploying the topic. | |
| name | The name of the topic. | |
| className | The topic class name. | |
| prop | The topic properties. |
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Definition at line 100 of file Topic.java.
References org.objectweb.joram.client.jms.Destination.doCreate(), org.objectweb.joram.client.jms.Topic.Topic(), and org.objectweb.joram.client.jms.Destination.toString().
Here is the call graph for this function:
| static Topic org.objectweb.joram.client.jms.Topic.create | ( | int | serverId, | |
| String | className, | |||
| Properties | prop | |||
| ) | throws ConnectException, AdminException [static] |
Admin method creating and deploying a topic on a given server.
The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.
| serverId | The identifier of the server where deploying the topic. | |
| className | The topic class name. | |
| prop | The topic properties. |
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Definition at line 131 of file Topic.java.
References org.objectweb.joram.client.jms.Topic.create().
Here is the call graph for this function:
| static Topic org.objectweb.joram.client.jms.Topic.create | ( | int | serverId, | |
| Properties | prop | |||
| ) | throws ConnectException, AdminException [static] |
Admin method creating and deploying a topic on a given server. It creates a Jorram's standard topic.
The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.
| serverId | The identifier of the server where deploying the topic. | |
| prop | The topic properties. |
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Definition at line 150 of file Topic.java.
References org.objectweb.joram.client.jms.Topic.create().
Here is the call graph for this function:
| static Topic org.objectweb.joram.client.jms.Topic.create | ( | int | serverId, | |
| String | name | |||
| ) | throws ConnectException, AdminException [static] |
Admin method creating and deploying (or retrieving) a topic on a given server with a given name. First a destination with the specified name is searched on the given server, if it does not exist it is created. In any case, its provider-specific address is returned.
The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.
| serverId | The identifier of the server where deploying the topic. | |
| name | The topic name. |
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Definition at line 169 of file Topic.java.
References org.objectweb.joram.client.jms.Topic.create().
Here is the call graph for this function:
| static Topic org.objectweb.joram.client.jms.Topic.create | ( | String | name | ) | throws ConnectException, AdminException [static] |
Admin method creating and deploying (or retrieving) a topic on the local server. First a destination with the specified name is searched on the given server, if it does not exist it is created. In any case, its provider-specific address is returned.
The request fails if the destination deployment fails server side.
| name | The topic name. |
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Definition at line 186 of file Topic.java.
References org.objectweb.joram.client.jms.Topic.create().
Here is the call graph for this function:
| static Topic org.objectweb.joram.client.jms.Topic.create | ( | int | serverId | ) | throws ConnectException, AdminException [static] |
Admin method creating and deploying a topic on a given server.
The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.
| serverId | The identifier of the server where deploying the topic. |
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Definition at line 204 of file Topic.java.
References org.objectweb.joram.client.jms.Topic.create().
Here is the call graph for this function:
| static Topic org.objectweb.joram.client.jms.Topic.create | ( | ) | throws ConnectException, AdminException [static] |
Admin method creating and deploying a topic on the local server.
The request fails if the destination deployment fails server side.
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Definition at line 216 of file Topic.java.
Referenced by org.objectweb.joram.client.jms.Topic.create().
| Topic org.objectweb.joram.client.jms.Topic.getHierarchicalFather | ( | ) | throws ConnectException, AdminException |
Monitoring method returning the hierarchical father of this topic, null if none.
The request fails if the topic is deleted server side.
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Definition at line 229 of file Topic.java.
References org.objectweb.joram.client.jms.Destination.agentId, org.objectweb.joram.shared.admin.Monitor_GetFatherRep.getFatherId(), and org.objectweb.joram.client.jms.Topic.Topic().
Here is the call graph for this function:
| List org.objectweb.joram.client.jms.Topic.getClusterFellows | ( | ) | throws ConnectException, AdminException |
Monitoring method returning the list describing the cluster this topic is part of.
The request fails if the topic is deleted server side.
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Definition at line 249 of file Topic.java.
References org.objectweb.joram.client.jms.Destination.agentId, and org.objectweb.joram.shared.admin.Monitor_GetClusterRep.getTopics().
Here is the call graph for this function:
| int org.objectweb.joram.client.jms.Topic.getSubscriptions | ( | ) | throws ConnectException, AdminException |
Monitoring method returning the number of users that subscribes on this topic. If a client has many subscriptions it is only counted once.
The request fails if the topic is deleted server side.
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Implements org.objectweb.joram.client.jms.TopicMBean.
Definition at line 271 of file Topic.java.
References org.objectweb.joram.client.jms.Destination.agentId, and org.objectweb.joram.shared.admin.Monitor_GetNumberRep.getNumber().
Here is the call graph for this function:
| String [] org.objectweb.joram.client.jms.Topic.getSubscriberIds | ( | ) | throws AdminException, ConnectException |
Monitoring method returning an array containing the ids of users that subscribes on this topic. If a client has many subscriptions its ids appears once.
Implements org.objectweb.joram.client.jms.TopicMBean.
Definition at line 278 of file Topic.java.
References org.objectweb.joram.client.jms.Destination.agentId, and org.objectweb.joram.shared.admin.GetSubscriberIdsRep.getSubscriberIds().
Here is the call graph for this function:
| void org.objectweb.joram.client.jms.Topic.addClusteredTopic | ( | Topic | addedTopic | ) | throws ConnectException, AdminException |
Adds a topic into the cluster this topic belongs to. If this topic doesn't belong to a cluster then a cluster is created by clustering this topic with the added topic.
The request fails if one or both of the topics are deleted, or can't belong to a cluster.
| addedTopic | topic added to the cluster |
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Definition at line 297 of file Topic.java.
References org.objectweb.joram.client.jms.Destination.agentId.
Referenced by org.objectweb.joram.client.jms.admin.JoramSaxWrapper.endElement().
| void org.objectweb.joram.client.jms.Topic.removeFromCluster | ( | ) | throws ConnectException, AdminException |
Removes this topic from the cluster it belongs to.
The request fails if the topic does not exist or is not part of any cluster.
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Definition at line 310 of file Topic.java.
References org.objectweb.joram.client.jms.Destination.agentId.
| void org.objectweb.joram.client.jms.Topic.setParent | ( | Topic | parent | ) | throws ConnectException, AdminException |
Creates a hierarchical relationship between this topic and its father topic.
The request fails if one of the topics does not exist or can't be part of a hierarchy.
| parent | the topic which will be parent. null to remove previous parent. |
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Definition at line 326 of file Topic.java.
References org.objectweb.joram.client.jms.Destination.agentId, and org.objectweb.joram.client.jms.Topic.unsetParent().
Referenced by org.objectweb.joram.client.jms.admin.JoramSaxWrapper.endElement().
Here is the call graph for this function:
| void org.objectweb.joram.client.jms.Topic.unsetParent | ( | ) | throws ConnectException, AdminException |
Unsets the father of this topic.
The request fails if the topic does not exist or is not part of any hierarchy.
| ConnectException | If the admin connection is closed or broken. | |
| AdminException | If the request fails. |
Definition at line 342 of file Topic.java.
References org.objectweb.joram.client.jms.Destination.agentId.
Referenced by org.objectweb.joram.client.jms.Topic.setParent().
1.5.0