org.objectweb.joram.client.jms.Destination

org.objectweb.joram.client.jms.Destination Class Reference

Inherits org.objectweb.joram.client.jms.admin.AdministeredObject, and org.objectweb.joram.client.jms.DestinationMBean.

Inherited by org.objectweb.joram.client.jms.admin.ClusterDestination, org.objectweb.joram.client.jms.Queue, and org.objectweb.joram.client.jms.Topic.

Inheritance diagram for org.objectweb.joram.client.jms.Destination:

[legend]Collaboration diagram for org.objectweb.joram.client.jms.Destination:

[legend]List of all members.


Public Member Functions
	Destination ()
	Destination (String type)
String	getName ()
final String	getAdminName ()
final String	getType ()
boolean	equals (Object obj)
String	toString ()
String	toXml (int indent, int serverId) throws ConnectException, AdminException
boolean	isQueue ()
void	delete () throws ConnectException, AdminException, javax.jms.JMSException
void	setFreeReading () throws ConnectException, AdminException
void	setFreeWriting () throws ConnectException, AdminException
void	unsetFreeReading () throws ConnectException, AdminException
void	unsetFreeWriting () throws ConnectException, AdminException
void	setReader (User user) throws ConnectException, AdminException
void	addReader (String proxyId) throws ConnectException, AdminException
void	setWriter (User user) throws ConnectException, AdminException
void	addWriter (String proxyId) throws ConnectException, AdminException
void	unsetReader (User user) throws ConnectException, AdminException
void	removeReader (String proxyId) throws ConnectException, AdminException
void	unsetWriter (User user) throws ConnectException, AdminException
void	removeWriter (String proxyId) throws ConnectException, AdminException
void	setDMQ (DeadMQueue dmq) throws ConnectException, AdminException
void	setDMQId (String dmqId) throws ConnectException, AdminException
List	getReaders () throws ConnectException, AdminException
List	getReaderList () throws ConnectException, AdminException
List	getWriters () throws ConnectException, AdminException
List	getWriterList () throws ConnectException, AdminException
boolean	isFreelyReadable () throws ConnectException, AdminException
void	setFreelyReadable (boolean b) throws ConnectException, AdminException
boolean	isFreelyWriteable () throws ConnectException, AdminException
void	setFreelyWriteable (boolean b) throws ConnectException, AdminException
DeadMQueue	getDMQ () throws ConnectException, AdminException
String	getDMQId () throws ConnectException, AdminException
Hashtable	getStatistic () throws ConnectException, AdminException
void	toReference (Reference ref) throws NamingException
void	fromReference (Reference ref) throws NamingException
Hashtable	code ()
void	decode (Hashtable h)
Static Public Member Functions
static Destination	newInstance (String id, String name, String type) throws AdminException
static boolean	isAssignableTo (String realType, String resultingType)
Static Public Attributes
static final String	QUEUE
static final String	TOPIC
static final String	DEAD_MQUEUE
static final String	CLUSTER_QUEUE
static final String	BRIDGE_QUEUE
static final String	BRIDGE_TOPIC
static final String	MAIL_QUEUE
static final String	MAIL_TOPIC
static final String	SCHEDULER_QUEUE
Protected Member Functions
	Destination (String name, String type)
Static Protected Member Functions
static void	doCreate (int serverId, String name, String className, Properties props, Destination dest, String expectedType) throws ConnectException, AdminException
Protected Attributes
String	agentId
String	adminName

Detailed Description

Implements the javax.jms.Destination interface and provides JORAM specific administration and monitoring methods.

Definition at line 54 of file Destination.java.

Member Function Documentation

String org.objectweb.joram.client.jms.Destination.getName ( )

Returns the name of the destination.

Implements org.objectweb.joram.client.jms.DestinationMBean.

Reimplemented in org.objectweb.joram.client.jms.admin.ClusterDestination.

Definition at line 76 of file Destination.java.

References org.objectweb.joram.client.jms.Destination.agentId.

final String org.objectweb.joram.client.jms.Destination.getAdminName ( )

Returns the admin name of the destination.

Implements org.objectweb.joram.client.jms.DestinationMBean.

Definition at line 81 of file Destination.java.

References org.objectweb.joram.client.jms.Destination.adminName.

Referenced by org.objectweb.joram.client.jms.Destination.delete(), org.objectweb.joram.client.jms.admin.JoramSaxWrapper.endElement(), and org.objectweb.joram.client.jms.Destination.toXml().

boolean org.objectweb.joram.client.jms.Destination.equals ( Object obj )

Returns true if the parameter object is a Joram destination wrapping the same agent identifier.

Definition at line 93 of file Destination.java.

References org.objectweb.joram.client.jms.Destination.getName().

Referenced by org.objectweb.joram.client.jms.Destination.toXml().

Here is the call graph for this function:

String org.objectweb.joram.client.jms.Destination.toString ( )

Returns a String image of the queue.

Returns:: A provider-specific identity values for this queue.

Reimplemented in org.objectweb.joram.client.jms.admin.ClusterQueue, org.objectweb.joram.client.jms.admin.ClusterTopic, org.objectweb.joram.client.jms.admin.DeadMQueue, and org.objectweb.joram.client.jms.TemporaryTopic.

Definition at line 105 of file Destination.java.

References org.objectweb.joram.client.jms.Destination.adminName, and org.objectweb.joram.client.jms.Destination.agentId.

Referenced by org.objectweb.joram.client.jms.Topic.create(), org.objectweb.joram.client.tools.admin.DestinationTreeNode.getDescription(), org.objectweb.joram.client.jms.Queue.getMessageHeader(), and org.objectweb.joram.client.tools.admin.DestinationTreeNode.toString().

String org.objectweb.joram.client.jms.Destination.toXml	(	int	indent,
		int	serverId
	)			throws ConnectException, AdminException

Format the destination properties in a XML format

Parameters:

	indent	use this indent for prexifing XML representation.
	serverId	server id hosting the destination object

Returns:: returns a XML view of the queue (admin format)

Exceptions:

	ConnectException	if the server is unreachable
	AdminException	if an error occurs

Definition at line 121 of file Destination.java.

References org.objectweb.joram.client.jms.Destination.equals(), org.objectweb.joram.client.jms.Destination.getAdminName(), org.objectweb.joram.client.jms.Destination.getDMQ(), org.objectweb.joram.client.jms.Destination.getReaders(), org.objectweb.joram.client.jms.Destination.getType(), org.objectweb.joram.client.jms.Destination.getWriters(), org.objectweb.joram.client.jms.Destination.isFreelyReadable(), and org.objectweb.joram.client.jms.Destination.isFreelyWriteable().

Here is the call graph for this function:

boolean org.objectweb.joram.client.jms.Destination.isQueue ( )

Returns true if the destination is a queue.

Implements org.objectweb.joram.client.jms.DestinationMBean.

Definition at line 195 of file Destination.java.

Referenced by org.objectweb.joram.client.jms.admin.ClusterDestination.decode(), and org.objectweb.joram.client.jms.admin.ClusterDestination.fromReference().

static void org.objectweb.joram.client.jms.Destination.doCreate	(	int	serverId,
		String	name,
		String	className,
		Properties	props,
		Destination	dest,
		String	expectedType
	)			throws ConnectException, AdminException `[static, protected]`

Admin method creating or retrieving a destination with a given name on a given server, and returning its identifier.

The request fails if the target server does not belong to the platform, or if the destination deployement fails server side.

Parameters:

	serverId	The identifier of the server where deploying the destination.
	name	The destination name.
	className	Name of the MOM destination class.
	prop	Properties.

Exceptions:

	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Definition at line 234 of file Destination.java.

References org.objectweb.joram.shared.admin.CreateDestinationReply.getId(), and org.objectweb.joram.shared.admin.CreateDestinationReply.getType().

Referenced by org.objectweb.joram.client.jms.admin.DeadMQueue.create(), org.objectweb.joram.client.jms.Topic.create(), and org.objectweb.joram.client.jms.Queue.create().

Here is the call graph for this function:

void org.objectweb.joram.client.jms.Destination.delete ( ) throws ConnectException, AdminException, javax.jms.JMSException

Admin method removing this destination from the platform.

Exceptions:

	AdminException	Never thrown.
	ConnectException	If the admin connection is closed or broken.
	JMSException	Never thrown.

Implements org.objectweb.joram.client.jms.DestinationMBean.

Reimplemented in org.objectweb.joram.client.jms.TemporaryTopic.

Definition at line 270 of file Destination.java.

References org.objectweb.joram.client.jms.Destination.getAdminName(), and org.objectweb.joram.client.jms.Destination.getType().

Referenced by org.objectweb.joram.client.tools.admin.AdminController.deleteObject().

Here is the call graph for this function:

void org.objectweb.joram.client.jms.Destination.setFreeReading ( ) throws ConnectException, AdminException

Admin method setting free reading access to this destination.

The request fails if this destination is deleted server side.

Exceptions:

	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Reimplemented in org.objectweb.joram.client.jms.admin.ClusterDestination.

Definition at line 297 of file Destination.java.

Referenced by org.objectweb.joram.client.connector.JoramAdapter.createQueue(), and org.objectweb.joram.client.connector.JoramAdapter.createTopic().

void org.objectweb.joram.client.jms.Destination.setFreeWriting ( ) throws ConnectException, AdminException

Admin method setting free writing access to this destination.

The request fails if this destination is deleted server side.

Exceptions:

	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Reimplemented in org.objectweb.joram.client.jms.admin.ClusterDestination.

Definition at line 310 of file Destination.java.

Referenced by org.objectweb.joram.client.connector.JoramAdapter.createQueue(), and org.objectweb.joram.client.connector.JoramAdapter.createTopic().

void org.objectweb.joram.client.jms.Destination.unsetFreeReading ( ) throws ConnectException, AdminException

Admin method unsetting free reading access to this destination.

The request fails if this destination is deleted server side.

Exceptions:

	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Definition at line 323 of file Destination.java.

void org.objectweb.joram.client.jms.Destination.unsetFreeWriting ( ) throws ConnectException, AdminException

Admin method unsetting free writing access to this destination.

The request fails if this destination is deleted server side.

Exceptions:

	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Definition at line 336 of file Destination.java.

void org.objectweb.joram.client.jms.Destination.setReader ( User user ) throws ConnectException, AdminException

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

The request fails if this destination is deleted server side.

Parameters:

user

User to be set as a reader.

Exceptions:

	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Reimplemented in org.objectweb.joram.client.jms.admin.ClusterDestination.

Definition at line 351 of file Destination.java.

void org.objectweb.joram.client.jms.Destination.addReader ( String proxyId ) throws ConnectException, AdminException

used by MBean jmx

Implements org.objectweb.joram.client.jms.DestinationMBean.

Definition at line 357 of file Destination.java.

void org.objectweb.joram.client.jms.Destination.setWriter ( User user ) throws ConnectException, AdminException

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

The request fails if this destination is deleted server side.

Parameters:

user

User to be set as a writer.

Exceptions:

	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Reimplemented in org.objectweb.joram.client.jms.admin.ClusterDestination.

Definition at line 372 of file Destination.java.

void org.objectweb.joram.client.jms.Destination.addWriter ( String proxyId ) throws ConnectException, AdminException

used by MBean jmx

Implements org.objectweb.joram.client.jms.DestinationMBean.

Definition at line 378 of file Destination.java.

void org.objectweb.joram.client.jms.Destination.unsetReader ( User user ) throws ConnectException, AdminException

Admin method unsetting a given user as a reader on this destination.

The request fails if this destination is deleted server side.

Parameters:

user

Reader to be unset.

Exceptions:

	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Definition at line 393 of file Destination.java.

void org.objectweb.joram.client.jms.Destination.removeReader ( String proxyId ) throws ConnectException, AdminException

used by MBean jmx

Implements org.objectweb.joram.client.jms.DestinationMBean.

Definition at line 399 of file Destination.java.

void org.objectweb.joram.client.jms.Destination.unsetWriter ( User user ) throws ConnectException, AdminException

Admin method unsetting a given user as a writer on this destination.

The request fails if this destination is deleted server side.

Parameters:

user

Writer to be unset.

Exceptions:

	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Definition at line 414 of file Destination.java.

void org.objectweb.joram.client.jms.Destination.removeWriter ( String proxyId ) throws ConnectException, AdminException

used by MBean jmx

Implements org.objectweb.joram.client.jms.DestinationMBean.

Definition at line 420 of file Destination.java.

void org.objectweb.joram.client.jms.Destination.setDMQ ( DeadMQueue dmq ) throws ConnectException, AdminException

Admin method setting or unsetting a dead message queue for this destination.

The request fails if this destination is deleted server side.

Parameters:

dmq The dead message queue to be set (null for unsetting current DMQ).

Exceptions:

	IllegalArgumentException	If the DMQ is not a valid JORAM destination.
	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Definition at line 439 of file Destination.java.

void org.objectweb.joram.client.jms.Destination.setDMQId ( String dmqId ) throws ConnectException, AdminException

Admin method setting or unsetting a dead message queue for this destination.

The request fails if this destination is deleted server side.

Parameters:

dmqId The dead message queue Id to be set (null for unsetting current DMQ).

Exceptions:

	IllegalArgumentException	If the DMQ is not a valid JORAM destination.
	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Implements org.objectweb.joram.client.jms.DestinationMBean.

Definition at line 460 of file Destination.java.

List org.objectweb.joram.client.jms.Destination.getReaders ( ) throws ConnectException, AdminException

Monitoring method returning the list of all users that have a reading permission on this destination, or an empty list if no specific readers are set.

The request fails if the destination is deleted server side.

Exceptions:

	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Definition at line 477 of file Destination.java.

References org.objectweb.joram.shared.admin.Monitor_GetUsersRep.getUsers().

Referenced by org.objectweb.joram.client.jms.Destination.toXml().

Here is the call graph for this function:

List org.objectweb.joram.client.jms.Destination.getReaderList ( ) throws ConnectException, AdminException

used by MBean jmx

Implements org.objectweb.joram.client.jms.DestinationMBean.

Definition at line 494 of file Destination.java.

List org.objectweb.joram.client.jms.Destination.getWriters ( ) throws ConnectException, AdminException

Monitoring method returning the list of all users that have a writing permission on this destination, or an empty list if no specific writers are set.

The request fails if the destination is deleted server side.

Exceptions:

	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Definition at line 513 of file Destination.java.

References org.objectweb.joram.shared.admin.Monitor_GetUsersRep.getUsers().

Referenced by org.objectweb.joram.client.jms.Destination.toXml().

Here is the call graph for this function:

List org.objectweb.joram.client.jms.Destination.getWriterList ( ) throws ConnectException, AdminException

used by MBean jmx

Implements org.objectweb.joram.client.jms.DestinationMBean.

Definition at line 530 of file Destination.java.

boolean org.objectweb.joram.client.jms.Destination.isFreelyReadable ( ) throws ConnectException, AdminException

Monitoring method returning true if this destination provides free READ access.

The request fails if the destination is deleted server side.

Exceptions:

	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Implements org.objectweb.joram.client.jms.DestinationMBean.

Definition at line 548 of file Destination.java.

References org.objectweb.joram.shared.admin.Monitor_GetFreeAccessRep.getFreeReading().

Referenced by org.objectweb.joram.client.jms.Destination.toXml().

Here is the call graph for this function:

void org.objectweb.joram.client.jms.Destination.setFreelyReadable ( boolean b ) throws ConnectException, AdminException

used by MBean

Implements org.objectweb.joram.client.jms.DestinationMBean.

Definition at line 558 of file Destination.java.

boolean org.objectweb.joram.client.jms.Destination.isFreelyWriteable ( ) throws ConnectException, AdminException

Monitoring method returning true if this destination provides free WRITE access.

The request fails if the destination is deleted server side.

Exceptions:

	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Implements org.objectweb.joram.client.jms.DestinationMBean.

Definition at line 575 of file Destination.java.

References org.objectweb.joram.shared.admin.Monitor_GetFreeAccessRep.getFreeWriting().

Referenced by org.objectweb.joram.client.jms.Destination.toXml().

Here is the call graph for this function:

void org.objectweb.joram.client.jms.Destination.setFreelyWriteable ( boolean b ) throws ConnectException, AdminException

used by MBean

Implements org.objectweb.joram.client.jms.DestinationMBean.

Definition at line 585 of file Destination.java.

DeadMQueue org.objectweb.joram.client.jms.Destination.getDMQ ( ) throws ConnectException, AdminException

Monitoring method returning the dead message queue of this destination, null if not set.

The request fails if the destination is deleted server side.

Exceptions:

	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Definition at line 602 of file Destination.java.

References org.objectweb.joram.shared.admin.Monitor_GetDMQSettingsRep.getDMQName().

Referenced by org.objectweb.joram.client.tools.admin.AdminController.getDestinationDMQ(), org.objectweb.joram.client.tools.admin.AdminController.getUserDMQ(), and org.objectweb.joram.client.jms.Destination.toXml().

Here is the call graph for this function:

String org.objectweb.joram.client.jms.Destination.getDMQId ( ) throws ConnectException, AdminException

Monitoring method returning the dead message queue id of this destination, null if not set.

The request fails if the destination is deleted server side.

Exceptions:

	ConnectException	If the admin connection is closed or broken.
	AdminException	If the request fails.

Implements org.objectweb.joram.client.jms.DestinationMBean.

Definition at line 623 of file Destination.java.

References org.objectweb.joram.client.jms.Destination.getName().

Here is the call graph for this function:

void org.objectweb.joram.client.jms.Destination.toReference ( Reference ref ) throws NamingException [virtual]

Sets the naming reference of a connection factory.

Implements org.objectweb.joram.client.jms.admin.AdministeredObject.

Reimplemented in org.objectweb.joram.client.jms.admin.ClusterDestination.

Definition at line 674 of file Destination.java.

void org.objectweb.joram.client.jms.Destination.fromReference ( Reference ref ) throws NamingException [virtual]

Restores the administered object from a naming reference.

Implements org.objectweb.joram.client.jms.admin.AdministeredObject.

Reimplemented in org.objectweb.joram.client.jms.admin.ClusterDestination.

Definition at line 680 of file Destination.java.

Hashtable org.objectweb.joram.client.jms.Destination.code ( )

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

Implements fr.dyade.aaa.jndi2.soap.SoapObjectItf.

Reimplemented in org.objectweb.joram.client.jms.admin.ClusterDestination.

Definition at line 689 of file Destination.java.

void org.objectweb.joram.client.jms.Destination.decode ( Hashtable h )

Initializes a SoapObjectItf object given a coded Hashtable.

Implements fr.dyade.aaa.jndi2.soap.SoapObjectItf.

Reimplemented in org.objectweb.joram.client.jms.admin.ClusterDestination.

Definition at line 696 of file Destination.java.

Member Data Documentation

String org.objectweb.joram.client.jms.Destination.agentId [protected]

Identifier of the agent destination.

Definition at line 56 of file Destination.java.

String org.objectweb.joram.client.jms.Destination.adminName [protected]

Name given by the administrator.

Definition at line 59 of file Destination.java.

Referenced by org.objectweb.joram.client.jms.Destination.getAdminName(), org.objectweb.joram.client.jms.Destination.newInstance(), and org.objectweb.joram.client.jms.Destination.toString().

The documentation for this class was generated from the following file:

org/objectweb/joram/client/jms/Destination.java

Generated on Tue Sep 16 16:17:50 2008 for joram by

1.5.0

org.objectweb.joram.client.jms.Destination Class Reference

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation