diff options
| author | Gordon Sim <gsim@apache.org> | 2012-05-01 14:25:25 +0000 |
|---|---|---|
| committer | Gordon Sim <gsim@apache.org> | 2012-05-01 14:25:25 +0000 |
| commit | 149204126179b0129ddd9ad643c57bc4958bef59 (patch) | |
| tree | ec1f00df33931ec1d82c1f959c27ba663c9a9035 | |
| parent | fe14ea31b0bf438cb78982867a9a55ac08ce86f2 (diff) | |
| download | qpid-python-149204126179b0129ddd9ad643c57bc4958bef59.tar.gz | |
Added proposed set of initial 1.0 filter definitions
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1332672 13f79535-47bb-0310-9956-ffa450edef68
| -rw-r--r-- | qpid/specs/amqp.xsl | 534 | ||||
| -rw-r--r-- | qpid/specs/apache-filters.xml | 224 |
2 files changed, 758 insertions, 0 deletions
diff --git a/qpid/specs/amqp.xsl b/qpid/specs/amqp.xsl new file mode 100644 index 0000000000..afe3bd5e65 --- /dev/null +++ b/qpid/specs/amqp.xsl @@ -0,0 +1,534 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + - + - 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. + - + --> + +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> +<xsl:output indent="no"/> + <xsl:template match="node()[name()='amqp']"> + +<html> + <head> + <title>AMQP <xsl:call-template name="initCap"><xsl:with-param name="input" select="@name"/></xsl:call-template></title> + <style type="text/css"> + body { + margin: 2em; + padding: 1em; + font-family: "DejaVu LGC Sans", "Bitstream Vera Sans", arial, helvetica, sans-serif; + } + + h2 { + font-size: 1.25em; + color: #339; + } + + h2 a { + color: #339; + } + + h3 { + font-size: 1em; + position: relative; + left: -0.5em; + } + + h4 { + font-size: 1em; + position: relative; + left: -0.5em; + } + + h1 a, h3 a, h4 a { + color: #000; + } + + a { + text-decoration: none; + color: #66f; + } + + a.anchor { + color: #000; + } + + a.toc { + float: right; + } + + table { + border-collapse: collapse; + margin: 1em 1em; + } + + dt { + font-weight: bold; + } + + dt:after { + content: ":"; + } + + div.toc { + border: 1px solid #ccc; + padding: 1em; + } + + table.toc { + margin: 0; + } + + table.pre { + background: #eee; + border: 1px solid #ccc; + margin-left: auto; + margin-right: auto; + } + + table.pre td { + font-family: Courier, monospace; + white-space: pre; + padding: 0em 2em; + } + + table.definition { + width: 100%; + } + + table.signature { + background: #eee; + border: 1px solid #ccc; + width: 100%; + } + + table.signature td { + font-family: monospace; + white-space: pre; + padding: 1em; + } + + table.composite { + width: 100%; + } + + td.field { + padding: 0.5em 2em; + } + + div.section { + padding: 0 0 0 1em; + } + + div.doc { + padding: 0 0 1em 0; + } + + table.composite div.doc { + padding: 0; + } + + table.error { + width: 100%; + margin: 0; + } + + table.error tr:last-child td { + padding: 0 0 0 1em; + } + + .todo:before { + content: "TODO: "; + font-weight: bold; + color: red; + } + + .todo { + font-variant: small-caps; + font-weight: bold; + color: red; + } + </style> + </head> + <body> + <h1>AMQP <xsl:call-template name="initCap"><xsl:with-param name="input" select="@name"/></xsl:call-template></h1> + + <xsl:if test="descendant-or-self::node()[name()='section']"><xsl:call-template name="toc"/></xsl:if> + <xsl:apply-templates mode="spec" select="."/> + </body> +</html> + </xsl:template> + + <!-- Table of Contents --> + + <xsl:template name="toc"> + <h2><a name="toc">Table of Contents</a></h2> + <div class="toc"> + <table class="toc" summary="Table of Contents"> + <xsl:apply-templates mode="toc" select="."/> + </table> + </div> + </xsl:template> + + <xsl:template mode="toc" match="node()[name()='section']"> + <xsl:variable name="title"><xsl:choose> + <xsl:when test="@title"><xsl:value-of select="@title"/></xsl:when> + <xsl:otherwise><xsl:call-template name="initCapWords"><xsl:with-param name="input" select="translate(@name,'-',' ')"/></xsl:call-template></xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:variable name="ref">#section-<xsl:value-of select="@name"/></xsl:variable> + <xsl:variable name="section-number"><xsl:value-of select="count(preceding-sibling::node()[name()='section'])+1"/></xsl:variable> + <tr><td><xsl:value-of select="$section-number"/><xsl:text> </xsl:text><xsl:element name="a"><xsl:attribute name="href"><xsl:value-of select="$ref"/></xsl:attribute><xsl:value-of select="$title"/></xsl:element></td><td><xsl:value-of select="@label"/></td></tr> + <xsl:apply-templates mode="toc" select="node()[name()='type' or name()='definition' or ( name()='doc' and attribute::node()[name()='title']!='')]"/> + </xsl:template> + + <xsl:template mode="toc" match="node()[name()='doc' and attribute::node()[name()='title']]"> + <xsl:variable name="ref">#doc-<xsl:choose><xsl:when test="@name"><xsl:value-of select="@name"/></xsl:when><xsl:otherwise><xsl:value-of select="generate-id(.)"/></xsl:otherwise></xsl:choose></xsl:variable> + <xsl:variable name="section-number"><xsl:apply-templates mode="doc-number" select="."/></xsl:variable> + <tr><td><xsl:text>      </xsl:text><xsl:value-of select="$section-number"/><xsl:text> </xsl:text><xsl:element name="a"><xsl:attribute name="href"><xsl:value-of select="$ref"/></xsl:attribute><xsl:value-of select="@title"/></xsl:element></td><td><xsl:value-of select="@label"/></td></tr> + </xsl:template> + + <xsl:template mode="toc" match="node()[name()='type' or name()='definition']"> + <xsl:variable name="ref">#<xsl:value-of select="name()"/>-<xsl:value-of select="@name"/></xsl:variable> + <xsl:variable name="section-number"><xsl:apply-templates mode="type-number" select="."/></xsl:variable> + <tr><td><xsl:text>      </xsl:text><xsl:if test="contains(substring-after($section-number,'.'),'.')"><xsl:text>      </xsl:text></xsl:if><xsl:value-of select="$section-number"/><xsl:text> </xsl:text><xsl:element name="a"><xsl:attribute name="href"><xsl:value-of select="$ref"/></xsl:attribute><xsl:call-template name="initCapWords"><xsl:with-param name="input" select="translate(@name,'-',' ')"/></xsl:call-template></xsl:element></td><td><xsl:value-of select="@label"/></td></tr> + </xsl:template> + + <!-- Sections --> + + <xsl:template match="node()[name()='section']" mode="spec"> + <xsl:variable name="title"><xsl:choose> + <xsl:when test="@title"><xsl:value-of select="@title"/></xsl:when> + <xsl:otherwise><xsl:call-template name="initCapWords"><xsl:with-param name="input" select="translate(@name,'-',' ')"/></xsl:call-template></xsl:otherwise> + </xsl:choose> + </xsl:variable> + <h2><a class="toc" href="#toc"><xsl:text>←</xsl:text></a> <xsl:apply-templates mode="section-number" select="."/><xsl:text> </xsl:text><xsl:element name="a"><xsl:attribute name="name">section-<xsl:value-of select="@name"/></xsl:attribute><xsl:value-of select="$title"/></xsl:element></h2> + <div class="section"> + <xsl:apply-templates mode="spec" select="*"/> + </div> + </xsl:template> + + <!-- docs --> + <xsl:template match="node()[name()='doc']" mode="spec"> + <xsl:choose> + <xsl:when test="ancestor::node()[name() = 'doc']"> + <xsl:if test="@title"> + <h4><a class="toc" href="#toc"><xsl:text>←</xsl:text></a><xsl:element name="a"><xsl:attribute name="name">doc-<xsl:choose><xsl:when test="@name"><xsl:value-of select="@name"/></xsl:when><xsl:otherwise><xsl:value-of select="generate-id(.)"/></xsl:otherwise></xsl:choose></xsl:attribute><xsl:call-template name="initCapWords"><xsl:with-param name="input" select="translate(@title,'-',' ')"></xsl:with-param></xsl:call-template></xsl:element></h4> + </xsl:if> + <xsl:apply-templates mode="spec" select="*|comment()"/> + </xsl:when> + <xsl:otherwise> + <xsl:if test="@title"> + <h3><a class="toc" href="#toc"><xsl:text>←</xsl:text></a> <xsl:apply-templates mode="doc-number" select="."/><xsl:text> </xsl:text><xsl:element name="a"><xsl:attribute name="name">doc-<xsl:choose><xsl:when test="@name"><xsl:value-of select="@name"/></xsl:when><xsl:otherwise><xsl:value-of select="generate-id(.)"/></xsl:otherwise></xsl:choose></xsl:attribute><xsl:call-template name="initCapWords"><xsl:with-param name="input" select="translate(@title,'-',' ')"></xsl:with-param></xsl:call-template></xsl:element></h3> + </xsl:if> + <div class="doc"> + <xsl:apply-templates mode="spec" select="*|comment()"/> + </div> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <!-- picture --> + + <xsl:template match="node()[name()='picture']" mode="spec"> + <xsl:element name="table"><xsl:attribute name="class">pre</xsl:attribute><xsl:if test="@title"><xsl:attribute name="summary"><xsl:value-of select="@title"/></xsl:attribute></xsl:if> + <xsl:if test="@title"><caption><xsl:value-of select="@title"/></caption></xsl:if> +<tr><td> +<xsl:apply-templates select="*|text()" mode="spec"/> +</td></tr></xsl:element> + </xsl:template> + + <!-- xref --> +<xsl:template match="node()[name()='xref']" mode="spec"> + <xsl:variable name="ref" select="@name"/> + <xsl:choose> + <!-- section xref --> + <xsl:when test="@type='section' or ancestor-or-self::node()/descendant-or-self::node()[name()='section' and @name=$ref]"> + <xsl:element name="a"><xsl:attribute name="href">#section-<xsl:value-of select="@name"/></xsl:attribute><xsl:value-of select="@name"/></xsl:element> + </xsl:when> + <!-- type xref --> + <xsl:when test="@type='type' or ancestor-or-self::node()/descendant-or-self::node()[name()='type' and @name=$ref]"> + <xsl:element name="a"><xsl:attribute name="href">#type-<xsl:value-of select="@name"/></xsl:attribute><xsl:value-of select="@name"/></xsl:element> + </xsl:when> + <!-- doc xref --> + <xsl:when test="@type='doc' or ancestor-or-self::node()/descendant-or-self::node()[name()='doc' and @name=$ref]"> + <xsl:element name="a"><xsl:attribute name="href">#doc-<xsl:value-of select="@name"/></xsl:attribute><xsl:value-of select="@name"/></xsl:element> + </xsl:when> + <xsl:when test="@type='amqp'"> + <xsl:element name="a"><xsl:attribute name="href"><xsl:value-of select="@name"/>.xml</xsl:attribute><xsl:call-template name="initCap"><xsl:with-param name="input"><xsl:value-of select="@name"/></xsl:with-param></xsl:call-template></xsl:element> + </xsl:when> + <xsl:otherwise><xsl:value-of select="@name"/></xsl:otherwise> + </xsl:choose> + + + +</xsl:template> + + <!-- todo --> + <xsl:template match="node()[name()='todo']" mode="spec"><span class="todo"><xsl:apply-templates select="*|text()" mode="spec"/></span></xsl:template> + + <!-- primitive type --> + <xsl:template match="node()[name()='type' and @class='primitive']" mode="spec"> + <h3><a class="toc" href="#toc"><xsl:text>←</xsl:text></a> <xsl:apply-templates mode="type-number" select="."/><xsl:text> </xsl:text> <xsl:element name="a"><xsl:attribute name="name">type-<xsl:value-of select="@name"/></xsl:attribute><xsl:call-template name="initCap"><xsl:with-param name="input" select="@name"/></xsl:call-template></xsl:element></h3> + <xsl:apply-templates select="." mode="type-signature"/> + <xsl:element name="table"><xsl:attribute name="class">signature</xsl:attribute><xsl:attribute name="summary"><xsl:value-of select="@label"/></xsl:attribute> + <tr><td><b><xsl:value-of select="@name"/></b>: <xsl:value-of select="@label"/></td></tr> + </xsl:element> + + <b>Encodings:</b> + <xsl:element name="table"><xsl:attribute name="class">composite</xsl:attribute><xsl:attribute name="summary"><xsl:value-of select="@label"/></xsl:attribute> + <xsl:apply-templates select="node()[name()='encoding']" mode="spec"/> + </xsl:element> + </xsl:template> + + + + <!-- composite type --> + <xsl:template match="node()[name()='type' and @class='composite']" mode="spec"> + <h3><a class="toc" href="#toc"><xsl:text>←</xsl:text></a> <xsl:apply-templates mode="type-number" select="."/><xsl:text> </xsl:text> <xsl:element name="a"><xsl:attribute name="name">type-<xsl:value-of select="@name"/></xsl:attribute><xsl:call-template name="initCapWords"><xsl:with-param name="input" select="translate(@name,'-',' ')"></xsl:with-param></xsl:call-template></xsl:element></h3> + <xsl:apply-templates select="." mode="type-signature"/> + <xsl:apply-templates select="node()[name()='doc']" mode="spec"/> + <xsl:element name="table"><xsl:attribute name="class">composite</xsl:attribute><xsl:attribute name="summary"><xsl:value-of select="@name"/> fields</xsl:attribute> + <xsl:for-each select="node()[name()='field']"> + <tr><td><b><xsl:value-of select="@name"/></b></td><td><i><xsl:value-of select="@label"/></i></td><td><xsl:choose> + <xsl:when test="@mandatory">mandatory</xsl:when> + <xsl:otherwise>optional</xsl:otherwise> + </xsl:choose><xsl:text> </xsl:text><xsl:call-template name="genTypeXref"><xsl:with-param name="type" select="@type"/></xsl:call-template><xsl:if test="@multiple">[]</xsl:if></td></tr> + <tr><td class="field" colspan="2"><xsl:apply-templates select="node()[name()='doc' or name()='error']" mode="spec"/></td></tr> + </xsl:for-each> + </xsl:element> + </xsl:template> + + <!-- restricted type --> + <xsl:template match="node()[name()='type' and @class='restricted']" mode="spec"> + <xsl:variable name="name"><xsl:value-of select="@name"/></xsl:variable> + <h3><a class="toc" href="#toc"><xsl:text>←</xsl:text></a> <xsl:apply-templates mode="type-number" select="."/><xsl:text> </xsl:text> <xsl:element name="a"><xsl:attribute name="name">type-<xsl:value-of select="@name"/></xsl:attribute><xsl:call-template name="initCapWords"><xsl:with-param name="input" select="translate(@name,'-',' ')"></xsl:with-param></xsl:call-template></xsl:element></h3> + <xsl:apply-templates select="." mode="type-signature"/> + <xsl:apply-templates select="node()[name()='doc']" mode="spec"/> + <xsl:element name="table"><xsl:attribute name="class">composite</xsl:attribute><xsl:attribute name="summary">possible values</xsl:attribute> + <xsl:for-each select="node()[name()='choice']"> + <tr><td><b><xsl:element name="a"><xsl:attribute name="class">anchor</xsl:attribute><xsl:attribute name="name">choice-<xsl:value-of select="$name"/>-<xsl:value-of select="@name"/></xsl:attribute><xsl:value-of select="@name"/></xsl:element></b></td><td></td><td><xsl:value-of select="@value"/></td></tr> + <tr><td class="field" colspan="2"><xsl:apply-templates select="node()[name()='doc' or name()='error']" mode="spec"/></td></tr> + </xsl:for-each> + </xsl:element> + </xsl:template> + + <!-- type signature --> + <xsl:template match="node()[name()='type']" mode="type-signature"> + <table class="signature" summary="@(label)"><tr> +<td><type<xsl:if test="@name"><xsl:text> </xsl:text>name="<xsl:value-of select="@name"/>"</xsl:if><xsl:if test="@class"><xsl:text> </xsl:text>class="<xsl:value-of select="@class"/>"</xsl:if><xsl:if test="@source"><xsl:text> </xsl:text>source="<xsl:value-of select="@source"/>"</xsl:if><xsl:if test="@provides"><xsl:text> </xsl:text>provides="<xsl:value-of select="@provides"/>"</xsl:if><xsl:if test="not( node()[name() = 'field' or name() = 'choice' or name() = 'descriptor'])">/</xsl:if>><xsl:if test="node()[name() = 'field' or name() = 'choice' or name() = 'descriptor']"> +<xsl:apply-templates select="node()[name()='field' or name()='choice' or name()='descriptor']" mode="type-signature"/><xsl:text> +</type></xsl:text> +</xsl:if> + </td></tr></table> + </xsl:template> + + <xsl:template match="node()[name()='descriptor']" mode="type-signature"> +<xsl:text> + </xsl:text><descriptor<xsl:if test="@name"><xsl:text> </xsl:text>name="<xsl:value-of select="@name"/>"</xsl:if><xsl:if test="@code"><xsl:text> </xsl:text>code="<xsl:value-of select="@code"/>"</xsl:if><xsl:text>/></xsl:text> + </xsl:template> + + <xsl:template match="node()[name()='choice']" mode="type-signature"> +<xsl:text> + </xsl:text><choice<xsl:for-each select="attribute::node()[name() != 'label']"><xsl:text> </xsl:text><xsl:value-of select="name()"/>="<xsl:value-of select="."/>"</xsl:for-each><xsl:text>/></xsl:text> + </xsl:template> + + <xsl:template match="node()[name()='field']" mode="type-signature"> +<xsl:text> + </xsl:text><field<xsl:for-each select="attribute::node()[name() != 'label']"><xsl:text> </xsl:text><xsl:value-of select="name()"/>="<xsl:value-of select="."/>"</xsl:for-each><xsl:if test="not( node()[name()='error'] )"><xsl:text>/</xsl:text></xsl:if>><xsl:if test="node()[name()='error']"> +<xsl:apply-templates mode="type-signature" select="node()[name()='error']"/><xsl:text> + </field></xsl:text></xsl:if> + </xsl:template> + + <xsl:template match="node()[name()='error']" mode="type-signature"> +<xsl:text> + </xsl:text><error<xsl:for-each select="attribute::node()[name() != 'label']"><xsl:text> </xsl:text><xsl:value-of select="name()"/>="<xsl:value-of select="."/>"</xsl:for-each><xsl:text>/></xsl:text> + </xsl:template> + + + <!-- encoding --> + <xsl:template match="node()[name()='encoding']" mode="spec"> + <tr><td><b><xsl:value-of select="@name"/></b></td><td><i><xsl:value-of select="@label"/></i></td><td>code <xsl:value-of select="@code"/>: <xsl:choose> + <xsl:when test="@category='fixed'">fixed-width, <xsl:value-of select="@width"/> byte value</xsl:when> + <xsl:otherwise>variable-width, <xsl:value-of select="@width"/> byte size</xsl:otherwise> + </xsl:choose></td></tr> + <tr><td class="field" colspan="3"><xsl:apply-templates select="node()[name()='doc']" mode="spec"/></td></tr> + + </xsl:template> + + + <!-- TypeListTable comment --> + <xsl:template match="comment()[self::comment()='TypeListTable']" mode="spec"> + <table class="" summary="Primitive Types"> + <xsl:for-each select="//descendant-or-self::node()[name()='type']"> + <tr><td><xsl:element name="a"><xsl:attribute name="href">#type-<xsl:value-of select="@name"/></xsl:attribute><xsl:value-of select="@name"/></xsl:element></td><td><xsl:value-of select="@label"/></td></tr> + </xsl:for-each> + </table> + </xsl:template> + + <!-- EncodingListTable comment --> + <xsl:template match="comment()[self::comment()='EncodingListTable']" mode="spec"> + <table class="" summary="Primitive Type Encodings"> + <tr><th>Type</th><th>Encoding</th><th>Code</th><th>Category</th><th>Description</th></tr> + <xsl:for-each select="//descendant-or-self::node()[name()='type']"> + <xsl:variable name="type" select="@name"/> + <xsl:for-each select="node()[name()='encoding']"> + <tr> + <td><xsl:element name="a"><xsl:attribute name="href">#type-<xsl:value-of select="$type"/></xsl:attribute><xsl:value-of select="$type"/></xsl:element></td> + <td><xsl:value-of select="@name"/></td> + <td><xsl:value-of select="@code"/></td> + <td><xsl:value-of select="@category"/>/<xsl:value-of select="@width"/></td> + <td><xsl:value-of select="@label"/></td> + </tr> + </xsl:for-each> + </xsl:for-each> + </table> + </xsl:template> + + + <!-- text --> + + <xsl:template match="text()" mode="spec"><xsl:value-of select="."/></xsl:template> + + <!-- error --> + + <xsl:template match="node()[name()='error']" mode="spec"> + <table class="error" summary=""> + <tr> + <td><b><xsl:value-of select="@name"/> error:</b> </td> + + <td align="right"><xsl:element name="a"><xsl:attribute name="href"><xsl:call-template name="genErrorXref"><xsl:with-param name="type" select="@value"/></xsl:call-template></xsl:attribute><xsl:value-of select="@value"/></xsl:element></td> + </tr> + <tr><td colspan="2"><xsl:apply-templates select="node()[name()='doc']" mode="spec"/></td></tr> + </table> + </xsl:template> + + <!-- definition --> + + <xsl:template mode="spec" match="node()[name()='definition']"> + <h3><a class="toc" href="#toc"><xsl:text>←</xsl:text></a> <xsl:apply-templates mode="type-number" select="."/><xsl:text> </xsl:text> <xsl:element name="a"><xsl:attribute name="name">definition-<xsl:value-of select="@name"/></xsl:attribute><xsl:call-template name="initCap"><xsl:with-param name="input" select="@name"/></xsl:call-template></xsl:element></h3> + + <xsl:element name="table"><xsl:attribute name="class">signature</xsl:attribute><xsl:attribute name="summary"><xsl:value-of select="@label"/></xsl:attribute> + <tr> + <td><xsl:value-of select="@name"/>: <xsl:value-of select="@label"/></td> + <td align="right"><xsl:value-of select="@value"/></td> + </tr> + </xsl:element> + <xsl:apply-templates mode="spec" select="node()[name()='doc']"/> + </xsl:template> + + <!-- pass through tags --> + + <xsl:template match="node()[name() = 'p']" mode="spec"> + <xsl:element name="p"><xsl:if test="@title"><xsl:attribute name="title"><xsl:value-of select="@title"/></xsl:attribute></xsl:if><xsl:apply-templates mode="spec" select="*|text()"/></xsl:element> + </xsl:template> + <xsl:template match="node()[name() = 'i']" mode="spec"> + <xsl:element name="i"><xsl:if test="@title"><xsl:attribute name="title"><xsl:value-of select="@title"/></xsl:attribute></xsl:if><xsl:apply-templates mode="spec" select="*|text()"/></xsl:element> + </xsl:template> + <xsl:template match="node()[name() = 'term']" mode="spec"> + <xsl:element name="i"><xsl:if test="@title"><xsl:attribute name="title"><xsl:value-of select="@title"/></xsl:attribute></xsl:if><xsl:apply-templates mode="spec" select="*|text()"/></xsl:element> + </xsl:template> + <xsl:template match="node()[name() = 'b']" mode="spec"> + <xsl:element name="b"><xsl:if test="@title"><xsl:attribute name="title"><xsl:value-of select="@title"/></xsl:attribute></xsl:if><xsl:apply-templates mode="spec" select="*|text()"/></xsl:element> + </xsl:template> + <xsl:template match="node()[name() = 'ol']" mode="spec"> + <xsl:element name="ol"><xsl:if test="@title"><xsl:attribute name="title"><xsl:value-of select="@title"/></xsl:attribute></xsl:if><xsl:apply-templates mode="spec" select="*|text()"/></xsl:element> + </xsl:template> + <xsl:template match="node()[name() = 'ul']" mode="spec"> + <xsl:element name="ul"><xsl:if test="@title"><xsl:attribute name="title"><xsl:value-of select="@title"/></xsl:attribute></xsl:if><xsl:apply-templates mode="spec" select="*|text()"/></xsl:element> + </xsl:template> + <xsl:template match="node()[name() = 'li']" mode="spec"> + <xsl:element name="li"><xsl:if test="@title"><xsl:attribute name="title"><xsl:value-of select="@title"/></xsl:attribute></xsl:if><xsl:apply-templates mode="spec" select="*|text()"/></xsl:element> + </xsl:template> + <xsl:template match="node()[name() = 'dl']" mode="spec"> + <xsl:element name="dl"><xsl:if test="@title"><xsl:attribute name="title"><xsl:value-of select="@title"/></xsl:attribute></xsl:if><xsl:apply-templates mode="spec" select="*|text()"/></xsl:element> + </xsl:template> + <xsl:template match="node()[name() = 'dt']" mode="spec"> + <xsl:element name="dt"><xsl:if test="@title"><xsl:attribute name="title"><xsl:value-of select="@title"/></xsl:attribute></xsl:if><xsl:apply-templates mode="spec" select="*|text()"/></xsl:element> + </xsl:template> + <xsl:template match="node()[name() = 'dd']" mode="spec"> + <xsl:element name="dd"><xsl:if test="@title"><xsl:attribute name="title"><xsl:value-of select="@title"/></xsl:attribute></xsl:if><xsl:apply-templates mode="spec" select="*|text()"/></xsl:element> + </xsl:template> + + + + <!-- Document specific utilities --> + + <xsl:template mode="section-number" match="node()[name()='section']"><xsl:value-of select="count(preceding-sibling::node()[name()='section'])+1"/></xsl:template> + <xsl:template mode="doc-number" match="node()[name()='doc']"><xsl:apply-templates mode="section-number" select="ancestor::node()[name()='section']"/>.<xsl:value-of select="1+count(preceding-sibling::node()[name()='doc' and attribute::title])"/></xsl:template> + <xsl:template mode="type-number" match="node()[name()='type' or name()='definition']"> + <xsl:choose> + <xsl:when test="count(preceding-sibling::node()[name()='doc' and attribute::title])>0"> + <xsl:variable name="doc-node" select="preceding-sibling::node()[name()='doc' and attribute::title]"/> + <xsl:variable name="offset" select="count($doc-node/preceding-sibling::node()[name()='type' or name()='definition'])"></xsl:variable> + <xsl:apply-templates mode="section-number" select="ancestor::node()[name()='section']"/>.<xsl:value-of select="count(preceding-sibling::node()[name()='doc' and attribute::title])"/>.<xsl:value-of select="1+count(preceding-sibling::node()[name()='type' or name()='definition'])-$offset"/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates mode="section-number" select="ancestor::node()[name()='section']"/>.<xsl:value-of select="1+count(preceding-sibling::node()[name()='type' or name()='definition'])"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + <xsl:template name="genTypeXref"> + <xsl:param name="type"/> + <xsl:choose> + <xsl:when test="$type='*'">*</xsl:when> + <xsl:otherwise><xsl:element name="a"><xsl:attribute name="href"><xsl:choose> + <xsl:when test="/ancestor-or-self::node()/descendant-or-self::node()[name()='type' and @name=$type]">#type-<xsl:value-of select="$type"/></xsl:when> + <xsl:otherwise> + <xsl:for-each select="document('index.xml')/descendant-or-self::node()[name()='xref' and @type='amqp']"> + <xsl:variable name="docname"><xsl:value-of select="@name"/>.xml</xsl:variable> + <xsl:if test="document($docname)/descendant-or-self::node()[name()='type' and @name=$type]"><xsl:value-of select="$docname"/>#type-<xsl:value-of select="$type"/></xsl:if> + </xsl:for-each> + </xsl:otherwise> + </xsl:choose></xsl:attribute><xsl:value-of select="$type"/></xsl:element> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template name="genErrorXref"> + <xsl:param name="type"/> + <xsl:choose> + <xsl:when test="/ancestor-or-self::node()/descendant-or-self::node()[name()='type' and @provides='error']/node()[name()='choice' and @name=$type]">#choice-<xsl:value-of select="/ancestor-or-self::node()/descendant-or-self::node()[name()='type' and @provides='error' and child::node()[name()='choice' and @name=$type]]/@name"/>-<xsl:value-of select="$type"/></xsl:when> + <xsl:otherwise> + <xsl:for-each select="document('index.xml')/descendant-or-self::node()[name()='xref' and @type='amqp']"> + <xsl:variable name="docname"><xsl:value-of select="@name"/>.xml</xsl:variable> + <xsl:if test="document($docname)/descendant-or-self::node()[name()='type' and @provides='error']/node()[name()='choice' and @name=$type]"> + #choice-<xsl:value-of select="document($docname)/descendant-or-self::node()[name()='type' and @provides='error' and child::node()[name()='choice' and @name=$type]]/@name"/>-<xsl:value-of select="$type"/> + </xsl:if> + </xsl:for-each> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + <!-- General Utilities --> + + <xsl:template name="toUpper"><xsl:param name="input"/><xsl:value-of select="translate($input,'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"></xsl:value-of></xsl:template> + <xsl:template name="toLower"><xsl:param name="input"/><xsl:value-of select="translate($input,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')"></xsl:value-of></xsl:template> + <xsl:template name="initCap"><xsl:param name="input"/><xsl:call-template name="toUpper"><xsl:with-param name="input" select="substring($input,1,1)"/></xsl:call-template><xsl:value-of select="substring($input,2)"/></xsl:template> + <xsl:template name="initCapWords"> + <xsl:param name="input"/> + <xsl:choose> + <xsl:when test="contains($input,' ')"> + <xsl:call-template name="initCap"><xsl:with-param name="input" select="substring-before($input, ' ')"/></xsl:call-template><xsl:text> </xsl:text><xsl:call-template name="initCapWords"><xsl:with-param name="input" select="substring-after($input, ' ')"/></xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="initCap"><xsl:with-param name="input" select="$input"/></xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + +</xsl:stylesheet> diff --git a/qpid/specs/apache-filters.xml b/qpid/specs/apache-filters.xml new file mode 100644 index 0000000000..f3bebc14ad --- /dev/null +++ b/qpid/specs/apache-filters.xml @@ -0,0 +1,224 @@ +<!-- + + 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. +--> +<!DOCTYPE amqp SYSTEM "amqp.dtd"> +<?xml-stylesheet type="text/xsl" href="amqp.xsl"?> + +<amqp name="apache-filters" label="Apache Proposed AMQP 1-0 Filters"> + <section name="legacy-amqp" title="Legacy AMQP Exchange Binding Support"> + <doc> + <p> + Versions of AMQP prior to 1.0 prescribed a model of Exchanges and Queues, where Queues were + bound to Exchanges with a binding key whose meaning depended upon the type of the Exchange. + In order to allow a consistent mechanism for addressing legacy AMQP Exchanges over AMQP 1.0 + the following filter types are defined. Use of an Exchange as an address for a Source thus + can be seen as equivalent to constructing exclusive queues bound to an Exchange in legacy + AMQP versions. + </p> + <p> + Containers which support the filters that are defined in this section should advertise the + capability <term>APACHE.ORG:LEGACY_AMQP_EXCHANGE_FILTERS</term> in their connection + capabilities when sending the open performative, and MUST provide this capability on + sources supporting these filter types. + </p> + </doc> + <type class="restricted" name="legacy-amqp-direct-binding" source="string" provides="filter"> + <descriptor name="apache.org:legacy-amqp-direct-binding:string" + code="0x0000468C:0x00000000"/> + <doc> + <p> + The legacy-amqp-direct-binding filter consists of a described string value. The filter + matches a message if and only if the described string value exactly matches the subject + field of the Properties section of the message being evaluated. If the message has no + Properties section, or if the subject field of the Properties section is not set, then + the legacy-amqp-direct-binding filter does not match. + </p> + </doc> + </type> + + <type class="restricted" name="legacy-amqp-topic-binding" source="string" provides="filter"> + <descriptor name="apache.org:legacy-amqp-topic-binding:string" + code="0x0000468C:0x00000001"/> + <doc> + <p> + The legacy-amqp-topic-binding filter consists of a described string value. The value + value described by the type is interpreted as a pattern to match against the subject + field of the Properties section of the message being evaluated. + </p> + <ul> + <li>The pattern is formed using zero or more tokens, with each token delimited by the + "." character. The tokens "#" and "*" have special meanings.</li> + <li>The token consisting of the single character "*" matches a single word in the + subject field.</li> + <li>The token consisting of the single character "#" matches zero or more words in the + subject field.</li> + </ul> + <p> + Thus the filter value "*.stock.#" would match the subjects "usd.stock" and + "eur.stock.db" but not "stock.nasdaq". + </p> + <p> + If the message has no Properties section, or if the subject field of the Properties + section is not set, then the legacy-amqp-topic-binding filter matches only if the value + of the filter is a single "#". + </p> + </doc> + </type> + + <type class="restricted" name="legacy-amqp-headers-binding" source="map" provides="filter"> + <descriptor name="apache.org:legacy-amqp-headers-binding:map" code="0x0000468C:0x00000002"/> + <doc> + <p> + The legacy-amqp-headers-binding filter consists of a described map value. The map + value described by the type is interpreted as a pattern to match against the + application-properties section of the message being evaluated. The map has the same + restriction as the application-properties section, namely that the keys of this are + restricted to be of type string (which excludes the possibility of a null key) and the + values are restricted to be of simple types only, that is, excluding map, list, and + array types. + </p> + <p> + The key "x-match" in the described map has special meaning. This key MUST map to the + symbolic value "any" or the symbolic value "all" within the described map. All other + keys which begin "x-" MUST be ignored by the source when evaluating. If the value for + "x-match" is "all" then all other valid key-value pairs in the map MUST match with an + entry with the same key in the application-properties section. If the value for + "x-match" is "any" then the filter will accept the message if at least one key-value + pair matches the equivalent key value pair in the application-properties section. + </p> + <p> + A key-value pair in the filter's map matches a key-value pair in the + application-properties section if the keys are identical (including the same type), or + if the value in the filter map for the key is null. + </p> + </doc> + </type> + </section> + <section name="jms" title="Java Message Service Support"> + + <doc> + <p> + The Java Message Service defines two types of filtering of messages: firstly the ability to + exclude from a subscription messages sent by the same connection, secondly a more general + filtering syntax known as "selectors" based on an SQL like syntax. + </p> + <p> + AMQP filter extensions through which these two types of + filtering may be achieved are defined below. Their use, though + motivated by support for JMS, is not restricted to JMS. + </p> + </doc> + + <type class="composite" name="no-local-filter" source="list" provides="filter"> + <descriptor name="apache.org:no-local-filter:list" code="0x0000468C:0x00000003"/> + <doc> + <p> + A message will be accepted by the simple-no-local-filter if and only if the message + was originally sent to the container of the source on a separate connection from that + which is currently receiving from the source. + </p> + <p> + Containers which support this filter should advertise the + capability <term>APACHE.ORG:NO_LOCAL</term> in their + connection capabilities when sending the open + performative, and MUST provide this capability on sources + supporting these filter types. + </p> + </doc> + </type> + + <type class="restricted" name="selector-filter" provides="filter" source="string"> + <descriptor name="apache.org:selector-filter:string" code="0x0000468C:0x00000004"/> + <doc> + <p> + The Java Message Service "selector" defines an SQL like syntax for filtering messages. + The selector filters based on the values of "headers" and "properties". The defined + JMS headers can be mapped to equivalent fields within the AMQP message sections: + </p> +<picture title="Mapping JMS Headers to AMQP fields"> +JMS Header Name | AMQP 1.0 Field +==================|==================================================== +JMSCorrelationID | correlation-id field of properties section +JMSDeliveryMode | durable field of header section +JMSDestination | to field of the properties section +JMSExpiration | absolute-expiry-time of properties section +JMSMessageID | message-id of properties section +JMSPriority | priority field of header section +JMSRedelivered | delivery-count > 0 in header section +JMSReplyTo | reply-to in properties section +JMSTimestamp | creation-time of properties section +JMSType | annotation jms-type in message-annotations section +</picture> + <p> + When encoding the selector string on the wire, these JMS + header names should be translated to amqp.<i>field_name</i> + where <i>field_name</i> is the appropriate AMQP 1.0 field + named in the table above, with the hyphen replaced by an + underscore. For example, the selector: "JMSCorrelationID = + ’abc’ AND color = ’blue’ AND weight > 2500" would be + transferred over the wire as: "amqp.correlation_id = ’abc’ + AND color = ’blue’ AND weight > 2500" + </p> + <p> + The "properties" of the JMS message are equivalent to the AMQP application-properties + section. Thus a reference to a property Foo in a message selector would be evaluated + as the value associated with the key "Foo" (if present) in the application-properties + section. + </p> + <p> + The operands of the JMS selector are defined in terms of the types available within JMS, + When evaluated against the application properties section, the values within that section + MUST be evaluated according to the following type mapping. + </p> +<picture title="Mapping AMQP types to JMS types"> +AMQP Type | JMS Selector Type +==================|=================== +null | null +boolean | boolean +ubyte | short +ushort | int +uint | long +ulong | long +byte | byte +short | short +int | int +long | long +float | float +double | double +decimal32 | double +decimal64 | double +decimal128 | double +char | char +timestamp | long +uuid | byte[16] +binary | byte[] +string | String +symbol | String +</picture> + <p> + Containers which support this filter should advertise the + capability <term>APACHE.ORG:SELECTOR</term> in their + connection capabilities when sending the open + performative, and MUST provide this capability on sources + supporting these filter types. + </p> + </doc> + </type> + </section> +</amqp> |