You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ac...@apache.org on 2015/03/12 21:25:45 UTC
svn commit: r1666288 [8/8] - in /qpid/dispatch/branches/0.4/doc/pre_built:
./ doc/ doc/qpid-dispatch/ doc/qpid-dispatch/book/ doc/qpid-dispatch/html/
doc/qpid-dispatch/html/_sources/ doc/qpid-dispatch/html/_sources/book/
doc/qpid-dispatch/html/_sources...
Added: qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/qdrouter.json
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/qdrouter.json?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/qdrouter.json (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/qdrouter.json Thu Mar 12 20:25:44 2015
@@ -0,0 +1,878 @@
+{
+ "description": "Schema for the Qpid Dispatch Router management model. See qdrouter.json.readme.txt.",
+
+ "prefix": "org.apache.qpid.dispatch",
+
+ "annotations": {
+
+ "addrPort": {
+ "description": "Attributes for internet address and port.",
+ "attributes": {
+ "addr": {
+ "description":"IP address: ipv4 or ipv6 literal or a host name.",
+ "type": "string",
+ "default": "0.0.0.0",
+ "create": true
+ },
+ "port": {
+ "description": "Port number or symbolic service name.",
+ "type": "string",
+ "default": "amqp",
+ "create": true
+
+ }
+ }
+ },
+
+ "saslMechanisms": {
+ "description": "Attribute for a list of SASL mechanisms.",
+ "attributes": {
+ "saslMechanisms": {
+ "type": "string",
+ "required": true,
+ "description": "Comma separated list of accepted SASL authentication mechanisms.",
+ "create": true
+
+ }
+ }
+ },
+
+ "connectionRole": {
+ "description": "Attribute for the role of a connection.",
+ "attributes": {
+ "role": {
+ "type": [
+ "normal",
+ "inter-router",
+ "on-demand"
+ ],
+ "default": "normal",
+ "description": "The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections.",
+ "create": true
+ }
+ }
+ },
+
+ "sslProfile": {
+ "description":"Attributes for setting TLS/SSL configuration for connections.",
+ "attributes": {
+ "certDb": {
+ "type": "path",
+ "description": "The path to the database that contains the public certificates of trusted certificate authorities (CA).",
+ "create": true
+ },
+ "certFile": {
+ "type": "path",
+ "description": "The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.",
+ "create": true
+
+ },
+ "keyFile": {
+ "type": "path",
+ "description": "The path to the file containing the PEM-formatted private key for the above certificate.",
+ "create": true
+
+ },
+ "passwordFile": {
+ "type": "path",
+ "description": "If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.",
+ "create": true
+
+ },
+ "password": {
+ "type": "string",
+ "description": "An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the 'password' option. Don't use both password and passwordFile in the same profile.",
+ "create": true
+
+ }
+ }
+ }
+ },
+
+ "entityTypes": {
+
+ "entity": {
+ "description": "Base entity type for all entities.",
+ "attributes": {
+ "name": {
+ "type": "string",
+ "unique": true,
+ "description": "Unique name optionally assigned by user. Can be changed.",
+ "create": true
+ },
+ "identity": {
+ "type": "string",
+ "unique": true,
+ "description": "Unique identity generated by the system. Will not change."
+ },
+ "type": {
+ "type": "string",
+ "required": true,
+ "value": "$$entityType",
+ "description": "Management entity type.",
+ "create": true
+ }
+ },
+
+ "operationDefs": {
+ "CREATE": {
+ "description": "Create a new entity.",
+ "request": {
+ "properties": {
+ "name": {
+ "description": "Name of new entity. Optional, defaults to identity.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of new entity.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "body": {
+ "description": "Attributes for the new entity. Can include name and/or type.",
+ "type": "map",
+ "required": true
+ }
+ },
+ "response": {
+ "body": {
+ "description": "Attributes of the entity",
+ "type": "map"
+ }
+ }
+ },
+ "READ": {
+ "description": "Read attributes of an entity",
+ "request": {
+ "properties": {
+ "name": {
+ "description": "Name of desired entity. Must supply name or identity.",
+ "type": "string"
+ },
+ "identity": {
+ "description": "Identity of desired entity. Must supply name or identity.",
+ "type": "string"
+
+ },
+ "type": {
+ "description": "Type of desired entity.",
+ "type": "string"
+ }
+ }
+ },
+ "response": {
+ "body": {
+ "description": "Attributes of the entity",
+ "type": "map"
+ }
+ }
+ },
+ "UPDATE": {
+ "description": "Update attributes of an entity",
+ "request": {
+ "properties": {
+ "name": {
+ "description": "Name of desired entity. Must supply name or identity.",
+ "type": "string"
+ },
+ "identity": {
+ "description": "Identity of desired entity. Must supply name or identity.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of desired entity.",
+ "type": "string"
+ }
+ },
+ "body": {
+ "description": "Attributes to update for the entity. Can include name or identity.",
+ "type": "map"
+ }
+ },
+ "response": {
+ "body": {
+ "description": "Updated attributes of the entity",
+ "type": "map"
+ }
+ }
+ },
+ "DELETE": {
+ "description": "Delete an entity",
+ "request": {
+ "properties": {
+ "name": {
+ "description": "Name of desired entity. Must supply name or identity.",
+ "type": "string"
+
+ },
+ "identity": {
+ "description": "Identity of desired entity. Must supply name or identity.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of desired entity.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+
+ "org.amqp.management": {
+ "description": "The standard AMQP management node interface.",
+ "fullName": true,
+ "extends": "operationalEntity",
+ "operations": ["QUERY", "GET-TYPES", "GET-ANNOTATIONS", "GET-OPERATIONS", "GET-ATTRIBUTES", "GET-MGMT-NODES"],
+ "operationDefs": {
+ "QUERY": {
+ "description": "Query for attribute values of multiple entities.",
+ "request": {
+ "properties": {
+ "identity": {
+ "description": "Set to the value `self`",
+ "type": "string"
+ },
+ "entityType": {
+ "description": "If set, restrict query results to entities that extend (directly or indirectly) this type",
+ "type": "string"
+ },
+ "offset": {
+ "description": "If set, specifies the number of the first element of the result set to be returned.",
+ "type": "integer",
+ "default": 0
+ },
+ "count": {
+ "description": "If set, specifies the number of entries from the result set to return. If not set return all from `offset`",
+ "type": "integer"
+ }
+ },
+ "body": {
+ "description": "A map containing the key `attributeNames` with value a list of (string) attribute names to return. If the list or the map is empty or the body is missing all attributes are returned.",
+ "type": "map"
+ }
+ },
+ "response": {
+ "properties": {
+ "identity": {
+ "description": "Set to the value `self`",
+ "type": "string"
+ },
+ "count": {
+ "description": "Number of results returned",
+ "type": "integer"
+ }
+ },
+ "body": {
+ "description": "A map with two entries. `attributeNames` is a list of the attribute names returned. `results` is a list of lists each containing the attribute values for a single entity in the same order as the names in the `attributeNames` entry. If an attribute name is not applicable for an entity then the corresponding value is `null`",
+ "type": "map"
+ }
+ }
+ },
+ "GET-TYPES": {
+ "description": "Get the set of entity types and their inheritance relationships",
+ "request": {
+ "properties": {
+ "identity": {
+ "description": "Set to the value `self`",
+ "type": "string"
+ },
+ "entityType": {
+ "description": "If set, restrict query results to entities that extend (directly or indirectly) this type",
+ "type": "string"
+ }
+ }
+ },
+ "response": {
+ "body": {
+ "description": "A map where each key is an entity type name (string) and the corresponding value is the list of the entity types (strings) that it extends.",
+ "type": "map"
+ }
+ }
+ },
+ "GET-OPERATIONS": {
+ "description": "Get the set of entity types and the operations they support",
+ "request": {
+ "properties": {
+ "identity": {
+ "description": "Set to the value `self`",
+ "type": "string"
+ },
+ "entityType": {
+ "description": "If set, restrict query results to entities that extend (directly or indirectly) this type",
+ "type": "string"
+ }
+ }
+ },
+ "response": {
+ "body": {
+ "description": "A map where each key is an entity type name (string) and the corresponding value is the list of operation names (strings) that it supports.",
+ "type": "map"
+ }
+ }
+ },
+ "GET-ANNOTATIONS": {
+ "request": {
+ "properties": {
+ "identity": {
+ "description": "Set to the value `self`",
+ "type": "string"
+ },
+ "entityType": {
+ "description": "If set, restrict query results to entities that extend (directly or indirectly) this type",
+ "type": "string"
+ }
+ }
+ },
+ "response": {
+ "body": {
+ "description": "A map where each key is an entity type name (string) and the corresponding value is the list of annotations (strings) that it implements.",
+ "type": "map"
+ }
+ }
+ },
+ "GET-ATTRIBUTES": {
+ "description": "Get the set of entity types and the annotations they implement",
+ "request": {
+ "properties": {
+ "identity": {
+ "description": "Set to the value `self`",
+ "type": "string"
+ },
+ "entityType": {
+ "description": "If set, restrict query results to entities that extend (directly or indirectly) this type",
+ "type": "string"
+ }
+ }
+ },
+ "response": {
+ "body": {
+ "description": "A map where each key is an entity type name (string) and the corresponding value is a list (of strings) of attributes on that entity type.",
+ "type": "map"
+ }
+ }
+ },
+ "GET-MGMT-NODES": {
+ "description": "Get the addresses of all management nodes known to this router",
+ "request": {
+ "properties": {
+ "identity": {
+ "description": "Set to the value `self`",
+ "type": "string"
+ }
+ }
+ },
+ "response": {
+ "body": {
+ "description": "A list of addresses (strings) of management nodes known to this management node.",
+ "type": "list"
+ }
+ }
+ }
+ }
+ },
+
+ "management": {
+ "description": "Qpid dispatch router extensions to the standard org.amqp.management interface.",
+ "extends": "org.amqp.management",
+ "singleton": true,
+ "operations": ["GET-SCHEMA", "GET-JSON-SCHEMA"],
+ "operationDefs": {
+ "GET-SCHEMA": {
+ "description": "Get the qdrouterd schema for this router in AMQP map format",
+ "request": {
+ "properties": {
+ "identity": {
+ "description": "Set to the value `self`",
+ "type": "string"
+ }
+ }
+ },
+ "response": {
+ "body": {
+ "description": "The qdrouter schema as a map.",
+ "type": "map"
+ }
+ }
+ },
+ "GET-SCHEMA-JSON": {
+ "description": "Get the qdrouterd schema for this router in JSON format",
+ "request": {
+ "properties": {
+ "identity": {
+ "description": "Set to the value `self`",
+ "type": "string"
+ },
+ "indent": {
+ "description": "Number of spaces to indent the formatted result. If not specified, the result is in minimal format, no unnecessary spaces or newlines.",
+ "type": "integer"
+ }
+ }
+ },
+ "response": {
+ "body": {
+ "description": "The qdrouter schema as a JSON string.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+
+ "configurationEntity": {
+ "description": "Base type for entities containing configuration information.",
+ "extends": "entity",
+ "attributes": {},
+ "operations": ["READ"]
+ },
+
+ "operationalEntity": {
+ "description": "Base type for entities containing current operational information.",
+ "extends": "entity",
+ "operations": ["READ"],
+ "attributes": {}
+ },
+
+ "container": {
+ "description":"Attributes related to the AMQP container.",
+ "extends": "configurationEntity",
+
+ "singleton": true,
+ "attributes": {
+ "containerName": {
+ "type": "string",
+ "description": "The name of the AMQP container. If not specified, the container name will be set to a value of the container's choosing. The automatically assigned container name is not guaranteed to be persistent across restarts of the container.",
+ "create": true
+
+ },
+ "workerThreads": {
+ "type": "integer",
+ "default": 1,
+ "description": "The number of threads that will be created to process message traffic and other application work (timers, non-amqp file descriptors, etc.) .",
+ "create": true
+
+ },
+ "debugDump": {
+ "type": "path",
+ "description": "A file to dump debugging information that can't be logged normally.",
+ "create": true
+
+ }
+ }
+ },
+
+ "router": {
+ "description":"Tracks peer routers and computes routes to destinations.",
+ "extends": "configurationEntity",
+ "singleton": true,
+ "attributes": {
+ "routerId": {
+ "description":"Router's unique identity.",
+ "type": "string",
+ "create": true
+ },
+ "mode": {
+ "type": [
+ "standalone",
+ "interior",
+ "edge",
+ "endpoint"
+ ],
+ "default": "standalone",
+ "description": "In standalone mode, the router operates as a single component. It does not participate in the routing protocol and therefore will not cooperate with other routers. In interior mode, the router operates in cooperation with other interior routers in an interconnected network. In edge mode, the router operates with an up link into an interior router network. Edge routers are typically used as connection concentrators or as security firewalls for access into the interior network.",
+ "create": true
+ },
+ "area": {
+ "type": "string",
+ "description": "Unused placeholder.",
+ "default": 0
+ },
+ "helloInterval": {
+ "type": "integer",
+ "default": 1,
+ "description": "Interval in seconds between HELLO messages sent to neighbor routers.",
+ "create": true
+ },
+ "helloMaxAge": {
+ "type": "integer",
+ "default": 3,
+ "description": "Time in seconds after which a neighbor is declared lost if no HELLO is received.",
+ "create": true
+ },
+ "raInterval": {
+ "type": "integer",
+ "default": 30,
+ "description": "Interval in seconds between Router-Advertisements sent to all routers in a stable network.",
+ "create": true
+ },
+ "raIntervalFlux": {
+ "type": "integer",
+ "default": 4,
+ "description": "Interval in seconds between Router-Advertisements sent to all routers during topology fluctuations.",
+ "create": true
+ },
+ "remoteLsMaxAge": {
+ "type": "integer",
+ "default": 60,
+ "description": "Time in seconds after which link state is declared stale if no RA is received.",
+ "create": true
+ },
+ "mobileAddrMaxAge": {
+ "type": "integer",
+ "default": 60,
+ "description": "Deprecated - This value is no longer used in the router.",
+ "create": true
+ },
+ "addrCount": {
+ "type":
+ "integer", "description":"Number of addresses known to the router."
+ },
+ "linkCount": {
+ "type": "integer",
+ "description":"Number of links attached to the router node."
+ },
+ "nodeCount": {
+ "type": "integer",
+ "description":"Number of known peer router nodes."
+ }
+ }
+ },
+
+ "listener": {
+ "description": "Listens for incoming connections to the router.",
+ "extends": "configurationEntity",
+ "operations": ["CREATE"],
+ "annotations": [
+ "addrPort",
+ "connectionRole",
+ "sslProfile",
+ "saslMechanisms"
+ ],
+ "attributes": {
+ "requirePeerAuth": {
+ "type": "boolean",
+ "default": true,
+ "description": "Only for listeners using SSL. If set to 'yes', attached clients will be required to supply a certificate. If the certificate is not traceable to a CA in the ssl profile's cert-db, authentication fails for the connection.",
+ "create": true
+ },
+ "trustedCerts": {
+ "type": "path",
+ "description": "This optional setting can be used to reduce the set of available CAs for client authentication. If used, this setting must provide a path to a PEM file that contains the trusted certificates.",
+ "create": true
+ },
+ "allowUnsecured": {
+ "type": "boolean",
+ "default": false,
+ "description": "For listeners using SSL only. If set to 'yes' the listener will allow both SSL-secured clients and non-SSL clients to connect.",
+ "create": true
+ },
+ "allowNoSasl": {
+ "type": "boolean",
+ "default": false,
+ "description": "If set to 'yes', this option causes the listener to allow clients to connect even if they skip the SASL authentication protocol.",
+ "create": true
+ },
+ "maxFrameSize": {
+ "type": "integer",
+ "default": 65536,
+ "description": "Defaults to 65536. If specified, it is the maximum frame size in octets that will be used in the connection-open negotiation with a connected peer. The frame size is the largest contiguous set of uninterrupted data that can be sent for a message delivery over the connection. Interleaving of messages on different links is done at frame granularity.",
+ "create": true
+ }
+ }
+ },
+
+ "connector": {
+ "description": "Establishes an outgoing connections from the router.",
+ "extends": "configurationEntity",
+ "operations": ["CREATE"],
+ "annotations": [
+ "addrPort",
+ "connectionRole",
+ "sslProfile",
+ "saslMechanisms"
+ ],
+ "attributes": {
+ "allowRedirect": {
+ "type": "boolean",
+ "default": true,
+ "description": "Allow the peer to redirect this connection to another address.",
+ "create": true
+ },
+ "maxFrameSize": {
+ "type": "integer",
+ "default": 65536,
+ "description": "Maximum frame size in octets that will be used in the connection-open negotiation with a connected peer. The frame size is the largest contiguous set of uninterrupted data that can be sent for a message delivery over the connection. Interleaving of messages on different links is done at frame granularity.",
+ "create": true
+ }
+ }
+ },
+
+ "log": {
+ "description": "Configure logging for a particular module. You can use the `UPDATE` operation to change log settings while the router is running.",
+ "extends": "configurationEntity",
+ "operations": ["UPDATE"],
+ "attributes": {
+ "module": {
+ "type":[
+ "ROUTER",
+ "ROUTER_HELLO",
+ "ROUTER_LS",
+ "ROUTER_MA",
+ "MESSAGE",
+ "SERVER",
+ "AGENT",
+ "CONTAINER",
+ "CONFIG",
+ "ERROR",
+ "DISPATCH",
+ "DEFAULT"
+ ],
+ "required": true,
+ "description": "Module to configure. The special module 'DEFAULT' specifies defaults for all modules."
+ },
+ "enable": {
+ "type": "string",
+ "default": "default",
+ "required": true,
+ "description": "Levels are: trace, debug, info, notice, warning, error, critical. The enable string is a comma-separated list of levels. A level may have a trailing '+' to enable that level and above. For example 'trace,debug,warning+' means enable trace, debug, warning, error and critical. The value 'none' means disable logging for the module. The value 'default' means use the value from the DEFAULT module.",
+ "update": true
+ },
+ "timestamp": {
+ "type": "boolean",
+ "description": "Include timestamp in log messages.",
+ "update": true
+ },
+ "source": {
+ "type": "boolean",
+ "description": "Include source file and line number in log messages.",
+ "update": true
+ },
+ "output": {
+ "type": "string",
+ "description": "Where to send log messages. Can be 'stderr', 'syslog' or a file name.",
+ "update": true
+ }
+ }
+ },
+
+ "fixedAddress": {
+ "description":"Establishes semantics for addresses starting with a prefix.",
+ "extends": "configurationEntity",
+ "operations": ["CREATE"],
+ "attributes": {
+ "prefix": {
+ "type": "string",
+ "required": true,
+ "description": "The address prefix (always starting with '/').",
+ "create": true
+ },
+ "phase": {
+ "type": "integer",
+ "description": "The phase of a multi-hop address passing through one or more waypoints.",
+ "create": true
+ },
+ "fanout": {
+ "type": [
+ "multiple",
+ "single"
+ ],
+ "default": "multiple",
+ "description": "One of 'multiple' or 'single'. Multiple fanout is a non-competing pattern. If there are multiple consumers using the same address, each consumer will receive its own copy of every message sent to the address. Single fanout is a competing pattern where each message is sent to only one consumer.",
+ "create": true
+ },
+ "bias": {
+ "type": [
+ "closest",
+ "spread"
+ ],
+ "default": "closest",
+ "description": "Only if fanout is single. One of 'closest' or 'spread'. Closest bias means that messages to an address will always be delivered to the closest (lowest cost) subscribed consumer. Spread bias will distribute the messages across subscribers in an approximately even manner.",
+ "create": true
+ }
+ }
+ },
+
+ "waypoint": {
+ "description":"A remote node that messages for an address pass through.",
+ "extends": "configurationEntity",
+ "operations": ["CREATE"],
+ "attributes": {
+ "address": {
+ "description":"The AMQP address of the waypoint.",
+ "type": "string",
+ "required": true,
+ "create": true
+ },
+ "connector": {
+ "description":"The name of the on-demand connector used to reach the waypoint's container.",
+ "type": "string",
+ "required": true,
+ "create": true
+ },
+ "inPhase": {
+ "description":"The phase of the address as it is routed _to_ the waypoint.",
+ "type": "integer",
+ "default": -1,
+ "create": true
+ },
+ "outPhase": {
+ "description":"The phase of the address as it is routed _from_ the waypoint.",
+ "type": "integer",
+ "default": -1,
+ "create": true
+ }
+ }
+ },
+
+ "linkRoutePattern": {
+ "description":"A pattern to match a connected container to endpoints for routed links.",
+ "extends": "configurationEntity",
+ "operations": ["CREATE"],
+ "attributes": {
+ "prefix": {
+ "description":"The AMQP address prefix for nodes on the container.",
+ "type": "string",
+ "required": true,
+ "create": true
+ },
+ "connector": {
+ "description":"The name of the on-demand connector used to reach the waypoint's container.",
+ "type": "string",
+ "required": false,
+ "default": "",
+ "create": true
+ }
+ }
+ },
+
+ "router.link": {
+ "description": "Link to another AMQP endpoint: router node, client or other AMQP process.",
+ "extends": "operationalEntity",
+ "attributes": {
+ "linkName": {"type": "string"},
+ "linkType": {"type": ["endpoint", "waypoint", "inter-router", "inter-area"]},
+ "linkDir": {"type": ["in", "out"]},
+ "owningAddr": {"type": "string"},
+ "eventFifoDepth": {"type": "integer"},
+ "msgFifoDepth": {"type": "integer"},
+ "remoteContainer": {"type": "string"}
+ }
+ },
+
+ "router.address": {
+ "description": "AMQP address managed by the router.",
+ "extends": "operationalEntity",
+ "attributes": {
+ "inProcess": {"type": "boolean"},
+ "subscriberCount": {"type": "integer"},
+ "remoteCount": {"type": "integer"},
+ "deliveriesIngress": {"type": "integer"},
+ "deliveriesEgress": {"type": "integer"},
+ "deliveriesTransit": {"type": "integer"},
+ "deliveriesToContainer": {"type": "integer"},
+ "deliveriesFromContainer": {"type": "integer"},
+ "key": {
+ "description": "Internal unique (to this router) key to identify the address",
+ "type": "string"
+ }
+ }
+ },
+
+ "router.node": {
+ "description": "Remote router node connected to this router.",
+ "extends": "operationalEntity",
+ "attributes": {
+ "routerId": {
+ "description": "Remote node identifier.",
+ "type": "string"
+ },
+ "instance": {
+ "description": "Remote node boot number.",
+ "type": "integer"
+ },
+ "linkState": {
+ "description": "List of remote node's neighbours.",
+ "type": "list"
+ },
+ "nextHop": {
+ "description": "Neighbour ID of next hop to remote node from here.",
+ "type": "string"
+ },
+ "validOrigins": {
+ "description": "List of valid origin nodes for messages arriving via the remote node, used for duplicate elimination in redundant networks.",
+ "type": "list"
+ },
+ "address": {
+ "description": "Address of the remote node",
+ "type": "string"
+ },
+ "routerLink": {
+ "description": "Local link to remote node",
+ "type": "entityId"
+ }
+ }
+ },
+
+ "connection": {
+ "description": "Connections to the router's container.",
+ "extends": "operationalEntity",
+ "attributes": {
+ "container": {
+ "description": "The container for this connection",
+ "type": "string"
+ } ,
+ "state": {
+ "type": [
+ "connecting",
+ "opening",
+ "operational",
+ "failed",
+ "user"
+ ]},
+ "host": {
+ "description": "IP address and port number in the form addr:port.",
+ "type": "string"
+ },
+ "dir": {
+ "description": "Direction of connection establishment in or out of the router.",
+ "type": ["in", "out"]
+ },
+ "role": {"type": "string"},
+ "sasl": {
+ "description": "SASL mechanism used for authentication.",
+ "type": "string"
+ }
+ }
+ },
+
+ "allocator": {
+ "description": "Memory allocation pool.",
+ "extends": "operationalEntity",
+ "attributes": {
+ "typeName": {"type": "string"},
+ "typeSize": {"type": "integer"},
+ "transferBatchSize": {"type": "integer"},
+ "localFreeListMax": {"type": "integer"},
+ "globalFreeListMax": {"type": "integer"},
+ "totalAllocFromHeap": {"type": "integer"},
+ "totalFreeToHeap": {"type": "integer"},
+ "heldByThreads": {"type": "integer"},
+ "batchesRebalancedToThreads": {"type": "integer"},
+ "batchesRebalancedToGlobal": {"type": "integer"}
+ }
+ },
+
+ "dummy": {
+ "description": "Dummy entity for test purposes.",
+ "extends": "entity",
+ "operations": ["CREATE", "READ", "UPDATE", "DELETE", "CALLME"],
+ "attributes": {
+ "arg1": {"type": "string", "create": true, "update": true},
+ "arg2": {"type": "string", "create": true, "update": true},
+ "num1": {"type": "integer", "create": true, "update": true},
+ "num2": {"type": "integer", "create": true, "update": true}
+ }
+ }
+ }
+}
Added: qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/qdrouter.json.readme.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/qdrouter.json.readme.txt?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/qdrouter.json.readme.txt (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/qdrouter.json.readme.txt Thu Mar 12 20:25:44 2015
@@ -0,0 +1,90 @@
+<!--*-markdown-*-
+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 qdrouter management schema
+
+The schema `qdrouterd.json` is a JSON format file that defines annotations and
+entity types of the Qpid Dispatch Router management model. The model is based
+on the AMQP management specification.
+
+The schema is a JSON map with the following keys:
+
+- "description": documentation string for the schema
+- "prefix": Prefix for schema names when they are exposed to AMQP management clients.
+
+- "entityTypes": map of entity type names to definitions (see below)
+
+Annotation and entity type definition maps have the following keys:
+
+- "description": documentation string.
+- "fullName": if true use the type name as-is, do not apply the schema prefix.
+- "attributes": map of attribute names to attribute definitions (see below)
+- "operations": list of allowed operation names.
+- "operationsDefs": map of operation names to operation definitions.
+
+Entity type definitions also have these fields:
+
+- "extends": Name of base type. The new type includes attributes, operations and operationDefs from the base type.
+- "annotations": List of annotation names. The new type includes operations and attributes from all the annotations.
+
+Operation definitions are optional, you can call an operation in the operations
+list without an operation definition. They have the following fields:
+
+- "properties": map of property names to property definition maps.
+ Defines the set of message properties expected by the operation.
+- "body": a property definition map.
+
+Attribute or property definition maps have the following fields:
+
+- "description": documentation string.
+- "type": one of the following:
+ - "string": a Unicode string value.
+ - "path": A string c
+ - "entityId": a string that holds the `identity` of a management entity.
+ - "integer": an integer value.
+ - "boolean": a true/false value.
+ - "map": a map.
+ - "list": a list.
+ - [...]: A list of strings is an enumeration. Values must be one of the strings or an integer integer index into the list, starting from 0.
+- "default": a default can be a literal value or a reference to another attribute in the form `$attributeName`.
+- "create": if true the attribute can be set by CREATE.
+- "update": if true the attribute can be changed by UPDATE.
+Attributes with neither "create" nor "update" are set automatically by the system.
+
+There is the following hierarchy among entity types:
+
+- `entity`: The base of all entity types.
+
+- `configurationEntity`: base for all types that hold *configuration information*.
+
+ Configuration information is supplied in advance and express *intent*. For
+ example "I want the router to listen on port N". All the entities that can be
+ used in the configuration file extend `configurationEntity`.
+
+- `operationalEntity`: base for all types that hold *operational information*.
+
+ Operational information reflects the actual current state of the router. For
+ example, "how many addresses are presently active?" All the entities queried
+ by the `qdstat` tool extend `operationalEntity`.
+
+The two types are often related. For example `listener` and `connector` extend
+`configurationEntity`, they express the intent to make or receive
+connections. `connection` extends `operationalEntity`, it holds information
+the actual connection status.
+
Added: qpid/dispatch/branches/0.4/doc/pre_built/man/man5/qdrouterd.conf.5
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/man/man5/qdrouterd.conf.5?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/man/man5/qdrouterd.conf.5 (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/man/man5/qdrouterd.conf.5 Thu Mar 12 20:25:44 2015
@@ -0,0 +1,374 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "QDROUTERD.CONF" "5" "March 12, 2015" "0.4" "Qpid Dispatch"
+.SH NAME
+qdrouterd.conf \- dispatch router configuration
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.SH SYNOPSIS
+.sp
+qdroutered.conf is the configuration file for the dispatch router.
+.SH DESCRIPTION
+.sp
+The configuration file is made up of sections with this syntax:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+SECTION\-NAME {
+ ATTRIBUTE\-NAME: ATTRIBUTE\-VALUE
+ ATTRIBUTE\-NAME: ATTRIBUTE\-VALUE
+ ...
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+There are two types of sections:
+.sp
+\fIConfiguration sections\fP correspond to configuration entities. They can be queried and
+configured via management tools as well as via the configuration file.
+.sp
+\fIAnnotation sections\fP define a group of attribute values that can be included in
+one or more entity sections.
+.sp
+For example you can define an "ssl\-profile" annotation section with SSL credentials
+that can be included in multiple "listener" entities. Here\(aqs an example, note
+how the \(aqssl\-profile\(aq attribute of \(aqlistener\(aq sections references the \(aqname\(aq
+attribute of \(aqssl\-profile\(aq sections.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+ssl\-profile {
+ name: ssl\-profile\-one
+ cert\-db: ca\-certificate\-1.pem
+ cert\-file: server\-certificate\-1.pem
+ key\-file: server\-private\-key.pem
+}
+
+listener {
+ ssl\-profile: ssl\-profile\-one
+ addr: 0.0.0.0
+ port: 20102
+ sasl\-mechanisms: ANONYMOUS
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH ANNOTATION SECTIONS
+.SS addrPort
+.sp
+Attributes for internet address and port.
+.sp
+Used by: \fBlistener\fP, \fBconnector\fP\&.
+.INDENT 0.0
+.TP
+.B \fIaddr\fP (string, default=\(aq0.0.0.0\(aq)
+IP address: ipv4 or ipv6 literal or a host name.
+.TP
+.B \fIport\fP (string, default=\(aqamqp\(aq)
+Port number or symbolic service name.
+.UNINDENT
+.SS saslMechanisms
+.sp
+Attribute for a list of SASL mechanisms.
+.sp
+Used by: \fBlistener\fP, \fBconnector\fP\&.
+.INDENT 0.0
+.TP
+.B \fIsaslMechanisms\fP (string, required)
+Comma separated list of accepted SASL authentication mechanisms.
+.UNINDENT
+.SS connectionRole
+.sp
+Attribute for the role of a connection.
+.sp
+Used by: \fBlistener\fP, \fBconnector\fP\&.
+.INDENT 0.0
+.TP
+.B \fIrole\fP (One of [\(aqnormal\(aq, \(aqinter\-router\(aq, \(aqon\-demand\(aq], default=\(aqnormal\(aq)
+The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter\-router role, the connection is assumed to be to another router in the network. Inter\-router discovery and routing protocols can only be used over inter\-router connections.
+.UNINDENT
+.SS sslProfile
+.sp
+Attributes for setting TLS/SSL configuration for connections.
+.sp
+Used by: \fBlistener\fP, \fBconnector\fP\&.
+.INDENT 0.0
+.TP
+.B \fIcertDb\fP (path)
+The path to the database that contains the public certificates of trusted certificate authorities (CA).
+.TP
+.B \fIcertFile\fP (path)
+The path to the file containing the PEM\-formatted public certificate to be used on the local end of any connections using this profile.
+.TP
+.B \fIkeyFile\fP (path)
+The path to the file containing the PEM\-formatted private key for the above certificate.
+.TP
+.B \fIpasswordFile\fP (path)
+If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.
+.TP
+.B \fIpassword\fP (string)
+An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the \(aqpassword\(aq option. Don\(aqt use both password and passwordFile in the same profile.
+.UNINDENT
+.SH CONFIGURATION SECTIONS
+.SS container
+.sp
+Attributes related to the AMQP container.
+.INDENT 0.0
+.TP
+.B \fIcontainerName\fP (string)
+The name of the AMQP container. If not specified, the container name will be set to a value of the container\(aqs choosing. The automatically assigned container name is not guaranteed to be persistent across restarts of the container.
+.TP
+.B \fIworkerThreads\fP (integer, default=1)
+The number of threads that will be created to process message traffic and other application work (timers, non\-amqp file descriptors, etc.) .
+.TP
+.B \fIdebugDump\fP (path)
+A file to dump debugging information that can\(aqt be logged normally.
+.UNINDENT
+.SS router
+.sp
+Tracks peer routers and computes routes to destinations.
+.INDENT 0.0
+.TP
+.B \fIrouterId\fP (string)
+Router\(aqs unique identity.
+.TP
+.B \fImode\fP (One of [\(aqstandalone\(aq, \(aqinterior\(aq, \(aqedge\(aq, \(aqendpoint\(aq], default=\(aqstandalone\(aq)
+In standalone mode, the router operates as a single component. It does not participate in the routing protocol and therefore will not cooperate with other routers. In interior mode, the router operates in cooperation with other interior routers in an interconnected network. In edge mode, the router operates with an up link into an interior router network. Edge routers are typically used as connection concentrators or as security firewalls for access into the interior network.
+.TP
+.B \fIhelloInterval\fP (integer, default=1)
+Interval in seconds between HELLO messages sent to neighbor routers.
+.TP
+.B \fIhelloMaxAge\fP (integer, default=3)
+Time in seconds after which a neighbor is declared lost if no HELLO is received.
+.TP
+.B \fIraInterval\fP (integer, default=30)
+Interval in seconds between Router\-Advertisements sent to all routers in a stable network.
+.TP
+.B \fIraIntervalFlux\fP (integer, default=4)
+Interval in seconds between Router\-Advertisements sent to all routers during topology fluctuations.
+.TP
+.B \fIremoteLsMaxAge\fP (integer, default=60)
+Time in seconds after which link state is declared stale if no RA is received.
+.TP
+.B \fImobileAddrMaxAge\fP (integer, default=60)
+Deprecated \- This value is no longer used in the router.
+.UNINDENT
+.SS listener
+.sp
+Listens for incoming connections to the router.
+.sp
+Annotations: \fBaddrPort\fP, \fBconnectionRole\fP, \fBsslProfile\fP, \fBsaslMechanisms\fP\&.
+.INDENT 0.0
+.TP
+.B \fIaddr\fP (string, default=\(aq0.0.0.0\(aq)
+IP address: ipv4 or ipv6 literal or a host name.
+.TP
+.B \fIport\fP (string, default=\(aqamqp\(aq)
+Port number or symbolic service name.
+.TP
+.B \fIrole\fP (One of [\(aqnormal\(aq, \(aqinter\-router\(aq, \(aqon\-demand\(aq], default=\(aqnormal\(aq)
+The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter\-router role, the connection is assumed to be to another router in the network. Inter\-router discovery and routing protocols can only be used over inter\-router connections.
+.TP
+.B \fIcertDb\fP (path)
+The path to the database that contains the public certificates of trusted certificate authorities (CA).
+.TP
+.B \fIcertFile\fP (path)
+The path to the file containing the PEM\-formatted public certificate to be used on the local end of any connections using this profile.
+.TP
+.B \fIkeyFile\fP (path)
+The path to the file containing the PEM\-formatted private key for the above certificate.
+.TP
+.B \fIpasswordFile\fP (path)
+If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.
+.TP
+.B \fIpassword\fP (string)
+An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the \(aqpassword\(aq option. Don\(aqt use both password and passwordFile in the same profile.
+.TP
+.B \fIsaslMechanisms\fP (string, required)
+Comma separated list of accepted SASL authentication mechanisms.
+.TP
+.B \fIrequirePeerAuth\fP (boolean, default=True)
+Only for listeners using SSL. If set to \(aqyes\(aq, attached clients will be required to supply a certificate. If the certificate is not traceable to a CA in the ssl profile\(aqs cert\-db, authentication fails for the connection.
+.TP
+.B \fItrustedCerts\fP (path)
+This optional setting can be used to reduce the set of available CAs for client authentication. If used, this setting must provide a path to a PEM file that contains the trusted certificates.
+.TP
+.B \fIallowUnsecured\fP (boolean)
+For listeners using SSL only. If set to \(aqyes\(aq the listener will allow both SSL\-secured clients and non\-SSL clients to connect.
+.TP
+.B \fIallowNoSasl\fP (boolean)
+If set to \(aqyes\(aq, this option causes the listener to allow clients to connect even if they skip the SASL authentication protocol.
+.TP
+.B \fImaxFrameSize\fP (integer, default=65536)
+Defaults to 65536. If specified, it is the maximum frame size in octets that will be used in the connection\-open negotiation with a connected peer. The frame size is the largest contiguous set of uninterrupted data that can be sent for a message delivery over the connection. Interleaving of messages on different links is done at frame granularity.
+.UNINDENT
+.SS connector
+.sp
+Establishes an outgoing connections from the router.
+.sp
+Annotations: \fBaddrPort\fP, \fBconnectionRole\fP, \fBsslProfile\fP, \fBsaslMechanisms\fP\&.
+.INDENT 0.0
+.TP
+.B \fIaddr\fP (string, default=\(aq0.0.0.0\(aq)
+IP address: ipv4 or ipv6 literal or a host name.
+.TP
+.B \fIport\fP (string, default=\(aqamqp\(aq)
+Port number or symbolic service name.
+.TP
+.B \fIrole\fP (One of [\(aqnormal\(aq, \(aqinter\-router\(aq, \(aqon\-demand\(aq], default=\(aqnormal\(aq)
+The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter\-router role, the connection is assumed to be to another router in the network. Inter\-router discovery and routing protocols can only be used over inter\-router connections.
+.TP
+.B \fIcertDb\fP (path)
+The path to the database that contains the public certificates of trusted certificate authorities (CA).
+.TP
+.B \fIcertFile\fP (path)
+The path to the file containing the PEM\-formatted public certificate to be used on the local end of any connections using this profile.
+.TP
+.B \fIkeyFile\fP (path)
+The path to the file containing the PEM\-formatted private key for the above certificate.
+.TP
+.B \fIpasswordFile\fP (path)
+If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.
+.TP
+.B \fIpassword\fP (string)
+An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the \(aqpassword\(aq option. Don\(aqt use both password and passwordFile in the same profile.
+.TP
+.B \fIsaslMechanisms\fP (string, required)
+Comma separated list of accepted SASL authentication mechanisms.
+.TP
+.B \fIallowRedirect\fP (boolean, default=True)
+Allow the peer to redirect this connection to another address.
+.TP
+.B \fImaxFrameSize\fP (integer, default=65536)
+Maximum frame size in octets that will be used in the connection\-open negotiation with a connected peer. The frame size is the largest contiguous set of uninterrupted data that can be sent for a message delivery over the connection. Interleaving of messages on different links is done at frame granularity.
+.UNINDENT
+.SS log
+.sp
+Configure logging for a particular module. You can use the \fIUPDATE\fP operation to change log settings while the router is running.
+.INDENT 0.0
+.TP
+.B \fIenable\fP (string, default=\(aqdefault\(aq, required)
+Levels are: trace, debug, info, notice, warning, error, critical. The enable string is a comma\-separated list of levels. A level may have a trailing \(aq+\(aq to enable that level and above. For example \(aqtrace,debug,warning+\(aq means enable trace, debug, warning, error and critical. The value \(aqnone\(aq means disable logging for the module. The value \(aqdefault\(aq means use the value from the DEFAULT module.
+.TP
+.B \fItimestamp\fP (boolean)
+Include timestamp in log messages.
+.TP
+.B \fIsource\fP (boolean)
+Include source file and line number in log messages.
+.TP
+.B \fIoutput\fP (string)
+Where to send log messages. Can be \(aqstderr\(aq, \(aqsyslog\(aq or a file name.
+.UNINDENT
+.SS fixedAddress
+.sp
+Establishes semantics for addresses starting with a prefix.
+.INDENT 0.0
+.TP
+.B \fIprefix\fP (string, required)
+The address prefix (always starting with \(aq/\(aq).
+.TP
+.B \fIphase\fP (integer)
+The phase of a multi\-hop address passing through one or more waypoints.
+.TP
+.B \fIfanout\fP (One of [\(aqmultiple\(aq, \(aqsingle\(aq], default=\(aqmultiple\(aq)
+One of \(aqmultiple\(aq or \(aqsingle\(aq. Multiple fanout is a non\-competing pattern. If there are multiple consumers using the same address, each consumer will receive its own copy of every message sent to the address. Single fanout is a competing pattern where each message is sent to only one consumer.
+.TP
+.B \fIbias\fP (One of [\(aqclosest\(aq, \(aqspread\(aq], default=\(aqclosest\(aq)
+Only if fanout is single. One of \(aqclosest\(aq or \(aqspread\(aq. Closest bias means that messages to an address will always be delivered to the closest (lowest cost) subscribed consumer. Spread bias will distribute the messages across subscribers in an approximately even manner.
+.UNINDENT
+.SS waypoint
+.sp
+A remote node that messages for an address pass through.
+.INDENT 0.0
+.TP
+.B \fIaddress\fP (string, required)
+The AMQP address of the waypoint.
+.TP
+.B \fIconnector\fP (string, required)
+The name of the on\-demand connector used to reach the waypoint\(aqs container.
+.TP
+.B \fIinPhase\fP (integer, default=\-1)
+The phase of the address as it is routed _to_ the waypoint.
+.TP
+.B \fIoutPhase\fP (integer, default=\-1)
+The phase of the address as it is routed _from_ the waypoint.
+.UNINDENT
+.SS linkRoutePattern
+.sp
+A pattern to match a connected container to endpoints for routed links.
+.INDENT 0.0
+.TP
+.B \fIprefix\fP (string, required)
+The AMQP address prefix for nodes on the container.
+.TP
+.B \fIconnector\fP (string)
+The name of the on\-demand connector used to reach the waypoint\(aqs container.
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIqdrouterd(8)\fP, \fIqdmanage(8)\fP
+.sp
+\fI\%http://qpid.apache.org/components/dispatch-router\fP
+.SH COPYRIGHT
+2013, Apache Qpid <http://qpid.apache.org/>
+.\" Generated by docutils manpage writer.
+.
Added: qpid/dispatch/branches/0.4/doc/pre_built/man/man8/qdmanage.8
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/man/man8/qdmanage.8?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/man/man8/qdmanage.8 (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/man/man8/qdmanage.8 Thu Mar 12 20:25:44 2015
@@ -0,0 +1,254 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "QDMANAGE" "8" "March 12, 2015" "0.4" "Qpid Dispatch"
+.SH NAME
+qdmanage \- dispatch management tool
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.SH SYNOPSIS
+.sp
+qdmanage \fIoperation\fP [\fIoptions...\fP] [\fIarguments...\fP]
+.SH DESCRIPTION
+.sp
+An AMQP management client for use with qdrouterd. Sends AMQP management
+operations requests and prints the response in JSON format. This is a
+generic AMQP management tool and can be used with any standard AMQP
+managed endpoint, not just with qdrouter.
+.SH OPERATIONS
+.INDENT 0.0
+.TP
+.B \fIquery\fP [\fIATTR\fP\&...]
+Print the attributes named in the ATTR list or all attributes if
+none are listed. Print attributes for all entities by default, use
+\-\-type, \-\-name and \-\-identity options to restrict what is printed.
+.TP
+.B \fIcreate\fP [\fIATTR=VALUE\fP\&...]
+Create a new entity with the specified attributes. With the \-\-stdin
+option, read attributes from stdin. This can be a JSON map of
+attributes to create a single entity, or a JSON list of maps to
+create multiple entitiees.
+.TP
+.B \fIread\fP
+Print the attributes of an entity specified by the \-\-name or
+\-\-identity options. With the \-\-stdin option, create entities based
+on data from stdin. This can be a JSON map of attributes to create a
+single entity, or a JSON list of maps to create multiple entitiees.
+.TP
+.B \fIupdate\fP [\fIATTR=VALUE\fP\&...]
+Update the attributes of an existing entity. With the \-\-stdin
+option, read attributes from stdin. This can be a JSON map of
+attributes to update a single entity, or a JSON list of maps to
+update multiple entitiees. If an ATTR name is listed with no =VALUE,
+that attribute will be deleted from the entity.
+.TP
+.B \fIdelete\fP
+Delete an entity specified by the \-\-name or \-\-identity options.
+.TP
+.B \fIget\-types\fP [\fITYPE\fP]
+List entity types with their base types. With no arguments list all
+types.
+.TP
+.B \fIget\-operations\fP [\fITYPE\fP]
+List entity types with their operations. With no arguments list all
+types.
+.TP
+.B \fIget\-attributes\fP [\fITYPE\fP]
+List entity types with their attributes. With no arguments list all
+types.
+.TP
+.B \fIget\-annotations\fP [\fITYPE\fP]
+List entity types with their annotations. With no arguments list all
+types.
+.TP
+.B \fIget\-mgmt\-nodes\fP
+List all other known management nodes connected to this one.
+.TP
+.B \fIget\-json\-schema\fP [\fIINDENT\fP]
+Get the router schema in JSON format. Optional integer indent for
+formatted output.
+.TP
+.B \fIget\-log\fP [\fIINDENT\fP]
+Get recent log entries from the router.
+.UNINDENT
+.SH OPTIONS
+.sp
+\-h, \-\-help
+: show this help message and exit
+.sp
+\-\-version
+: Print version and exit.
+.sp
+\-\-type=TYPE
+: Type of entity to operate on.
+.sp
+\-\-name=NAME
+: Name of entity to operate on.
+.sp
+\-\-identity=ID
+: Identity of entity to operate on.
+.sp
+\-\-indent=INDENT
+: Pretty\-printing indent. \-1 means don\(aqt pretty\-print (default 2)
+.sp
+\-\-stdin
+: Read attributes as JSON map or list of maps from stdin.
+.sp
+\-\-body=BODY
+: JSON value to use as body of a non\-standard operation call.
+.sp
+\-\-properties=PROPERTIES
+: JSON map to use as properties for a non\-standard operation call.
+.SS Connection Options
+.sp
+\-b URL, \-\-bus=URL
+: URL of the messaging bus to connect to (default 0.0.0.0)
+.sp
+\-r ROUTER\-ID, \-\-router=ROUTER\-ID
+: Router to be queried
+.sp
+\-t SECS, \-\-timeout=SECS
+: Maximum time to wait for connection in seconds (default 5)
+.sp
+\-\-ssl\-certificate=CERT
+: Client SSL certificate (PEM Format)
+.sp
+\-\-ssl\-key=KEY
+: Client SSL private key (PEM Format)
+.sp
+\-\-ssl\-trustfile=TRUSTED\-CA\-DB
+: Trusted Certificate Authority Database file (PEM Format)
+.sp
+\-\-ssl\-password=PASSWORD
+: Certificate password, will be prompted if not specifed.
+.SH FILES
+.INDENT 0.0
+.TP
+.B /home/aconway/dispatch/install/share/doc/qpid\-dispatch/qdrouter.json
+Management schema for qdrouterd.
+.TP
+.B /home/aconway/dispatch/install/share/doc/qpid\-dispatch/qdrouter.json.readme.txt
+Explanation of the management schema.
+.UNINDENT
+.SH EXAMPLES
+.sp
+Show the logging configuration
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+qdmanage query \-\-type=log
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Enable debug and higher log messages by default:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+qdmanage udpdate name=log/DEFAULT enable=debug+
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Enable trace log messages only for the MESSAGE moudle and direct MESSAGE
+logs to the file "test.log"
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+qdmanage udpdate name=log/MESSAGE enable=trace output=test.log
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Set MESSAGE logging back to the default:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+qdmanage udpdate name=log/MESSAGE enable=default
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Disable MESSAGE logging:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+qdmanage udpdate name=log/MESSAGE enable=none
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIqdrouterd(8)\fP, \fIqdstat(8)\fP, \fIqdrouterd.conf(5)\fP
+.sp
+\fI\%http://qpid.apache.org/components/dispatch-router\fP
+.SH COPYRIGHT
+2013, Apache Qpid <http://qpid.apache.org/>
+.\" Generated by docutils manpage writer.
+.
Added: qpid/dispatch/branches/0.4/doc/pre_built/man/man8/qdrouterd.8
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/man/man8/qdrouterd.8?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/man/man8/qdrouterd.8 (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/man/man8/qdrouterd.8 Thu Mar 12 20:25:44 2015
@@ -0,0 +1,101 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "QDROUTERD" "8" "March 12, 2015" "0.4" "Qpid Dispatch"
+.SH NAME
+qdrouterd \- dispatch router
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.SH SYNOPSIS
+.sp
+qdrouterd [\fIoptions\fP]
+.SH DESCRIPTION
+.sp
+The Qpid Dispatch router (qdrouterd) is a network daemon that directs
+AMQP 1.0 messages between endpoints, such as messaging clients and
+servers.
+.SH OPTIONS
+.sp
+\-c, \-\-config=PATH (/home/aconway/dispatch/install/etc/qpid\-dispatch/qdrouterd.conf)
+: Load configuration from file at PATH
+.sp
+\-I, \-\-include=PATH (/home/aconway/dispatch/install/lib/qpid\-dispatch/python)
+: Location of Dispatch\(aqs Python library
+.sp
+\-d, \-\-daemon
+: Run process as a SysV\-style daemon
+.sp
+\-P, \-\-pidfile
+: If daemon, the file for the stored daemon pid
+.sp
+\-U, \-\-user
+: If daemon, the username to run as
+.sp
+\-h, \-\-help
+: Print this help
+.SH FILES
+.INDENT 0.0
+.TP
+.B /home/aconway/dispatch/install/etc/qdrouterd.conf
+Configuration flie.
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIqdrouterd.conf(5)\fP, \fIqdstat(8)\fP, \fIqdmanage(8)\fP
+.sp
+\fI\%http://qpid.apache.org/components/dispatch-router\fP
+.SH COPYRIGHT
+2013, Apache Qpid <http://qpid.apache.org/>
+.\" Generated by docutils manpage writer.
+.
Added: qpid/dispatch/branches/0.4/doc/pre_built/man/man8/qdstat.8
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/man/man8/qdstat.8?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/man/man8/qdstat.8 (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/man/man8/qdstat.8 Thu Mar 12 20:25:44 2015
@@ -0,0 +1,123 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "QDSTAT" "8" "March 12, 2015" "0.4" "Qpid Dispatch"
+.SH NAME
+qdstat \- dispatch router status
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.SH SYNOPSIS
+.sp
+qdstat [options]
+.SH DESCRIPTION
+.sp
+\fIqdstat\fP shows status information about networks of Dispatch routers. It
+can display connections, network nodes and links, and router stats such
+as memory use.
+.SH OPTIONS
+.sp
+\-h, \-\-help
+: show this help message and exit
+.sp
+\-\-version
+: Print version and exit.
+.sp
+\-g, \-\-general
+: Show General Router Stats
+.sp
+\-c, \-\-connections
+: Show Connections
+.sp
+\-l, \-\-links
+: Show Router Links
+.sp
+\-n, \-\-nodes
+: Show Router Nodes
+.sp
+\-a, \-\-address
+: Show Router Addresses
+.sp
+\-m, \-\-memory
+: Show Broker Memory Stats
+.SS Connection Options
+.sp
+\-b URL, \-\-bus=URL
+: URL of the messaging bus to connect to (default 0.0.0.0)
+.sp
+\-r ROUTER\-ID, \-\-router=ROUTER\-ID
+: Router to be queried
+.sp
+\-t SECS, \-\-timeout=SECS
+: Maximum time to wait for connection in seconds (default 5)
+.sp
+\-\-ssl\-certificate=CERT
+: Client SSL certificate (PEM Format)
+.sp
+\-\-ssl\-key=KEY
+: Client SSL private key (PEM Format)
+.sp
+\-\-ssl\-trustfile=TRUSTED\-CA\-DB
+: Trusted Certificate Authority Database file (PEM Format)
+.sp
+\-\-ssl\-password=PASSWORD
+: Certificate password, will be prompted if not specifed.
+.SH SEE ALSO
+.sp
+\fIqdrouterd(8)\fP, \fIqdmanage(8)\fP, \fIqdrouterd.conf(5)\fP
+.sp
+\fI\%http://qpid.apache.org/components/dispatch-router\fP
+.SH COPYRIGHT
+2013, Apache Qpid <http://qpid.apache.org/>
+.\" Generated by docutils manpage writer.
+.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org