org.objectweb.joram.client.jms.admin
Class ClusterDestination

java.lang.Object
  org.objectweb.joram.client.jms.admin.AdministeredObject
      org.objectweb.joram.client.jms.Destination
          org.objectweb.joram.client.jms.admin.ClusterDestination

All Implemented Interfaces:

fr.dyade.aaa.jndi2.soap.SoapObjectItf, java.io.Serializable, javax.jms.Destination, javax.naming.Referenceable, DestinationMBean

Direct Known Subclasses:

ClusterQueue, ClusterTopic

public class ClusterDestination
extends Destination

A base class for clustered destinations.

See Also:

Serialized Form

Field Summary

protected java.util.Hashtable

cluster

Fields inherited from class org.objectweb.joram.client.jms.Destination

adminName, agentId, BRIDGE_QUEUE, BRIDGE_TOPIC, CLUSTER_QUEUE, COLLECTOR_QUEUE, COLLECTOR_TOPIC, DEAD_MQUEUE, JMXBeanName, MAIL_QUEUE, MAIL_TOPIC, QUEUE, QUEUE_TYPE, SCHEDULER_QUEUE, TEMPORARY, TOPIC, TOPIC_TYPE, type

Constructor Summary

ClusterDestination()
Constructs an empty clustered destination.

ClusterDestination(java.util.Hashtable cluster)
Constructs a cluster destination.

Method Summary

void	addDestination(Destination dest) Adds a destination to the cluster.
void	addDestination(java.lang.String location, Destination dest) Adds a destination to the cluster with the specified location key.
java.util.Hashtable	code() Codes a ClusterDestination as a Hashtable for travelling through the SOAP protocol.
void	decode(java.util.Hashtable h)
void	fromReference(javax.naming.Reference ref) Restores the administered object from a naming reference.
java.util.Hashtable	getCluster()
protected Destination	getDestination() return the appropriate destination of cluster
java.lang.String	getName() Returns the name of the destination.
void	setCluster(java.util.Hashtable cluster)
void	setFreeReading() Administration method setting free reading access to this destination.
void	setFreeWriting() Administration method setting free writing access to this destination.
void	setReader(User user) Administration method setting a given user as a reader on this destination.
void	setWriter(User user) Administration method setting a given user as a writer on this destination.
void	toReference(javax.naming.Reference ref) Sets the naming reference of an administered object.

Methods inherited from class org.objectweb.joram.client.jms.Destination

addReader, addWriter, check, checkId, delete, doCreate, doRequest, equals, getAdminName, getDMQ, getDMQId, getJMXBeanName, getReaderList, getReaders, getStatistic, getStatistics, getType, getWrapper, getWriterList, getWriters, isFreelyReadable, isFreelyWriteable, isQueue, isTopic, newInstance, registerMBean, removeReader, removeWriter, setDMQ, setDMQId, setFreelyReadable, setFreelyWriteable, setWrapper, toXml, unregisterMBean, unsetFreeReading, unsetFreeWriting, unsetReader, unsetWriter

Methods inherited from class org.objectweb.joram.client.jms.admin.AdministeredObject

getReference

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cluster

protected java.util.Hashtable cluster

Constructor Detail

ClusterDestination

public ClusterDestination()

Constructs an empty clustered destination.

ClusterDestination

public ClusterDestination(java.util.Hashtable cluster)

Constructs a cluster destination.

Parameters:

cluster - Hashtable of the cluster agent destination.

Method Detail

setCluster

public void setCluster(java.util.Hashtable cluster)

getCluster

public java.util.Hashtable getCluster()

addDestination

public void addDestination(Destination dest)

Adds a destination to the cluster. The object will be added with a key equals to the location property. Be careful, the object should be rebind after modification.

Parameters:

dest - the Destination

addDestination

public void addDestination(java.lang.String location,
                           Destination dest)

Adds a destination to the cluster with the specified location key. By default, the location value is set to the String server#i, where i is the server id. of the destination. Be careful, the object should be rebind after modification.

Parameters:

location - the location key

dest - the Destination

getDestination

protected Destination getDestination()

return the appropriate destination of cluster

getName

public java.lang.String getName()

Returns the name of the destination.

Specified by:

getName in interface DestinationMBean

Overrides:

getName in class Destination

Returns:

the internal name of the destination.

setReader

public void setReader(User user)
               throws java.net.ConnectException,
                      AdminException

Description copied from class: Destination

Administration method setting a given user as a reader on this destination.

The request fails if this destination is deleted server side.

Overrides:

setReader in class Destination

Parameters:

user - User to be set as a reader.

Throws:

java.net.ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.

setWriter

public void setWriter(User user)
               throws java.net.ConnectException,
                      AdminException

Description copied from class: Destination

Administration method setting a given user as a writer on this destination.

The request fails if this destination is deleted server side.

Overrides:

setWriter in class Destination

Parameters:

user - User to be set as a writer.

Throws:

java.net.ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.

setFreeReading

public void setFreeReading()
                    throws java.net.ConnectException,
                           AdminException

Description copied from class: Destination

Administration method setting free reading access to this destination.

The request fails if this destination is deleted server side.

Overrides:

setFreeReading in class Destination

Throws:

java.net.ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.

setFreeWriting

public void setFreeWriting()
                    throws java.net.ConnectException,
                           AdminException

Description copied from class: Destination

Administration method setting free writing access to this destination.

The request fails if this destination is deleted server side.

Overrides:

setFreeWriting in class Destination

Throws:

java.net.ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.

toReference

public void toReference(javax.naming.Reference ref)
                 throws javax.naming.NamingException

Sets the naming reference of an administered object.

Overrides:

toReference in class Destination

Throws:

javax.naming.NamingException

fromReference

public void fromReference(javax.naming.Reference ref)
                   throws javax.naming.NamingException

Restores the administered object from a naming reference.

Overrides:

fromReference in class Destination

Throws:

javax.naming.NamingException

code

public java.util.Hashtable code()

Codes a ClusterDestination as a Hashtable for travelling through the SOAP protocol.

Specified by:

code in interface fr.dyade.aaa.jndi2.soap.SoapObjectItf

Overrides:

code in class Destination

decode

public void decode(java.util.Hashtable h)

Specified by:

decode in interface fr.dyade.aaa.jndi2.soap.SoapObjectItf

Overrides:

decode in class Destination