delete
public void delete()
throws ConnectException,
AdminException,
javax.jms.JMSException
Admin method removing this destination from the platform.
AdminException
- Never thrown.
doCreate
public static String doCreate(int serverId,
String name,
String className,
Properties prop)
throws 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.
serverId
- The identifier of the server where deploying the
destination.name
- The destination name.className
- Name of the MOM destination class.prop
- Properties.
AdminException
- If the request fails.
equals
public boolean equals(Object obj)
Returns true
if the parameter object is a Joram destination
wrapping the same agent identifier.
getAdminName
public String getAdminName()
Returns the admin name of the destination.
getDMQ
public DeadMQueue 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.
AdminException
- If the request fails.
getName
public String getName()
Returns the name of the destination.
getReaders
public List 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.
AdminException
- If the request fails.
getReference
public Reference getReference()
throws NamingException
Sets the naming reference of a destination.
- getReference in interface AdministeredObject
getWriters
public List 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.
AdminException
- If the request fails.
isFreelyReadable
public boolean 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.
AdminException
- If the request fails.
isFreelyWriteable
public boolean 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.
AdminException
- If the request fails.
isQueue
public boolean isQueue()
Returns true
if the destination is a queue.
setDMQ
public void 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.
dmq
- The dead message queue to be set (null
for
unsetting current DMQ).
AdminException
- If the request fails.
setFreeReading
public void setFreeReading()
throws ConnectException,
AdminException
Admin method setting free reading access to this destination.
The request fails if this destination is deleted server side.
AdminException
- If the request fails.
setFreeWriting
public void setFreeWriting()
throws ConnectException,
AdminException
Admin method setting free writing access to this destination.
The request fails if this destination is deleted server side.
AdminException
- If the request fails.
setReader
public void 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.
user
- User to be set as a reader.
AdminException
- If the request fails.
setWriter
public void 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.
user
- User to be set as a writer.
AdminException
- If the request fails.
unsetFreeReading
public void unsetFreeReading()
throws ConnectException,
AdminException
Admin method unsetting free reading access to this destination.
The request fails if this destination is deleted server side.
AdminException
- If the request fails.
unsetFreeWriting
public void unsetFreeWriting()
throws ConnectException,
AdminException
Admin method unsetting free writing access to this destination.
The request fails if this destination is deleted server side.
AdminException
- If the request fails.
unsetReader
public void 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.
user
- Reader to be unset.
AdminException
- If the request fails.
unsetWriter
public void 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.
user
- Writer to be unset.
AdminException
- If the request fails.