QPID-689 from tross@redhat.com.

This patch introduces formal schema specification for management and
code generation for management classes.


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

3 files changed, 216 insertions, 0 deletions

diff --git a/qpid/cpp/managementgen/templates/Args.h b/qpid/cpp/managementgen/templates/Args.h
new file mode 100644
index 0000000000..4a6413ddc9
--- /dev/null
+++ b/qpid/cpp/managementgen/templates/Args.h
@@ -0,0 +1,39 @@
+#ifndef _ARGS_/*MGEN:Method.NameUpper*/_
+#define _ARGS_/*MGEN:Method.NameUpper*/_
+
+//
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+// 
+//   http://www.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+//
+
+/*MGEN:Root.Disclaimer*/
+
+#include "qpid/management/Args.h"
+#include <string>
+
+namespace qpid { 
+namespace management {
+
+class Args/*MGEN:Method.NameCamel*/ : public Args
+{
+  public:
+/*MGEN:Method.Arguments*/
+};
+
+}}
+
+#endif  /*!_ARGS_/*MGEN:Method.NameUpper*/_*/
diff --git a/qpid/cpp/managementgen/templates/Class.cpp b/qpid/cpp/managementgen/templates/Class.cpp
new file mode 100644
index 0000000000..70077d495c
--- /dev/null
+++ b/qpid/cpp/managementgen/templates/Class.cpp
@@ -0,0 +1,108 @@
+//
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+// 
+//   http://www.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+//
+
+/*MGEN:Root.Disclaimer*/
+
+#include "qpid/log/Statement.h"
+#include "qpid/framing/FieldTable.h"
+#include "qpid/management/Manageable.h" 
+#include "/*MGEN:Class.NameCap*/.h"
+/*MGEN:Class.MethodArgIncludes*/
+
+using namespace qpid::management;
+using namespace qpid::sys;
+using namespace qpid::framing;
+using           std::string;
+
+bool /*MGEN:Class.NameCap*/::schemaNeeded = true;
+
+/*MGEN:Class.NameCap*/::/*MGEN:Class.NameCap*/ (Manageable* _core, Manageable*/*MGEN:Class.ParentArg*/, 
+              /*MGEN:Class.ConstructorArgs*/) :
+    ManagementObject(_core, "/*MGEN:Class.NameLower*/")
+    /*MGEN:Class.ConstructorInits*/
+{
+    /*MGEN:Class.ParentRefAssignment*/
+/*MGEN:Class.InitializeElements*/
+}
+
+/*MGEN:Class.NameCap*/::~/*MGEN:Class.NameCap*/ () {}
+
+namespace {
+    const string NAME("name");
+    const string TYPE("type");
+    const string ACCESS("access");
+    const string INDEX("index");
+    const string UNIT("unit");
+    const string MIN("min");
+    const string MAX("max");
+    const string MAXLEN("maxlen");
+    const string DESC("desc");
+}
+
+void /*MGEN:Class.NameCap*/::writeSchema (Buffer& buf)
+{
+    FieldTable ft;
+    /*MGEN:Class.ArgDeclaration*/
+
+    schemaNeeded = false;
+
+    // Schema class header:
+    buf.putShortString (className);  // Class Name
+    buf.putShort       (/*MGEN:Class.ConfigCount*/); // Config Element Count
+    buf.putShort       (/*MGEN:Class.InstCount*/); // Inst Element Count
+    buf.putShort       (/*MGEN:Class.MethodCount*/); // Method Count
+    buf.putShort       (/*MGEN:Class.EventCount*/); // Event Count
+
+    // Config Elements
+/*MGEN:Class.ConfigElementSchema*/
+    // Inst Elements
+/*MGEN:Class.InstElementSchema*/
+    // Methods
+/*MGEN:Class.MethodSchema*/
+    // Events
+/*MGEN:Class.EventSchema*/
+}
+
+void /*MGEN:Class.NameCap*/::writeConfig (Buffer& buf)
+{
+    configChanged = false;
+
+    writeTimestamps (buf);
+/*MGEN:Class.WriteConfig*/
+}
+
+void /*MGEN:Class.NameCap*/::writeInstrumentation (Buffer& buf)
+{
+    instChanged = false;
+
+    writeTimestamps (buf);
+/*MGEN:Class.WriteInst*/
+
+    // Maintenance of hi-lo statistics
+/*MGEN:Class.HiLoStatResets*/
+}
+
+void /*MGEN:Class.NameCap*/::doMethod (/*MGEN:Class.DoMethodArgs*/)
+{
+    Manageable::status_t status = Manageable::STATUS_UNKNOWN_METHOD;
+/*MGEN:Class.MethodHandlers*/
+    outBuf.putLong        (status);
+    outBuf.putShortString (Manageable::StatusText (status));
+}
+
diff --git a/qpid/cpp/managementgen/templates/Class.h b/qpid/cpp/managementgen/templates/Class.h
new file mode 100644
index 0000000000..cff915412e
--- /dev/null
+++ b/qpid/cpp/managementgen/templates/Class.h
@@ -0,0 +1,69 @@
+#ifndef _MANAGEMENT_/*MGEN:Class.NameUpper*/_
+#define _MANAGEMENT_/*MGEN:Class.NameUpper*/_
+
+//
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+// 
+//   http://www.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+//
+
+/*MGEN:Root.Disclaimer*/
+
+#include "qpid/management/ManagementObject.h"
+
+namespace qpid { 
+namespace management {
+
+class /*MGEN:Class.NameCap*/ : public ManagementObject
+{
+  private:
+
+    static bool schemaNeeded;
+
+    // Configuration Elements
+/*MGEN:Class.ConfigDeclarations*/
+    // Instrumentation Elements
+/*MGEN:Class.InstDeclarations*/
+    // Private Methods
+    std::string getObjectName (void) { return "/*MGEN:Class.NameLower*/"; }
+    void writeSchema          (qpid::framing::Buffer& buf);
+    void writeConfig          (qpid::framing::Buffer& buf);
+    void writeInstrumentation (qpid::framing::Buffer& buf);
+    bool getSchemaNeeded      (void) { return schemaNeeded; }
+    void setSchemaNeeded      (void) { schemaNeeded = true; }
+    void doMethod             (std::string            methodName,
+                               qpid::framing::Buffer& inBuf,
+                               qpid::framing::Buffer& outBuf);
+
+/*MGEN:Class.InstChangedStub*/
+  public:
+
+    typedef boost::shared_ptr</*MGEN:Class.NameCap*/> shared_ptr;
+
+    /*MGEN:Class.NameCap*/ (Manageable* coreObject, Manageable* parentObject,
+        /*MGEN:Class.ConstructorArgs*/);
+    ~/*MGEN:Class.NameCap*/ (void);
+
+    // Method IDs
+/*MGEN:Class.MethodIdDeclarations*/
+    // Accessor Methods
+/*MGEN:Class.AccessorMethods*/
+};
+
+}}
+            
+
+#endif  /*!_MANAGEMENT_/*MGEN:Class.NameUpper*/_*/