|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.objectweb.joram.client.jms.admin.AdminRequestor
public final class AdminRequestor
The AdminRequestor class allows making administration service requests. The AdminRequestor constructor is given a Connection, it creates a session and a TemporaryTopic for the responses. It provides a request method that sends the request message to the administration topic of the connected server and waits for its reply.
AdminWrapper
Field Summary | |
---|---|
private javax.jms.MessageConsumer |
consumer
|
static long |
DEFAULT_REQUEST_TIMEOUT
Defines the default value for timeout before aborting a request. |
static org.objectweb.util.monolog.api.Logger |
logger
|
private javax.jms.MessageProducer |
producer
|
static java.lang.String |
REQUEST_TIMEOUT_PROP
Property allowing to set the timeout before aborting a request. |
private long |
requestTimeout
Defines the maximum time in milliseconds before aborting a request. |
private javax.jms.Session |
session
|
private javax.jms.TemporaryTopic |
tmpTopic
|
private javax.jms.Topic |
topic
|
Constructor Summary | |
---|---|
AdminRequestor(javax.jms.Connection cnx)
Constructor for the AdminRequestor class. |
Method Summary | |
---|---|
void |
abort()
Aborts the running request. |
void |
close()
Closes the AdminRequestor and its session. |
long |
getRequestTimeout()
Returns the maximum time in ms before aborting a request. |
AdminReply |
request(AdminRequest request)
Sends an administration request and waits for a reply. |
void |
setRequestTimeout(long requestTimeout)
Set the maximum time in ms before aborting arequest. |
private void |
throwException(AdminReply reply)
Throws an exception corresponding to the error code of the reply if needed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private javax.jms.Session session
private javax.jms.Topic topic
private javax.jms.TemporaryTopic tmpTopic
private javax.jms.MessageProducer producer
private javax.jms.MessageConsumer consumer
public static final java.lang.String REQUEST_TIMEOUT_PROP
requestTimeout
,
Constant Field Valuespublic static final long DEFAULT_REQUEST_TIMEOUT
Default value is 60.000 ms.
requestTimeout
,
Constant Field Valuesprivate long requestTimeout
Default value is 60.000 ms.
This value can be adjusted by setting
org.objectweb.joram.client.jms.admin.requestTimeout
property.
DEFAULT_REQUEST_TIMEOUT
,
REQUEST_TIMEOUT_PROP
public static org.objectweb.util.monolog.api.Logger logger
Constructor Detail |
---|
public AdminRequestor(javax.jms.Connection cnx) throws javax.jms.JMSException
cnx
- A Joram connection.
javax.jms.JMSException
- if Joram fails to create the AdminRequestor due to some internal error.Method Detail |
---|
public void setRequestTimeout(long requestTimeout)
requestTimeout
- the maximum time in ms before aborting request.public long getRequestTimeout()
public AdminReply request(AdminRequest request) throws AdminException, java.net.ConnectException
JMSReplyTo
destination and the request
JMSMessageID
as JMSCorrelationID
to select the corresponding
reply; any other replies are discarded.
request
- the administration request to send
javax.jms.JMSException
- if Joram fails to complete the request due to some internal error.
AdminException
java.net.ConnectException
private final void throwException(AdminReply reply) throws AdminException
reply
- The reply to verify.
AdminException
- The exception corresponding to the error code in the reply.public void abort() throws java.net.ConnectException
ConnectConnection
- A problem occurs with the connection.
java.net.ConnectException
public void close()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |