org.objectweb.joram.client.jms
Class Destination

java.lang.Object
  extended byorg.objectweb.joram.client.jms.admin.AdministeredObject
      extended byorg.objectweb.joram.client.jms.Destination
All Implemented Interfaces:
javax.jms.Destination, javax.naming.Referenceable, java.io.Serializable, SoapObjectItf
Direct Known Subclasses:
ClusterDestination, Queue, Topic

public abstract class Destination
extends AdministeredObject
implements javax.jms.Destination

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

See Also:
Serialized Form

Field Summary
protected  java.lang.String adminName
          Name given by the administrator.
protected  java.lang.String agentId
          Identifier of the agent destination.
 
Fields inherited from class org.objectweb.joram.client.jms.admin.AdministeredObject
id, instancesTable
 
Constructor Summary
Destination()
          Constructs an empty destination.
Destination(java.lang.String agentId)
          Constructs a destination.
Destination(java.lang.String agentId, java.lang.String name)
          Constructs a destination.
 
Method Summary
 java.util.Hashtable code()
          Codes a Destination as a Hashtable for travelling through the SOAP protocol.
 void delete()
          Admin method removing this destination from the platform.
static java.lang.String doCreate(int serverId, java.lang.String name, java.lang.String className, java.util.Properties prop)
          Admin method creating or retrieving a destination with a given name on a given server, and returning its identifier.
 boolean equals(java.lang.Object obj)
          Returns true if the parameter object is a Joram destination wrapping the same agent identifier.
 java.lang.String getAdminName()
          Returns the admin name of the destination.
 DeadMQueue getDMQ()
          Monitoring method returning the dead message queue of this destination, null if not set.
 java.lang.String getName()
          Returns the name of the destination.
 java.util.List getReaders()
          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.
 javax.naming.Reference getReference()
          Sets the naming reference of a destination.
 java.util.List getWriters()
          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.
 boolean isFreelyReadable()
          Monitoring method returning true if this destination provides free READ access.
 boolean isFreelyWriteable()
          Monitoring method returning true if this destination provides free WRITE access.
 boolean isQueue()
          Returns true if the destination is a queue.
 void setDMQ(DeadMQueue dmq)
          Admin method setting or unsetting a dead message queue for this destination.
 void setFreeReading()
          Admin method setting free reading access to this destination.
 void setFreeWriting()
          Admin method setting free writing access to this destination.
 void setReader(User user)
          Admin method setting a given user as a reader on this destination.
 void setWriter(User user)
          Admin method setting a given user as a writer on this destination.
 void unsetFreeReading()
          Admin method unsetting free reading access to this destination.
 void unsetFreeWriting()
          Admin method unsetting free writing access to this destination.
 void unsetReader(User user)
          Admin method unsetting a given user as a reader on this destination.
 void unsetWriter(User user)
          Admin method unsetting a given user as a writer on this destination.
 
Methods inherited from class org.objectweb.joram.client.jms.admin.AdministeredObject
getInstance
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface fr.dyade.aaa.jndi2.soap.SoapObjectItf
decode
 

Field Detail

agentId

protected java.lang.String agentId
Identifier of the agent destination.


adminName

protected java.lang.String adminName
Name given by the administrator.

Constructor Detail

Destination

public Destination(java.lang.String agentId)
Constructs a destination.

Parameters:
agentId - Identifier of the agent destination.

Destination

public Destination(java.lang.String agentId,
                   java.lang.String name)
Constructs a destination.

Parameters:
agentId - Identifier of the agent destination.
name - Name set by administrator.

Destination

public Destination()
Constructs an empty destination.

Method Detail

getName

public java.lang.String getName()
Returns the name of the destination.


getAdminName

public java.lang.String getAdminName()
Returns the admin name of the destination.


equals

public boolean equals(java.lang.Object obj)
Returns true if the parameter object is a Joram destination wrapping the same agent identifier.


isQueue

public boolean isQueue()
Returns true if the destination is a queue.


code

public java.util.Hashtable code()
Codes a Destination as a Hashtable for travelling through the SOAP protocol.

Specified by:
code in interface SoapObjectItf
Overrides:
code in class AdministeredObject

getReference

public javax.naming.Reference getReference()
                                    throws javax.naming.NamingException
Sets the naming reference of a destination.

Specified by:
getReference in interface javax.naming.Referenceable
Overrides:
getReference in class AdministeredObject
Throws:
javax.naming.NamingException

doCreate

public static java.lang.String doCreate(int serverId,
                                        java.lang.String name,
                                        java.lang.String className,
                                        java.util.Properties prop)
                                 throws java.net.ConnectException,
                                        AdminException
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.
Throws:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

delete

public void delete()
            throws java.net.ConnectException,
                   AdminException,
                   javax.jms.JMSException
Admin method removing this destination from the platform.

Throws:
AdminException - Never thrown.
java.net.ConnectException - If the admin connection is closed or broken.
JMSException - Never thrown.

setFreeReading

public void setFreeReading()
                    throws java.net.ConnectException,
                           AdminException
Admin method setting free reading access to this destination.

The request fails if this destination is deleted server side.

Throws:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

setFreeWriting

public void setFreeWriting()
                    throws java.net.ConnectException,
                           AdminException
Admin method setting free writing access to this destination.

The request fails if this destination is deleted server side.

Throws:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

unsetFreeReading

public void unsetFreeReading()
                      throws java.net.ConnectException,
                             AdminException
Admin method unsetting free reading access to this destination.

The request fails if this destination is deleted server side.

Throws:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

unsetFreeWriting

public void unsetFreeWriting()
                      throws java.net.ConnectException,
                             AdminException
Admin method unsetting free writing access to this destination.

The request fails if this destination is deleted server side.

Throws:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

setReader

public void setReader(User user)
               throws java.net.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.
Throws:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

setWriter

public void setWriter(User user)
               throws java.net.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.
Throws:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

unsetReader

public void unsetReader(User user)
                 throws java.net.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.
Throws:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

unsetWriter

public void unsetWriter(User user)
                 throws java.net.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.
Throws:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

setDMQ

public void setDMQ(DeadMQueue dmq)
            throws java.net.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).
Throws:
java.lang.IllegalArgumentException - If the DMQ is not a valid JORAM destination.
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

getReaders

public java.util.List getReaders()
                          throws java.net.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.

Throws:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

getWriters

public java.util.List getWriters()
                          throws java.net.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.

Throws:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

isFreelyReadable

public boolean isFreelyReadable()
                         throws java.net.ConnectException,
                                AdminException
Monitoring method returning true if this destination provides free READ access.

The request fails if the destination is deleted server side.

Throws:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

isFreelyWriteable

public boolean isFreelyWriteable()
                          throws java.net.ConnectException,
                                 AdminException
Monitoring method returning true if this destination provides free WRITE access.

The request fails if the destination is deleted server side.

Throws:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

getDMQ

public DeadMQueue getDMQ()
                  throws java.net.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.

Throws:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.


Copyright ? 2004 Scalagent - All rights reserved