|
Joram ${version} | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.objectweb.joram.client.jms.admin.AdministeredObject
org.objectweb.joram.client.jms.Destination
org.objectweb.joram.client.jms.Topic
Implements the javax.jms.Topic
interface and provides
JORAM specific administration and monitoring methods.
Field Summary |
Fields inherited from class org.objectweb.joram.client.jms.Destination |
adminName, agentId |
Constructor Summary | |
|
Topic()
|
|
Topic(java.lang.String name)
|
protected |
Topic(java.lang.String name,
java.lang.String type)
|
Method Summary | |
void |
addClusteredTopic(Topic addedTopic)
Adds a topic into the cluster this topic belongs to. |
static Topic |
create()
Admin method creating and deploying a topic on the local server. |
static Topic |
create(int serverId)
Admin method creating and deploying a topic on a given server. |
static Topic |
create(int serverId,
java.util.Properties prop)
Admin method creating and deploying a topic on a given server. |
static Topic |
create(int serverId,
java.lang.String name)
Admin method creating and deploying (or retrieving) a topic on a given server with a given name. |
static Topic |
create(int serverId,
java.lang.String className,
java.util.Properties prop)
Admin method creating and deploying a topic on a given server. |
static Topic |
create(int serverId,
java.lang.String name,
java.lang.String className,
java.util.Properties prop)
Admin method creating and deploying (or retrieving) a topic on a given server. |
static Topic |
create(java.lang.String name)
Admin method creating and deploying (or retrieving) a topic on the local server. |
java.util.List |
getClusterFellows()
Monitoring method returning the list describing the cluster this topic is part of. |
Topic |
getHierarchicalFather()
Monitoring method returning the hierarchical father of this topic, null if none. |
java.lang.String[] |
getSubscriberIds(javax.jms.Topic topic)
|
int |
getSubscriptions()
Monitoring method returning the number of users that subscribes on this topic. |
java.lang.String |
getTopicName()
API method. |
static boolean |
isTopic(java.lang.String type)
|
void |
removeFromCluster()
Removes this topic from the cluster it belongs to. |
void |
setParent(Topic parent)
Creates a hierarchical relationship between this topic and its father topic. |
java.lang.String |
toString()
Returns a String image of the topic. |
void |
unsetParent()
Unsets the father of this topic. |
Methods inherited from class org.objectweb.joram.client.jms.Destination |
code, decode, delete, doCreate, equals, getAdminName, getDMQ, getName, getReaders, getReference, getType, getWriters, isAssignableTo, isFreelyReadable, isFreelyWriteable, isQueue, newInstance, setDMQ, setFreeReading, setFreeWriting, setReader, setWriter, unsetFreeReading, unsetFreeWriting, unsetReader, unsetWriter |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Topic()
public Topic(java.lang.String name)
protected Topic(java.lang.String name, java.lang.String type)
Method Detail |
public static boolean isTopic(java.lang.String type)
public java.lang.String toString()
toString
in interface javax.jms.Topic
public java.lang.String getTopicName() throws javax.jms.JMSException
getTopicName
in interface javax.jms.Topic
javax.jms.JMSException
- Actually never thrown.public static Topic create(int serverId, java.lang.String name, java.lang.String className, java.util.Properties prop) throws java.net.ConnectException, AdminException
The request fails if the target server does not belong to the platform, or if the destination deployement 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.
java.net.ConnectException
- If the admin connection is closed or broken.
AdminException
- If the request fails.public static Topic create(int serverId, java.lang.String className, java.util.Properties prop) throws java.net.ConnectException, AdminException
The request fails if the target server does not belong to the platform, or if the destination deployement fails server side.
serverId
- The identifier of the server where deploying the topic.className
- The topic class name.prop
- The topic properties.
java.net.ConnectException
- If the admin connection is closed or broken.
AdminException
- If the request fails.public static Topic create(int serverId, java.util.Properties prop) throws java.net.ConnectException, AdminException
The request fails if the target server does not belong to the platform, or if the destination deployement fails server side.
serverId
- The identifier of the server where deploying the topic.prop
- The topic properties.
java.net.ConnectException
- If the admin connection is closed or broken.
AdminException
- If the request fails.public static Topic create(int serverId, java.lang.String name) throws java.net.ConnectException, AdminException
The request fails if the target server does not belong to the platform, or if the destination deployement fails server side.
serverId
- The identifier of the server where deploying the topic.name
- The topic name.
java.net.ConnectException
- If the admin connection is closed or broken.
AdminException
- If the request fails.public static Topic create(java.lang.String name) throws java.net.ConnectException, AdminException
The request fails if the destination deployement fails server side.
name
- The topic name.
java.net.ConnectException
- If the admin connection is closed or broken.
AdminException
- If the request fails.public static Topic create(int serverId) throws java.net.ConnectException, AdminException
The request fails if the target server does not belong to the platform, or if the destination deployement fails server side.
serverId
- The identifier of the server where deploying the topic.
java.net.ConnectException
- If the admin connection is closed or broken.
AdminException
- If the request fails.public static Topic create() throws java.net.ConnectException, AdminException
The request fails if the destination deployement fails server side.
java.net.ConnectException
- If the admin connection is closed or broken.
AdminException
- If the request fails.public Topic getHierarchicalFather() throws java.net.ConnectException, AdminException
The request fails if the topic is deleted server side.
java.net.ConnectException
- If the admin connection is closed or broken.
AdminException
- If the request fails.public java.util.List getClusterFellows() throws java.net.ConnectException, AdminException
The request fails if the topic is deleted server side.
java.net.ConnectException
- If the admin connection is closed or broken.
AdminException
- If the request fails.public int getSubscriptions() throws java.net.ConnectException, AdminException
The request fails if the topic is deleted server side.
java.net.ConnectException
- If the admin connection is closed or broken.
AdminException
- If the request fails.public java.lang.String[] getSubscriberIds(javax.jms.Topic topic) throws AdminException, java.net.ConnectException
AdminException
java.net.ConnectException
public void addClusteredTopic(Topic addedTopic) throws java.net.ConnectException, AdminException
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
java.net.ConnectException
- If the admin connection is closed or broken.
AdminException
- If the request fails.public void removeFromCluster() throws java.net.ConnectException, AdminException
The request fails if the topic does not exist or is not part of any cluster.
java.net.ConnectException
- If the admin connection is closed or broken.
AdminException
- If the request fails.public void setParent(Topic parent) throws java.net.ConnectException, AdminException
The request fails if one of the topics does not exist or can't be part of a hierarchy.
parent
-
java.net.ConnectException
- If the admin connection is closed or broken.
AdminException
- If the request fails.public void unsetParent() throws java.net.ConnectException, AdminException
The request fails if the topic does not exist or is not part of any hierarchy.
java.net.ConnectException
- If the admin connection is closed or broken.
AdminException
- If the request fails.
|
Joram ${version} | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |