public class QueueDeleteRequest extends Request
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
messageID
the message ID
|
private Message.Type |
messageType
the message type
|
Constructor and Description |
---|
QueueDeleteRequest()
constructor
|
QueueDeleteRequest(java.lang.String id)
constructor
|
QueueDeleteRequest(java.lang.String id,
Message.Type type)
constructor
|
Modifier and Type | Method and Description |
---|---|
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
|
getClientTxnID, getProtocolVersion, setClientTxnID, toList, toXml
private java.lang.String messageID
private Message.Type messageType
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
)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
protected 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 toorg.w3c.dom.DOMException
- on DOM exceptionsEncodeException
- 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 filledEncodeException
- if the encoding fails for some reasonCopyright © 2005-2013 Knipp Medien und Kommunikation GmbH