You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ch...@apache.org on 2017/12/08 17:12:35 UTC

qpid-dispatch git commit: DISPATCH-897: document vhostUserGroupSettings section

Repository: qpid-dispatch
Updated Branches:
  refs/heads/master c16846096 -> e2966e159


DISPATCH-897: document vhostUserGroupSettings section

Remove the standalone .txt description file and move the section
into qdrouter.json. Configuration files defining vhostUserGroupSettings
objects just use .json file format.


Project: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/commit/e2966e15
Tree: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/tree/e2966e15
Diff: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/diff/e2966e15

Branch: refs/heads/master
Commit: e2966e159d26ce3a0bc117ca003520ddeb15f055
Parents: c168460
Author: Chuck Rolke <cr...@redhat.com>
Authored: Fri Dec 8 12:08:03 2017 -0500
Committer: Chuck Rolke <cr...@redhat.com>
Committed: Fri Dec 8 12:11:33 2017 -0500

----------------------------------------------------------------------
 python/qpid_dispatch/management/qdrouter.json   |  96 ++++++++++++++-
 .../qdrouter.policyRuleset.settings.txt         | 118 -------------------
 tests/system_tests_qdmanage.py                  |   2 +-
 3 files changed, 95 insertions(+), 121 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/e2966e15/python/qpid_dispatch/management/qdrouter.json
----------------------------------------------------------------------
diff --git a/python/qpid_dispatch/management/qdrouter.json b/python/qpid_dispatch/management/qdrouter.json
index 69c7bce..724559d 100644
--- a/python/qpid_dispatch/management/qdrouter.json
+++ b/python/qpid_dispatch/management/qdrouter.json
@@ -1518,14 +1518,106 @@
                 },
                 "groups": {
                     "type": "map",
-                    "description": "A map where each key is a user group name and the value is a map of the corresponding settings for that group.",
+                    "description": "A map where each key is a vhost name and each value is a map of the settings for users of that vhost.",
                     "required": false,
                     "create": true,
                     "update": true
                 }
             }
         },
-        
+
+        "vhostUserGroupSettings": {
+            "description": "Policy settings for users connecting to a vhost. Configuration files including this section must use .json format.",
+            "extends": "configurationEntity",
+            "attributes": {
+                "users": {
+                    "type": "string",
+                    "description": "CSV string or list of authenticated user names. A user may belong to one vhost user group only.",
+                    "required": true
+                },
+                "remoteHosts": {
+                    "type": "string",
+                    "description": "CSV string of numeric host IP addresses or address ranges from which the users may connect.",
+                    "required": true
+                },
+                "maxFrameSize": {
+                    "type": "integer",
+                    "description": "Largest frame that may be sent on this connection. Non-zero policy values overwrite values specified for a listener object. (AMQP Open, max-frame-size)",
+                    "default": 16384,
+                    "required": false,
+                    "create": true
+                },
+                "maxMessageSize": {
+                    "type": "integer",
+                    "description": "[NOT IMPLEMENTED] Largest message size supported by links created on this connection. Non-zero policy values overwrite values specified for a listener object. (AMQP Attach, max-message-size)",
+                    "default": 0,
+                    "required": false,
+                    "create": true
+                },
+                "maxSessionWindow": {
+                    "type": "integer",
+                    "description": "Largest incoming window in octets for sessions created on this connection. Non-zero policy values overwrite values specified for a listener object. (AMQP Begin, incoming-window)",
+                    "default": 1638400,
+                    "required": false,
+                    "create": true
+                },
+                "maxSessions": {
+                    "type": "integer",
+                    "description": "Maximum number of sessions that may be created on this connection. Non-zero policy values overwrite values specified for a listener object. (AMQP Open, channel-max)",
+                    "default": 32768,
+                    "required": false,
+                    "create": true
+                },
+                "maxSenders": {
+                    "type": "integer",
+                    "description": "Maximum number of sending links that may be created on this connection. Zero disables all sender links.",
+                    "default": 2147483647,
+                    "required": false,
+                    "create": true
+                },
+                "maxReceivers": {
+                    "type": "integer",
+                    "description": "Maximum number of receiving links that may be created on this connection. Zero disables all receiver links.",
+                    "default": 2147483647,
+                    "required": false,
+                    "create": true
+                },
+                "allowDynamicSource": {
+                    "type": "boolean",
+                    "description": "This connection is allowed to use the Dynamic Link Source feature.",
+                    "default": false,
+                    "required": false,
+                    "create": true
+                },
+                "allowAnonymousSender": {
+                    "type": "boolean",
+                    "description": "This connection is allowed to use the Anonymous Sender feature.",
+                    "default": false,
+                    "required": false,
+                    "create": true
+                },
+                "allowUserIdProxy": {
+                    "type": "boolean",
+                    "description": "This connection is allowed to send messages with a user_id property that differs from the connection authenticated user name.",
+                    "default": false,
+                    "required": false,
+                    "create": true
+                },
+                "sources": {
+                    "type": "string",
+                    "description": "CSV list of Source addresses allowed when creating receiving links.",
+                    "required": false,
+                    "create": true
+                },
+                "targets": {
+                    "type": "string",
+                    "description": "CSV list of Target addresses allowed when creating sending links.",
+                    "required": false,
+                    "create": true
+                }
+            }
+        },
+
         "vhostStats": {
             "description": "Virtual host connection and access statistics.",
             "extends": "operationalEntity",

http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/e2966e15/python/qpid_dispatch/management/qdrouter.policyRuleset.settings.txt
----------------------------------------------------------------------
diff --git a/python/qpid_dispatch/management/qdrouter.policyRuleset.settings.txt b/python/qpid_dispatch/management/qdrouter.policyRuleset.settings.txt
deleted file mode 100644
index da389ff..0000000
--- a/python/qpid_dispatch/management/qdrouter.policyRuleset.settings.txt
+++ /dev/null
@@ -1,118 +0,0 @@
-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.
-
-
-
-The schema `qdrouterd.json` is a JSON format file that defines
-entity types of the Qpid Dispatch Router management model.  The model is based
-on the AMQP management specification.
-
-Schema entity `vhost` includes several attributes of type map. In the current form the management schema provides no way to define the keys and values in these attributes. These maps cannot be specified in the schema and they cannot be checked by the schema processing. 
-
-Until the schema is extended specify embedded maps this document describes the vhost settings.
-
-  "vhostUserGroupSettings": {
-      "description": "For a given user group define group membership, remote hosts, the policy settings applied to the user's AMQP connection.",
-      "extends": "configurationEntity",
-      "attributes": {
-          "users": {
-              "type": "string",
-              "description": "CSV string or list of authenticated user names. A user may belong to one group only.",
-              "required": true
-          },
-          "remoteHosts": {
-              "type": "string",
-              "description": "CSV string of numeric host IP addresses or address ranges from which the users may connect.",
-              "required": true
-          },
-          "maxFrameSize": {
-              "type": "integer",
-              "description": "Largest frame that may be sent on this connection. Non-zero policy values overwrite values specified for a listener object. (AMQP Open, max-frame-size)",
-              "default": 16384,
-              "required": false,
-              "create": true
-          },
-          "maxMessageSize": {
-              "type": "integer",
-              "description": "[NOT IMPLEMENTED] Largest message size supported by links created on this connection. Non-zero policy values overwrite values specified for a listener object. (AMQP Attach, max-message-size)",
-              "default": 0,
-              "required": false,
-              "create": true
-          },
-          "maxSessionWindow": {
-              "type": "integer",
-              "description": "Largest incoming window in octets for sessions created on this connection. Non-zero policy values overwrite values specified for a listener object. (AMQP Begin, incoming-window)",
-              "default": 1638400,
-              "required": false,
-              "create": true
-          },
-          "maxSessions": {
-              "type": "integer",
-              "description": "Maximum number of sessions that may be created on this connection. Non-zero policy values overwrite values specified for a listener object. (AMQP Open, channel-max)",
-              "default": 32768,
-              "required": false,
-              "create": true
-          },
-          "maxSenders": {
-              "type": "integer",
-              "description": "Maximum number of sending links that may be created on this connection. Zero disables all sender links.",
-              "default": 2147483647,
-              "required": false,
-              "create": true
-          },
-          "maxReceivers": {
-              "type": "integer",
-              "description": "Maximum number of receiving links that may be created on this connection. Zero disables all receiver links.",
-              "default": 2147483647,
-              "required": false,
-              "create": true
-          },
-          "allowDynamicSource": {
-              "type": "boolean",
-              "description": "This connection is allowed to use the dynamic link source feature.",
-              "default": false,
-              "required": false,
-              "create": true
-          },
-          "allowAnonymousSender": {
-              "type": "boolean",
-              "description": "This connection is allowed to use the Anonymous Sender feature.",
-              "default": false,
-              "required": false,
-              "create": true
-          },
-          "allowUserIdProxy": {
-              "type": "boolean",
-              "description": "This connection is allowed to send messages with a user_id property that differs from the connection authenticated user name.",
-              "default": false,
-              "required": false,
-              "create": true
-          },
-          "sources": {
-              "type": "string",
-              "description": "List of Source addresses allowed when creating receiving links.",
-              "required": false,
-              "create": true
-          },
-          "targets": {
-              "type": "string",
-              "description": "List of Target addresses allowed when creating sending links.",
-              "required": false,
-              "create": true
-          }
-      }
-  }

http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/e2966e15/tests/system_tests_qdmanage.py
----------------------------------------------------------------------
diff --git a/tests/system_tests_qdmanage.py b/tests/system_tests_qdmanage.py
index 38784ae..86f1fd6 100644
--- a/tests/system_tests_qdmanage.py
+++ b/tests/system_tests_qdmanage.py
@@ -177,7 +177,7 @@ class QdmanageTest(TestCase):
 
     def test_get_types(self):
         out = json.loads(self.run_qdmanage("get-types"))
-        self.assertEqual(len(out), 25)
+        self.assertEqual(len(out), 26)
 
     def test_get_log(self):
         log = json.loads(self.run_qdmanage("get-log limit=1"))[0]


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org