|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.knipp.rritoolkit.request.Request
de.knipp.rritoolkit.request.QueueDeleteRequest
public class QueueDeleteRequest
implementation of the queue read request
Field Summary | |
---|---|
private java.lang.String |
messageID
the message ID |
private Message.Type |
messageType
the message type |
Constructor Summary | |
---|---|
QueueDeleteRequest()
constructor |
|
QueueDeleteRequest(java.lang.String id)
constructor |
|
QueueDeleteRequest(java.lang.String id,
Message.Type type)
constructor |
Method Summary | |
---|---|
QueueDeleteResponse |
execute(Port port)
execute the this request on the given port. |
protected java.lang.String |
getActionCode()
return the action string for this request |
java.lang.String |
getMessageID()
return the message ID |
Message.Type |
getMessageType()
return the type of the message that shall be deleted |
protected void |
requestToKVList(KVList list)
method that needs to be implemented by subclasses for the key-value list conversion |
protected void |
requestToXml(org.w3c.dom.Node node)
method that needs to be implemented by subclasses for the XML conversion |
void |
setMessage(Message msg)
take the type and ID from the given message |
void |
setMessageID(java.lang.String theMessageID)
set the message ID |
void |
setMessageType(Message.Type type)
set the message type of the message that shall be deleted. |
java.lang.String |
toString()
return a string representation for debugging purposes |
Methods inherited from class de.knipp.rritoolkit.request.Request |
---|
getClientTxnID, getProtocolVersion, setClientTxnID, toList, toXml |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private java.lang.String messageID
private Message.Type messageType
Constructor Detail |
---|
public QueueDeleteRequest()
public QueueDeleteRequest(java.lang.String id)
id
- the message IDpublic QueueDeleteRequest(java.lang.String id, Message.Type type)
id
- the message IDtype
- the type (may be null
)Method Detail |
---|
public Message.Type getMessageType()
null
if the type is not setpublic void setMessageType(Message.Type type)
type
- the type or null
if the type is
unknownpublic java.lang.String getMessageID()
public void setMessageID(java.lang.String theMessageID)
theMessageID
- the message ID of the messagepublic void setMessage(Message msg)
msg
- the message to be deletedpublic QueueDeleteResponse execute(Port port) throws java.io.IOException
execute
in class Request
port
- the port on which this request shall
be executed
java.io.IOException
- if the execution failedprotected void requestToXml(org.w3c.dom.Node node) throws org.w3c.dom.DOMException, EncodeException
requestToXml
in class Request
node
- the node where the request shall be added to
org.w3c.dom.DOMException
- on DOM exceptions
EncodeException
- if the encoding fails for some reasonprotected java.lang.String getActionCode()
getActionCode
in class Request
protected void requestToKVList(KVList list) throws EncodeException
requestToKVList
in class Request
list
- the list that has to be filled
EncodeException
- if the encoding fails for some reasonpublic java.lang.String toString()
toString
in class Request
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |