QPID-2379: add ability to respond to method requests with non-zero status codes, use to signal unimplemented methods.

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@932430 13f79535-47bb-0310-9956-ffa450edef68

3 files changed, 76 insertions, 18 deletions

diff --git a/java/broker/src/main/java/org/apache/qpid/qmf/QMFMethodResponseCommand.java b/java/broker/src/main/java/org/apache/qpid/qmf/QMFMethodResponseCommand.java
index 529b04ebdb..5fea014ad8 100644
--- a/java/broker/src/main/java/org/apache/qpid/qmf/QMFMethodResponseCommand.java
+++ b/java/broker/src/main/java/org/apache/qpid/qmf/QMFMethodResponseCommand.java
@@ -20,24 +20,57 @@
  */
 package org.apache.qpid.qmf;
 
-import org.apache.qpid.server.virtualhost.VirtualHost;
-import org.apache.qpid.server.message.ServerMessage;
 import org.apache.qpid.transport.codec.BBEncoder;
 
 public class QMFMethodResponseCommand extends QMFCommand
 {
-    public QMFMethodResponseCommand(final QMFMethodRequestCommand cmd)
+    private CompletionCode _status = null;
+    private String _msg = null;
+
+    public QMFMethodResponseCommand(final QMFMethodRequestCommand cmd, 
+                                    CompletionCode status,
+                                    String msg)
     {
         super( new QMFCommandHeader(cmd.getHeader().getVersion(),
                                     cmd.getHeader().getSeq(),
                                     QMFOperation.METHOD_RESPONSE));
+        
+        if(status == null)
+        {
+            _status = CompletionCode.OK;
+        }
+        else
+        {
+            _status = status;
+        }
+        
+        _msg = msg;
+    }
+    
+    public CompletionCode getStatus()
+    {
+       return _status;
+    }
+
+    public String getStatusText()
+    {
+       return _msg;
     }
 
     @Override
     public void encode(final BBEncoder encoder)
     {
         super.encode(encoder);
-        encoder.writeUint32(0);
-        encoder.writeStr16("OK");
+
+        encoder.writeUint32(_status.ordinal());
+
+        if(_msg == null)
+        {
+            encoder.writeStr16(_status.toString());
+        }
+        else
+        {
+            encoder.writeStr16(_msg);
+        }
     }
 }
diff --git a/java/broker/src/main/java/org/apache/qpid/qmf/QMFService.java b/java/broker/src/main/java/org/apache/qpid/qmf/QMFService.java
index 4491f3f7d5..1a9766c5b2 100644
--- a/java/broker/src/main/java/org/apache/qpid/qmf/QMFService.java
+++ b/java/broker/src/main/java/org/apache/qpid/qmf/QMFService.java
@@ -679,8 +679,8 @@ public class QMFService implements ConfigStore.ConfigEventListener
                                                                                                  final String destQueue,
                                                                                                  final Long qty)
         {
-            // todo
-            throw new UnsupportedOperationException();
+            // TODO
+            return factory.createResponseCommand(CompletionCode.NOT_IMPLEMENTED);
         }
 
         public UUID getId()
@@ -1056,7 +1056,7 @@ public class QMFService implements ConfigStore.ConfigEventListener
                                                                             final String exchange)
         {
             //TODO
-            return factory.createResponseCommand();
+            return factory.createResponseCommand(CompletionCode.NOT_IMPLEMENTED);
         }
 
 
@@ -1319,20 +1319,20 @@ public class QMFService implements ConfigStore.ConfigEventListener
 
         public BrokerSchema.SessionClass.SolicitAckMethodResponseCommand solicitAck(final BrokerSchema.SessionClass.SolicitAckMethodResponseCommandFactory factory)
         {
-            //todo
-            throw new UnsupportedOperationException();
+            //TODO
+            return factory.createResponseCommand(CompletionCode.NOT_IMPLEMENTED);
         }
 
         public BrokerSchema.SessionClass.DetachMethodResponseCommand detach(final BrokerSchema.SessionClass.DetachMethodResponseCommandFactory factory)
         {
-            //todo
-            throw new UnsupportedOperationException();
+            //TODO
+            return factory.createResponseCommand(CompletionCode.NOT_IMPLEMENTED);
         }
 
         public BrokerSchema.SessionClass.ResetLifespanMethodResponseCommand resetLifespan(final BrokerSchema.SessionClass.ResetLifespanMethodResponseCommandFactory factory)
         {
-            //todo
-            throw new UnsupportedOperationException();
+            //TODO
+            return factory.createResponseCommand(CompletionCode.NOT_IMPLEMENTED);
         }
 
         public BrokerSchema.SessionClass.CloseMethodResponseCommand close(final BrokerSchema.SessionClass.CloseMethodResponseCommandFactory factory)
@@ -1343,8 +1343,7 @@ public class QMFService implements ConfigStore.ConfigEventListener
             }
             catch (AMQException e)
             {
-                // TODO Auto-generated catch block
-                e.printStackTrace();
+                return factory.createResponseCommand(CompletionCode.EXCEPTION, e.getMessage());
             }
 
             return factory.createResponseCommand();
diff --git a/java/broker/src/xsl/qmf.xsl b/java/broker/src/xsl/qmf.xsl
index b7690d233a..3a7e10dac8 100644
--- a/java/broker/src/xsl/qmf.xsl
+++ b/java/broker/src/xsl/qmf.xsl
@@ -540,6 +540,16 @@ public class <xsl:value-of select="$ClassName"/> extends QMFPackage
                 _requestCmd = cmd;
             }
             
+            public <xsl:value-of select="$ClassName"/>ResponseCommand createResponseCommand(CompletionCode status)
+            {
+                return new <xsl:value-of select="$ClassName"/>ResponseCommand(_requestCmd, status, null);
+            }
+            
+            public <xsl:value-of select="$ClassName"/>ResponseCommand createResponseCommand(CompletionCode status, String msg)
+            {
+                return new <xsl:value-of select="$ClassName"/>ResponseCommand(_requestCmd, status, msg);
+            }
+            
             public <xsl:value-of select="$ClassName"/>ResponseCommand createResponseCommand( <xsl:apply-templates select="node()[name()='arg' and ( @dir='O' or @dir='IO' ) ]" mode="methodArgList"><xsl:with-param name="includeType">yes</xsl:with-param><xsl:with-param name="direction">O</xsl:with-param></xsl:apply-templates> )
             {
                 return new <xsl:value-of select="$ClassName"/>ResponseCommand(_requestCmd<xsl:if test="node()[name()='arg' and ( @dir='O' or @dir='IO' ) ]">, <xsl:apply-templates select="node()[name()='arg' and ( @dir='O' or @dir='IO' ) ]" mode="methodArgList"><xsl:with-param name="direction">O</xsl:with-param></xsl:apply-templates></xsl:if>);
@@ -551,17 +561,29 @@ public class <xsl:value-of select="$ClassName"/> extends QMFPackage
             <xsl:apply-templates select="node()[name()='arg' and ( @dir='O' or @dir='IO' ) ]" mode="methodInputArgDecl"/>
             private <xsl:value-of select="$ClassName"/>ResponseCommand(QMFMethodRequestCommand cmd<xsl:if test="node()[name()='arg' and ( @dir='O' or @dir='IO' ) ]">, <xsl:apply-templates select="node()[name()='arg' and ( @dir='O' or @dir='IO' ) ]" mode="methodArgList"><xsl:with-param name="includeType">yes</xsl:with-param><xsl:with-param name="direction">O</xsl:with-param></xsl:apply-templates></xsl:if>)
             {
-                super(cmd);
+                super(cmd, CompletionCode.OK, "OK");
                 
                 <xsl:apply-templates select="node()[name()='arg' and ( @dir='O' or @dir='IO' ) ]" mode="methodInputArgAssign"/>
             }
             
+            private <xsl:value-of select="$ClassName"/>ResponseCommand(QMFMethodRequestCommand cmd, CompletionCode status, String msg)
+            {
+                super(cmd, status, msg);
+                
+                <xsl:apply-templates select="node()[name()='arg' and ( @dir='O' or @dir='IO' ) ]" mode="methodInputArgAssignNull"/>
+            }
+            
             @Override
             public void encode(final BBEncoder encoder)
             {
                 super.encode(encoder);
                 
-                <xsl:apply-templates select="node()[name()='arg' and ( @dir='O' or @dir='IO' ) ]" mode="encodeArg"/>
+                <xsl:if test="node()[name()='arg' and ( @dir='O' or @dir='IO' ) ]">
+                if(getStatus().equals(CompletionCode.OK))
+                {
+                    <xsl:apply-templates select="node()[name()='arg' and ( @dir='O' or @dir='IO' ) ]" mode="encodeArg"/>
+                }
+                </xsl:if>
             }
         }
         
@@ -600,6 +622,10 @@ public class <xsl:value-of select="$ClassName"/> extends QMFPackage
     <xsl:template match="node()[name()='arg']" mode="methodInputArgAssign">
                 _<xsl:value-of select="@name"/> = <xsl:value-of select="@name"/>;
     </xsl:template>
+    <xsl:template match="node()[name()='arg']" mode="methodInputArgAssignNull">
+                _<xsl:value-of select="@name"/> = null;
+    </xsl:template>
+    
     
     <xsl:template match="node()[name()='class']" mode="classList">_<xsl:call-template name="initLower"><xsl:with-param name="input" select="@name"/></xsl:call-template>Class<xsl:if test="following-sibling::node()[name()='class']">, </xsl:if></xsl:template>
     <xsl:template match="node()[name()='event']" mode="eventList">_<xsl:call-template name="initLower"><xsl:with-param name="input" select="@name"/></xsl:call-template>EventClass<xsl:if test="following-sibling::node()[name()='event']">, </xsl:if></xsl:template>