Package 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:

Serializable, Destination, Referenceable, DestinationMBean

Direct Known Subclasses:

ClusterQueue, ClusterTopic

public class ClusterDestination
extends Destination

A base class for clustered destinations.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Hashtable<String,Destination>	cluster
private static org.objectweb.util.monolog.api.Logger	logger
private static long	serialVersionUID	define serialVersionUID for interoperability

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

ACQUISITION_QUEUE, ACQUISITION_TOPIC, adminName, agentId, ALIAS_QUEUE, CLUSTER_QUEUE, DEAD_MQUEUE, DISTRIBUTION_QUEUE, DISTRIBUTION_TOPIC, FTP_QUEUE, JMXBeanName, QUEUE, QUEUE_TYPE, SCHEDULER_QUEUE, TEMPORARY, TOPIC, TOPIC_TYPE

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

rand

Constructor Summary

Constructors

Constructor	Description
ClusterDestination()	Constructs an empty clustered destination.
ClusterDestination(Hashtable<String,Destination> cluster)	Constructs a cluster destination.

Method Summary

Modifier and Type	Method	Description
void	addDestination(String location, Destination dest)	Adds a destination to the cluster with the specified location key.
void	addDestination(Destination dest)	Adds a destination to the cluster.
void	fromReference(Reference ref)	Restores the administered object from a naming reference.
Hashtable<String,Destination>	getCluster()
protected Destination	getDestination()	return the appropriate destination of cluster
String	getName()	Returns the name of the destination.
byte	getType()	Returns the type of the destination: queue or topic, temporary or not.
void	setCluster(Hashtable<String,Destination> 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(Reference ref)	Sets the naming reference of an administered object.

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

addInterceptor, addInterceptors, addReader, addWriter, check, checkId, delete, doCreate, equals, getAdminName, getDMQ, getDMQId, getInterceptors, getJMXBeanName, getReaderList, getReaders, getStatistic, getStatistics, getStatistics, getWrapper, getWriterList, getWriters, hashCode, isFreelyReadable, isFreelyWriteable, isQueue, isTopic, newInstance, registerMBean, removeInterceptors, removeReader, removeWriter, replaceInterceptor, replaceInterceptor, scale, setDMQ, setDMQId, setFreelyReadable, setFreelyWriteable, setProperties, 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, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

define serialVersionUID for interoperability

See Also:

Constant Field Values

logger

private static final org.objectweb.util.monolog.api.Logger logger

cluster

protected Hashtable<String,Destination> cluster

Constructor Detail

ClusterDestination

public ClusterDestination()

Constructs an empty clustered destination.

ClusterDestination

public ClusterDestination(Hashtable<String,Destination> cluster)

Constructs a cluster destination.

Parameters:

cluster - Hashtable of the cluster agent destination.

Method Detail

setCluster

public void setCluster(Hashtable<String,Destination> cluster)

getCluster

public Hashtable<String,Destination> 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(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 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.

getType

public byte getType()

Returns the type of the destination: queue or topic, temporary or not.

Overrides:

getType in class Destination

setReader

public void setReader(User user)
               throws 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:

ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.

setWriter

public void setWriter(User user)
               throws 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:

ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.

setFreeReading

public void setFreeReading()
                    throws 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:

ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.

setFreeWriting

public void setFreeWriting()
                    throws 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:

ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.

toReference

public void toReference(Reference ref)
                 throws NamingException

Sets the naming reference of an administered object.

Overrides:

toReference in class Destination

Throws:

NamingException

fromReference

public void fromReference(Reference ref)
                   throws NamingException

Restores the administered object from a naming reference.

Overrides:

fromReference in class Destination

Throws:

NamingException