de.knipp.rritoolkit.request
Class QueueReadRequest

java.lang.Object
  extended by de.knipp.rritoolkit.request.Request
      extended by de.knipp.rritoolkit.request.QueueReadRequest

public class QueueReadRequest
extends Request

implementation of the queue read request

Version:
$Revision: 14936 $
Author:
Klaus Malorny

Field Summary
private  Message.Type typeLimitation
          the requested message type
 
Constructor Summary
QueueReadRequest()
          constructor
QueueReadRequest(Message.Type type)
          constructor
 
Method Summary
 QueueReadResponse execute(Port port)
          execute the this request on the given port.
protected  java.lang.String getActionCode()
          return the action string for this request
 Message.Type getTypeLimitation()
          returns the message type to which the read request is limited
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 setTypeLimitation(Message.Type type)
          sets the message type to which the read request shall be limited
 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

typeLimitation

private Message.Type typeLimitation
the requested message type

Constructor Detail

QueueReadRequest

public QueueReadRequest()
constructor


QueueReadRequest

public QueueReadRequest(Message.Type type)
constructor

Parameters:
type - the type of message to read
Method Detail

getTypeLimitation

public Message.Type getTypeLimitation()
returns the message type to which the read request is limited

Returns:
the type or null if the request is not limited

setTypeLimitation

public void setTypeLimitation(Message.Type type)
sets the message type to which the read request shall be limited

Parameters:
type - the type or null if the request shall not be limited

execute

public QueueReadResponse execute(Port port)
                          throws java.io.IOException
execute the this request on the given port.

Overrides:
execute in class Request
Parameters:
port - the port on which this request shall be executed
Returns:
the response
Throws:
java.io.IOException - if the execution failed

requestToXml

protected void requestToXml(org.w3c.dom.Node node)
                     throws org.w3c.dom.DOMException,
                            EncodeException
method that needs to be implemented by subclasses for the XML conversion

Specified by:
requestToXml in class Request
Parameters:
node - the node where the request shall be added to
Throws:
org.w3c.dom.DOMException - on DOM exceptions
EncodeException - if the encoding fails for some reason

getActionCode

protected java.lang.String getActionCode()
return the action string for this request

Specified by:
getActionCode in class Request
Returns:
the action string

requestToKVList

protected void requestToKVList(KVList list)
                        throws EncodeException
method that needs to be implemented by subclasses for the key-value list conversion

Specified by:
requestToKVList in class Request
Parameters:
list - the list that has to be filled
Throws:
EncodeException - if the encoding fails for some reason

toString

public java.lang.String toString()
return a string representation for debugging purposes

Overrides:
toString in class Request
Returns:
the string representation


Copyright © 2005-2011 Knipp Medien und Kommunikation GmbH