|
Joram 5.2.1 | ||||||||
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
public abstract class Destination
Implements the javax.jms.Destination
interface and provides
JORAM specific administration and monitoring methods.
Field Summary | |
---|---|
protected java.lang.String |
adminName
Name given by the administrator. |
protected java.lang.String |
agentId
Identifier of the agent destination. |
static java.lang.String |
BRIDGE_QUEUE
|
static java.lang.String |
BRIDGE_TOPIC
|
static java.lang.String |
CLUSTER_QUEUE
|
static java.lang.String |
DEAD_MQUEUE
|
static java.lang.String |
MAIL_QUEUE
|
static java.lang.String |
MAIL_TOPIC
|
static java.lang.String |
QUEUE
|
static java.lang.String |
SCHEDULER_QUEUE
|
static java.lang.String |
TOPIC
|
Constructor Summary | |
---|---|
|
Destination()
|
|
Destination(java.lang.String type)
|
protected |
Destination(java.lang.String name,
java.lang.String type)
|
Method Summary | |
---|---|
void |
addReader(java.lang.String proxyId)
Administration method setting a given user as a reader on this destination. |
void |
addWriter(java.lang.String proxyId)
Administration method setting a given user as a writer on this destination. |
java.util.Hashtable |
code()
Codes a Destination as a Hashtable for travelling through the
SOAP protocol. |
void |
decode(java.util.Hashtable h)
|
void |
delete()
Administration method removing this destination from the platform. |
protected static void |
doCreate(int serverId,
java.lang.String name,
java.lang.String className,
java.util.Properties props,
Destination dest,
java.lang.String expectedType)
Administration 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. |
void |
fromReference(javax.naming.Reference ref)
Restores the administered object from a naming reference. |
java.lang.String |
getAdminName()
Returns the administration name of the destination. |
DeadMQueue |
getDMQ()
Monitoring method returning the dead message queue of this destination, null if not set. |
java.lang.String |
getDMQId()
Monitoring method returning the dead message queue id of this destination, null if not set. |
java.lang.String |
getName()
Returns the name of the destination. |
java.util.List |
getReaderList()
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. |
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. |
java.util.Hashtable |
getStatistic()
Deprecated. |
java.util.Hashtable |
getStatistics()
Return a set of statistic values from the destination. |
java.lang.String |
getType()
|
java.util.List |
getWriterList()
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. |
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. |
static boolean |
isAssignableTo(java.lang.String realType,
java.lang.String resultingType)
|
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. |
static Destination |
newInstance(java.lang.String id,
java.lang.String name,
java.lang.String type)
|
void |
removeReader(java.lang.String proxyId)
Administration method unsetting a given user as a reader on this destination. |
void |
removeWriter(java.lang.String proxyId)
Administration method unsetting a given user as a writer on this destination. |
void |
setDMQ(DeadMQueue dmq)
Administration method setting or unsetting a dead message queue for this destination. |
void |
setDMQId(java.lang.String dmqId)
Administration method setting or unsetting a dead message queue for this destination. |
void |
setFreelyReadable(boolean b)
Administration method (un)setting free reading access to this destination. |
void |
setFreelyWriteable(boolean b)
Administration method (un)setting free writing access to this destination. |
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 a connection factory. |
java.lang.String |
toString()
Returns a String image of the queue. |
java.lang.String |
toXml(int indent,
int serverId)
Format the destination properties in a XML format |
void |
unsetFreeReading()
Administration method unsetting free reading access to this destination. |
void |
unsetFreeWriting()
Administration method unsetting free writing access to this destination. |
void |
unsetReader(User user)
Administration method unsetting a given user as a reader on this destination. |
void |
unsetWriter(User user)
Administration method unsetting a given user as a writer on this destination. |
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, wait, wait, wait |
Field Detail |
---|
protected java.lang.String agentId
protected java.lang.String adminName
public static final java.lang.String QUEUE
public static final java.lang.String TOPIC
public static final java.lang.String DEAD_MQUEUE
public static final java.lang.String CLUSTER_QUEUE
public static final java.lang.String BRIDGE_QUEUE
public static final java.lang.String BRIDGE_TOPIC
public static final java.lang.String MAIL_QUEUE
public static final java.lang.String MAIL_TOPIC
public static final java.lang.String SCHEDULER_QUEUE
Constructor Detail |
---|
public Destination()
public Destination(java.lang.String type)
protected Destination(java.lang.String name, java.lang.String type)
Method Detail |
---|
public java.lang.String getName()
getName
in interface DestinationMBean
public final java.lang.String getAdminName()
getAdminName
in interface DestinationMBean
public final java.lang.String getType()
getType
in interface DestinationMBean
public boolean equals(java.lang.Object obj)
true
if the parameter object is a Joram destination
wrapping the same agent identifier.
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toXml(int indent, int serverId) throws java.net.ConnectException, AdminException
indent
- use this indent for prexifing XML representation.serverId
- server id hosting the destination object
java.net.ConnectException
- if the server is unreachable
AdminException
- if an error occurspublic boolean isQueue()
true
if the destination is a queue.
isQueue
in interface DestinationMBean
protected static void doCreate(int serverId, java.lang.String name, java.lang.String className, java.util.Properties props, Destination dest, java.lang.String expectedType) 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
destination.name
- The destination name.className
- Name of the MOM destination class.prop
- Properties.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public void delete() throws java.net.ConnectException, AdminException, javax.jms.JMSException
delete
in interface DestinationMBean
AdminException
- Never thrown.
java.net.ConnectException
- If the administration connection is closed or broken.
javax.jms.JMSException
- Never thrown.public void setFreeReading() throws java.net.ConnectException, AdminException
The request fails if this destination is deleted server side.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public void setFreeWriting() throws java.net.ConnectException, AdminException
The request fails if this destination is deleted server side.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public void unsetFreeReading() throws java.net.ConnectException, AdminException
The request fails if this destination is deleted server side.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public void unsetFreeWriting() throws java.net.ConnectException, AdminException
The request fails if this destination is deleted server side.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public void setReader(User user) throws java.net.ConnectException, AdminException
The request fails if this destination is deleted server side.
user
- User to be set as a reader.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public void addReader(java.lang.String proxyId) throws java.net.ConnectException, AdminException
This method should be only used by the JMX MBean.
addReader
in interface DestinationMBean
proxyId
- The unique identification of the user's proxy.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.DestinationMBean.addReader(java.lang.String)
public void setWriter(User user) throws java.net.ConnectException, AdminException
The request fails if this destination is deleted server side.
user
- User to be set as a writer.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public void addWriter(java.lang.String proxyId) throws java.net.ConnectException, AdminException
This method should be only used by the JMX MBean.
addWriter
in interface DestinationMBean
proxyId
- The unique identification of the user's proxy.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.DestinationMBean.addWriter(java.lang.String)
public void unsetReader(User user) throws java.net.ConnectException, AdminException
The request fails if this destination is deleted server side.
user
- Reader to be unset.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public void removeReader(java.lang.String proxyId) throws java.net.ConnectException, AdminException
This method should be only used by the JMX MBean.
removeReader
in interface DestinationMBean
proxyId
- The unique identification of the user's proxy.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.DestinationMBean.removeReader(java.lang.String)
public void unsetWriter(User user) throws java.net.ConnectException, AdminException
The request fails if this destination is deleted server side.
user
- Writer to be unset.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public void removeWriter(java.lang.String proxyId) throws java.net.ConnectException, AdminException
This method should be only used by the JMX MBean.
removeWriter
in interface DestinationMBean
proxyId
- The unique identification of the user's proxy.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.DestinationMBean.removeWriter(java.lang.String)
public void setDMQ(DeadMQueue dmq) throws java.net.ConnectException, AdminException
The request fails if this destination is deleted server side.
dmq
- The dead message queue to be set (null
for
unsetting current DMQ).
java.lang.IllegalArgumentException
- If the DMQ is not a valid
JORAM destination.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public void setDMQId(java.lang.String dmqId) throws java.net.ConnectException, AdminException
The request fails if this destination is deleted server side.
setDMQId
in interface DestinationMBean
dmqId
- The dead message queue Id to be set (null
for
unsetting current DMQ).
java.lang.IllegalArgumentException
- If the DMQ is not a valid
JORAM destination.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public java.util.List getReaders() throws java.net.ConnectException, AdminException
The request fails if the destination is deleted server side.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public java.util.List getReaderList() throws java.net.ConnectException, AdminException
This method should be only used by the JMX MBean.
getReaderList
in interface DestinationMBean
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.DestinationMBean.getReaderList()
public java.util.List getWriters() throws java.net.ConnectException, AdminException
The request fails if the destination is deleted server side.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public java.util.List getWriterList() throws java.net.ConnectException, AdminException
This method should be only used by the JMX MBean.
getWriterList
in interface DestinationMBean
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.DestinationMBean.getWriterList()
public boolean isFreelyReadable() throws java.net.ConnectException, AdminException
true
if this destination
provides free READ access.
The request fails if the destination is deleted server side.
isFreelyReadable
in interface DestinationMBean
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public void setFreelyReadable(boolean b) throws java.net.ConnectException, AdminException
This method should be only used by the JMX MBean.
setFreelyReadable
in interface DestinationMBean
b
- if true set the free reading access else disable.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.DestinationMBean.setFreelyReadable(boolean)
public boolean isFreelyWriteable() throws java.net.ConnectException, AdminException
true
if this destination
provides free WRITE access.
The request fails if the destination is deleted server side.
isFreelyWriteable
in interface DestinationMBean
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public void setFreelyWriteable(boolean b) throws java.net.ConnectException, AdminException
This method should be only used by the JMX MBean.
setFreelyWriteable
in interface DestinationMBean
b
- if true set the free writing access else disable.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.DestinationMBean.setFreelyWriteable(boolean)
public DeadMQueue getDMQ() throws java.net.ConnectException, AdminException
The request fails if the destination is deleted server side.
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public java.lang.String getDMQId() throws java.net.ConnectException, AdminException
The request fails if the destination is deleted server side.
getDMQId
in interface DestinationMBean
java.net.ConnectException
- If the administration connection is closed or broken.
AdminException
- If the request fails.public static Destination newInstance(java.lang.String id, java.lang.String name, java.lang.String type) throws AdminException
AdminException
public static boolean isAssignableTo(java.lang.String realType, java.lang.String resultingType)
public java.util.Hashtable getStatistic() throws java.net.ConnectException, AdminException
getStatistic
in interface DestinationMBean
java.net.ConnectException
AdminException
DestinationMBean.getStatistic()
public java.util.Hashtable getStatistics() throws java.net.ConnectException, AdminException
getStatistics
in interface DestinationMBean
java.net.ConnectException
AdminException
DestinationMBean.getStatistics()
public void toReference(javax.naming.Reference ref) throws javax.naming.NamingException
toReference
in class AdministeredObject
javax.naming.NamingException
public void fromReference(javax.naming.Reference ref) throws javax.naming.NamingException
fromReference
in class AdministeredObject
javax.naming.NamingException
public java.util.Hashtable code()
Destination
as a Hashtable for travelling through the
SOAP protocol.
code
in interface fr.dyade.aaa.jndi2.soap.SoapObjectItf
public void decode(java.util.Hashtable h)
decode
in interface fr.dyade.aaa.jndi2.soap.SoapObjectItf
|
Joram 5.2.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |