[jbossseam-issues] [JBoss JIRA] Created: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
11:44 p.m.
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Priority: Optional
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help define
and restrict what data is allowed both in value space as well as lexical space. I have
gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and for
each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port" type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required" type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action" type="xs:normalizedString"
/>
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
4:41 a.m.
New subject: [jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Arron Ferguson commented on JBSEAM-3414:
----------------------------------------
There's always one omission isn't there? ... :|
The message attribute group's for attribute is missing a type:
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for" />
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
Should be:
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for" type="xs:token"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
Sorry for the confusion!
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Priority: Optional
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
2:31 p.m.
New subject: [jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Pete Muir commented on JBSEAM-3414:
-----------------------------------
I have not yet included any documentation (Peter, as
per our conversation on the forum) yet because I think
that this type of change should be done first and then
document what's left.
Totally agreed, splitting out patches/changes makes them much easier to understand
On a side note, I'm about 80% complete of an XSLT stylesheet
that will create Javadoc-like documentation of the pages.xsd.
This stylesheet uses the annotation/documentation elements for
description as well it tries to describe the content models and what
exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to
what this schema is about and how to create pages.xml files from
it (just like how javadoc creates nice reference documentation
complete with in-document examples). :)
Sounds great.
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Priority: Optional
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
2:37 p.m.
New subject: [jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Pete Muir commented on JBSEAM-3414:
-----------------------------------
There are a few issues yet left which are id values of certain
element types.
I've started off showing how uniqueness can be enforced (and it should be
if there are framework rules that state this in the user guide)
Agreed
by requiring that
conversation names be unique within a document. Note that this will only
check within the document. This presents a problem since the JBoss Seam
specification/guide allows multiple pages.xml files to exist. Seam developers
will need to consider how to enforce this. One possibility is to add structure
to the pages.xml file that contains a set of URLs that point to the other XML
files
Possible, but I'm not enamoured of this idea. At the moment I would prefer to keep the
ease of functionality of not requiring this, and checking at deployment time. Any other
ideas :-)
and have Seam check conversation names within all the documents
(so as to enforce uniqueness).
We should definitely do this at deploy time, can you file a JIRA for this?
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Priority: Optional
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
2:43 p.m.
New subject: [jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Arron Ferguson commented on JBSEAM-3414:
----------------------------------------
I forgot to mention before but I have actually and successfully validated my pages.xml,
and a couple of the others from the Seam samples (including SeamBay), all of which
successfully validated.
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Priority: Optional
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
3:24 p.m.
New subject: [jbossseam-issues] [JBoss JIRA] Updated: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Pete Muir updated JBSEAM-3414:
------------------------------
Attachment: pages-2.1.xsd.patch
I started to convert this into a usable patch by removing all the ws changes (these are
probably valuable, but detract from point of this patch...) Arron, can you submit the
changes in this format, with no ws changes?
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Priority: Optional
Attachments: pages-2.1.xsd.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
3:58 p.m.
New subject: [jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Arron Ferguson commented on JBSEAM-3414:
----------------------------------------
Ooop! You had even asked for it as unified diff ... I forgot. Here's the unified diff
file without all the whitespace changes (i.e., just the element changes):
--- pages-2.1.xsd 2008-09-15 13:47:01.000000000 -0700
+++ pages-2.1-arron.xsd 2008-09-15 13:56:56.000000000 -0700
@@ -3,7 +3,12 @@
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
-
+
+ <xs:annotation>
+ <xs:documentation>About this format ...</xs:documentation>
+ </xs:annotation>
+
+
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
@@ -16,18 +21,30 @@
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
+ <xs:key name="conversation-key">
+ <xs:annotation>
+ <xs:documentation><p>You can read this as:</p>
+ <p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
+ </xs:documentation>
+ </xs:annotation>
+ <xs:selector xpath="conversation"/>
+ <xs:field xpath="name"/>
+ </xs:key>
</xs:element>
-
+
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
- <xs:attribute name="http-port" />
- <xs:attribute name="https-port" />
+ <xs:attribute name="http-port"
type="xs:unsignedLong"/>
+ <xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
-
+
<xs:element name="exception">
<xs:annotation>
- <xs:documentation>A Seam exception handler</xs:documentation>
+ <xs:documentation>
+ <p>A Seam exception handler. Example:</p>
+ <code><pre>teh upload codes here</pre></code>
+ </xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
@@ -41,11 +58,11 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
- <xs:attribute name="class"/>
- <xs:attribute name="log"/>
- <xs:attribute name="logLevel"/>
+ <xs:attribute name="class" type="xs:token"/>
+ <xs:attribute name="log" type="pages:tf-boolean"/>
+ <xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
-
+
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
@@ -55,16 +72,16 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
- <xs:attribute name="name" use="required"/>
- <xs:attribute name="parameter-name" use="required"/>
- <xs:attribute name="parameter-value"/>
+ <xs:attribute name="name" use="required"
type="xs:token" />
+ <xs:attribute name="parameter-name" use="required"
type="xs:token" />
+ <xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
-
+
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
- <xs:complexType mixed="true">
+ <xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
@@ -87,36 +104,15 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
- <xs:attribute name="action"/>
+ <xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
- <xs:attribute name="switch" default="enabled">
- <xs:simpleType>
- <xs:restriction base="xs:token">
- <xs:enumeration value="enabled"/>
- <xs:enumeration value="disabled"/>
- </xs:restriction>
- </xs:simpleType>
- </xs:attribute>
+ <xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
- <xs:attribute name="conversation-required"
default="false">
- <xs:simpleType>
- <xs:restriction base="xs:token">
- <xs:enumeration value="true"/>
- <xs:enumeration value="false"/>
- </xs:restriction>
- </xs:simpleType>
- </xs:attribute>
- <xs:attribute name="login-required" default="false">
- <xs:simpleType>
- <xs:restriction base="xs:token">
- <xs:enumeration value="true"/>
- <xs:enumeration value="false"/>
- </xs:restriction>
- </xs:simpleType>
- </xs:attribute>
- <xs:attribute name="scheme"/>
- <xs:attribute name="timeout"/>
- <xs:attribute name="concurrent-request-timeout">
+ <xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
+ <xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
+ <xs:attribute name="scheme" type="pages:schemes" />
+ <xs:attribute name="timeout" type="xs:unsignedLong" />
+ <xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
@@ -126,11 +122,11 @@
</xs:documentation>
</xs:annotation>
</xs:attribute>
- <xs:attribute name="bundle"/>
- <xs:attribute name="conversation"/>
- <xs:attribute name="expires" />
+ <xs:attribute name="bundle" type="xs:token" />
+ <xs:attribute name="conversation" type="xs:token" />
+ <xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
-
+
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
@@ -141,42 +137,42 @@
</xs:element>
<xs:attributeGroup name="attlist.param">
- <xs:attribute name="name"/>
- <xs:attribute name="value"/>
- <xs:attribute name="converter"/>
- <xs:attribute name="converterId"/>
- <xs:attribute name="validator"/>
- <xs:attribute name="validatorId"/>
- <xs:attribute name="required" type="xs:boolean"/>
+ <xs:attribute name="name" type="xs:token" />
+ <xs:attribute name="value" type="xs:token" />
+ <xs:attribute name="converter" type="xs:token" />
+ <xs:attribute name="converterId" type="xs:token" />
+ <xs:attribute name="validator" type="xs:token" />
+ <xs:attribute name="validatorId" type="xs:token" />
+ <xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
-
+
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
- <xs:complexType mixed="true">
+ <xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
-
+
<xs:attributeGroup name="attlist.header">
- <xs:attribute name="name" use="required"/>
- <xs:attribute name="value" />
+ <xs:attribute name="name" use="required"
type="xs:token" />
+ <xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
-
+
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
- <xs:complexType mixed="true">
+ <xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
-
+
<xs:attributeGroup name="attlist.rewrite">
- <xs:attribute name="pattern" use="required"/>
+ <xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
-
+
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
@@ -186,16 +182,16 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
- <xs:attribute name="if"/>
- <xs:attribute name="execute" use="required"/>
+ <xs:attribute name="if" type="xs:normalizedString" />
+ <xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
-
+
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
-
+
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
@@ -225,10 +221,10 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
- <xs:attribute name="from-action"/>
- <xs:attribute name="evaluate"/>
+ <xs:attribute name="from-action"
type="xs:normalizedString" />
+ <xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
-
+
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
@@ -252,10 +248,10 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
- <xs:attribute name="if-outcome"/>
- <xs:attribute name="if"/>
+ <xs:attribute name="if-outcome" type="xs:normalizedString"
/>
+ <xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
-
+
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
@@ -265,9 +261,8 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
- <xs:attribute name="type" use="required"/>
+ <xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
-
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
@@ -277,38 +272,14 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
- <xs:attribute name="join" default="false">
- <xs:simpleType>
- <xs:restriction base="xs:token">
- <xs:enumeration value="true"/>
- <xs:enumeration value="false"/>
- </xs:restriction>
- </xs:simpleType>
- </xs:attribute>
- <xs:attribute name="nested" default="false">
- <xs:simpleType>
- <xs:restriction base="xs:token">
- <xs:enumeration value="true"/>
- <xs:enumeration value="false"/>
- </xs:restriction>
- </xs:simpleType>
- </xs:attribute>
- <xs:attribute name="pageflow"/>
- <xs:attribute name="flush-mode">
- <xs:simpleType>
- <xs:restriction base="xs:token">
- <xs:enumeration value="manual"/>
- <xs:enumeration value="auto"/>
- <xs:enumeration value="commit"/>
- <xs:enumeration value="MANUAL"/>
- <xs:enumeration value="AUTO"/>
- <xs:enumeration value="COMMIT"/>
- </xs:restriction>
- </xs:simpleType>
- </xs:attribute>
- <xs:attribute name="if"/>
+ <xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
+ <xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
+ <xs:attribute name="pageflow" type="xs:normalizedString"
/>
+ <xs:attribute name="flush-mode" type="pages:flush-modes"
/>
+ <xs:attribute name="if" type="xs:normalizedString" />
+ <xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
-
+
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
@@ -318,25 +289,10 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
- <xs:attribute name="before-redirect" default="false">
- <xs:simpleType>
- <xs:restriction base="xs:token">
- <xs:enumeration value="true"/>
- <xs:enumeration value="false"/>
- </xs:restriction>
- </xs:simpleType>
- </xs:attribute>
- <xs:attribute name="root" default="false">
- <xs:simpleType>
- <xs:restriction base="xs:token">
- <xs:enumeration value="true"/>
- <xs:enumeration value="false"/>
- </xs:restriction>
- </xs:simpleType>
- </xs:attribute>
- <xs:attribute name="if"/>
+ <xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
+ <xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
-
+
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
@@ -346,22 +302,11 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
- <xs:attribute name="task-id"/>
- <xs:attribute name="pageflow"/>
- <xs:attribute name="flush-mode">
- <xs:simpleType>
- <xs:restriction base="xs:token">
- <xs:enumeration value="manual"/>
- <xs:enumeration value="auto"/>
- <xs:enumeration value="commit"/>
- <xs:enumeration value="MANUAL"/>
- <xs:enumeration value="AUTO"/>
- <xs:enumeration value="COMMIT"/>
- </xs:restriction>
- </xs:simpleType>
- </xs:attribute>
+ <xs:attribute name="task-id" type="xs:token" />
+ <xs:attribute name="pageflow" type="xs:normalizedString"
/>
+ <xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
-
+
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
@@ -371,22 +316,11 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
- <xs:attribute name="task-id"/>
- <xs:attribute name="pageflow"/>
- <xs:attribute name="flush-mode">
- <xs:simpleType>
- <xs:restriction base="xs:token">
- <xs:enumeration value="manual"/>
- <xs:enumeration value="auto"/>
- <xs:enumeration value="commit"/>
- <xs:enumeration value="MANUAL"/>
- <xs:enumeration value="AUTO"/>
- <xs:enumeration value="COMMIT"/>
- </xs:restriction>
- </xs:simpleType>
- </xs:attribute>
+ <xs:attribute name="task-id" type="xs:token" />
+ <xs:attribute name="pageflow" type="xs:normalizedString"
/>
+ <xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
-
+
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
@@ -396,17 +330,10 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
- <xs:attribute name="transition"/>
- <xs:attribute name="before-redirect" default="false">
- <xs:simpleType>
- <xs:restriction base="xs:token">
- <xs:enumeration value="true"/>
- <xs:enumeration value="false"/>
- </xs:restriction>
- </xs:simpleType>
- </xs:attribute>
+ <xs:attribute name="transition" type="xs:token" />
+ <xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
-
+
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
@@ -416,9 +343,9 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
- <xs:attribute name="definition"/>
+ <xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
-
+
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
@@ -428,9 +355,9 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
- <xs:attribute name="process-id"/>
+ <xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
-
+
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
@@ -440,30 +367,11 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
- <xs:attribute name="name" use="required"/>
- <xs:attribute name="scope">
- <xs:simpleType>
- <xs:restriction base="xs:token">
- <xs:enumeration value="stateless"/>
- <xs:enumeration value="event"/>
- <xs:enumeration value="page"/>
- <xs:enumeration value="conversation"/>
- <xs:enumeration value="session"/>
- <xs:enumeration value="business_process"/>
- <xs:enumeration value="application"/>
- <xs:enumeration value="STATELESS"/>
- <xs:enumeration value="EVENT"/>
- <xs:enumeration value="PAGE"/>
- <xs:enumeration value="CONVERSATION"/>
- <xs:enumeration value="SESSION"/>
- <xs:enumeration value="BUSINESS_PROCESS"/>
- <xs:enumeration value="APPLICATION"/>
- </xs:restriction>
- </xs:simpleType>
- </xs:attribute>
- <xs:attribute name="value" use="required"/>
+ <xs:attribute name="name" use="required"
type="xs:token" />
+ <xs:attribute name="scope" type="pages:allowed-scopes"
/>
+ <xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
-
+
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
@@ -473,30 +381,11 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
- <xs:attribute name="name" use="required"/>
- <xs:attribute name="scope" default="CONVERSATION">
- <xs:simpleType>
- <xs:restriction base="xs:token">
- <xs:enumeration value="stateless"/>
- <xs:enumeration value="event"/>
- <xs:enumeration value="page"/>
- <xs:enumeration value="conversation"/>
- <xs:enumeration value="session"/>
- <xs:enumeration value="business_process"/>
- <xs:enumeration value="application"/>
- <xs:enumeration value="STATELESS"/>
- <xs:enumeration value="EVENT"/>
- <xs:enumeration value="PAGE"/>
- <xs:enumeration value="CONVERSATION"/>
- <xs:enumeration value="SESSION"/>
- <xs:enumeration value="BUSINESS_PROCESS"/>
- <xs:enumeration value="APPLICATION"/>
- </xs:restriction>
- </xs:simpleType>
- </xs:attribute>
- <xs:attribute name="value" use="required"/>
+ <xs:attribute name="name" use="required"
type="xs:token" />
+ <xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
+ <xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
-
+
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
@@ -511,7 +400,7 @@
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
-
+
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
@@ -521,15 +410,14 @@
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
-
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
- <xs:attribute name="url"/>
+ <xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
-
+
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
@@ -542,44 +430,169 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
- <xs:attribute name="error-code" use="required"/>
+ <xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
-
+
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
- <xs:complexType mixed="true">
- <xs:attributeGroup ref="pages:attlist.message"/>
+ <xs:complexType>
+ <xs:simpleContent>
+ <xs:extension base="xs:string">
+ <xs:attributeGroup ref="pages:attlist.message"/>
+ </xs:extension>
+ </xs:simpleContent>
</xs:complexType>
</xs:element>
+
<xs:attributeGroup name="attlist.message">
- <xs:attribute name="for"/>
- <xs:attribute name="severity" default="INFO">
- <xs:simpleType>
- <xs:restriction base="xs:token">
- <xs:enumeration value="info"/>
- <xs:enumeration value="warn"/>
- <xs:enumeration value="error"/>
- <xs:enumeration value="fatal"/>
- <xs:enumeration value="INFO"/>
- <xs:enumeration value="WARN"/>
- <xs:enumeration value="ERROR"/>
- <xs:enumeration value="FATAL"/>
- </xs:restriction>
- </xs:simpleType>
- </xs:attribute>
+ <xs:attribute name="for" type="xs:token"/>
+ <xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
-
+
+ <xs:element name="description" type="xs:string">
+ <xs:annotation>
+ <xs:documentation>A page description for workflow
switching</xs:documentation>
+ </xs:annotation>
+ </xs:element>
+
+ <xs:simpleType name="url">
+ <xs:restriction base="xs:token">
+ <xs:pattern value="http://.*|https://.*"/>
+ </xs:restriction>
+ </xs:simpleType>
+
+ <xs:simpleType name="schemes">
+ <xs:restriction base="xs:token">
+ <xs:enumeration value="https"/>
+ <xs:enumeration value="http"/>
+ </xs:restriction>
+ </xs:simpleType>
+
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
-
- <xs:element name="description" type="xs:string">
+
+ <xs:simpleType name="ableness">
+ <xs:restriction base="xs:token">
+ <xs:enumeration value="enabled"/>
+ <xs:enumeration value="disabled"/>
+ </xs:restriction>
+ </xs:simpleType>
+
+ <xs:simpleType name="tf-boolean">
<xs:annotation>
- <xs:documentation>A page description for workflow
switching</xs:documentation>
+ <xs:documentation>
+ <p>Allows for the following values:</p>
+ <ul>
+ <li>true</li>
+ <li>false</li>
+ </ul>
+ </xs:documentation>
+ </xs:annotation>
+ <xs:restriction base="xs:boolean">
+ <xs:pattern value="true"/>
+ <xs:pattern value="false"/>
+ </xs:restriction>
+ </xs:simpleType>
+
+ <xs:simpleType name="allowed-scopes">
+ <xs:restriction base="xs:token">
+ <xs:enumeration value="stateless"/>
+ <xs:enumeration value="event"/>
+ <xs:enumeration value="page"/>
+ <xs:enumeration value="conversation"/>
+ <xs:enumeration value="session"/>
+ <xs:enumeration value="business_process"/>
+ <xs:enumeration value="application"/>
+ <xs:enumeration value="STATELESS"/>
+ <xs:enumeration value="EVENT"/>
+ <xs:enumeration value="PAGE"/>
+ <xs:enumeration value="CONVERSATION"/>
+ <xs:enumeration value="SESSION"/>
+ <xs:enumeration value="BUSINESS_PROCESS"/>
+ <xs:enumeration value="APPLICATION"/>
+ </xs:restriction>
+ </xs:simpleType>
+
+ <xs:simpleType name="loglevel-values">
+ <xs:restriction base="xs:token">
+ <xs:enumeration value="info"/>
+ <xs:enumeration value="warn"/>
+ <xs:enumeration value="error"/>
+ <xs:enumeration value="fatal"/>
+ <xs:enumeration value="debug"/>
+ <xs:enumeration value="trace"/>
+ <xs:enumeration value="INFO"/>
+ <xs:enumeration value="WARN"/>
+ <xs:enumeration value="ERROR"/>
+ <xs:enumeration value="FATAL"/>
+ <xs:enumeration value="DEBUG"/>
+ <xs:enumeration value="TRACE"/>
+ </xs:restriction>
+ </xs:simpleType>
+
+ <xs:simpleType name="http-error-codes">
+ <xs:annotation>
+ <xs:documentation><p><b>Note:</b> These do not
include the HTTP extensions.</p></xs:documentation>
</xs:annotation>
- </xs:element>
+ <xs:restriction base="xs:token">
+ <xs:enumeration value="100"/>
+ <xs:enumeration value="101"/>
+ <xs:enumeration value="200"/>
+ <xs:enumeration value="201"/>
+ <xs:enumeration value="202"/>
+ <xs:enumeration value="203"/>
+ <xs:enumeration value="204"/>
+ <xs:enumeration value="205"/>
+ <xs:enumeration value="206"/>
+ <xs:enumeration value="300"/>
+ <xs:enumeration value="301"/>
+ <xs:enumeration value="302"/>
+ <xs:enumeration value="303"/>
+ <xs:enumeration value="304"/>
+ <xs:enumeration value="305"/>
+ <xs:enumeration value="306"/>
+ <xs:enumeration value="307"/>
+ <xs:enumeration value="400"/>
+ <xs:enumeration value="401"/>
+ <xs:enumeration value="402"/>
+ <xs:enumeration value="403"/>
+ <xs:enumeration value="404"/>
+ <xs:enumeration value="405"/>
+ <xs:enumeration value="406"/>
+ <xs:enumeration value="407"/>
+ <xs:enumeration value="408"/>
+ <xs:enumeration value="409"/>
+ <xs:enumeration value="410"/>
+ <xs:enumeration value="411"/>
+ <xs:enumeration value="412"/>
+ <xs:enumeration value="413"/>
+ <xs:enumeration value="414"/>
+ <xs:enumeration value="415"/>
+ <xs:enumeration value="416"/>
+ <xs:enumeration value="417"/>
+ <xs:enumeration value="500"/>
+ <xs:enumeration value="501"/>
+ <xs:enumeration value="502"/>
+ <xs:enumeration value="503"/>
+ <xs:enumeration value="504"/>
+ <xs:enumeration value="505"/>
+ </xs:restriction>
+ </xs:simpleType>
+
+ <xs:simpleType name="flush-modes">
+ <xs:restriction base="xs:token">
+ <xs:enumeration value="manual"/>
+ <xs:enumeration value="auto"/>
+ <xs:enumeration value="commit"/>
+ <xs:enumeration value="MANUAL"/>
+ <xs:enumeration value="AUTO"/>
+ <xs:enumeration value="COMMIT"/>
+ </xs:restriction>
+ </xs:simpleType>
+
</xs:schema>
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Priority: Optional
Attachments: pages-2.1.xsd.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
4:39 p.m.
New subject: [jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Arron Ferguson commented on JBSEAM-3414:
----------------------------------------
> by requiring that
> conversation names be unique within a document. Note that this will only
> check within the document. This presents a problem since the JBoss Seam
> specification/guide allows multiple pages.xml files to exist. Seam developers
> will need to consider how to enforce this. One possibility is to add structure
> to the pages.xml file that contains a set of URLs that point to the other XML
> files
Possible, but I'm not enamoured of this idea. At the moment I
would prefer to keep the ease of functionality > of not requiring this, and checking at
deployment time. Any other ideas :-)
No doubt. :) This issue is a bit of a pickle. There's no real clean way to do this
without having to uproot something(s). I can think of the following ways to solve this:
Option 1:
Leave this to the user to figure out. Probably the most tempting but not necessarily the
most supportive of solutions. :) Could maybe get away with this if there was a set of
classes that could be used to run this at the beginning - possibly some sort of
factory/application call?
Option 2:
Use XSLT to perform a transform on multiple documents (i.e., importing them in memory into
one, then perform validation). The XSLT stylesheet would use something like this (grabbing
multiple pages.xml documents:
<xsl:apply-templates select="document(concat(.,'.pages.xml'))"/>
The Java transform code would do this:
try
{
TransformerFactory tfactory = TransformerFactory.newInstance();
Transformer transformer =
tfactory.newTransformer(new StreamSource(xslt));
transformer.transform(new StreamSource(xml),
new StreamResult(html));
} catch (TransformerException e)
{
e.printStackTrace();
}
And the validation code would do this:
// create a schema ... from the document
SchemaFactory sf =
SchemaFactory.newInstance(
XMLConstants.W3C_XML_SCHEMA_NS_URI);
Schema schema = sf.newSchema();
// now parse, set us as error handler
SAXParserFactory spf = SAXParserFactory.newInstance();
spf.setNamespaceAware(true);
spf.setSchema(schema);
SAXParser sp = spf.newSAXParser();
sp.parse(file, this);
... // snip
public void warning(SAXParseException ex)
{
System.err.println("[WARNING]: line: " + ex.getLineNumber()
+ " col: " + ex.getColumnNumber());
System.err.println("[MESSAGE]: " + ex.getMessage() + "\n");
}
public void error(SAXParseException ex)
{
System.err.println("[ERROR]: line: " + ex.getLineNumber()
+ " col: " + ex.getColumnNumber());
System.err.println("[MESSAGE]: " + ex.getMessage() + "\n");
}
public void fatalError(SAXParseException ex) throws SAXException
{
System.err.println("[FATALERROR]: line: " + ex.getLineNumber()
+ " col: " + ex.getColumnNumber());
System.err.println("[MESSAGE]: " + ex.getMessage() +
"\n");
}
Problem is, the Seam app would have to do this as well as provide the minimal XSLT style
sheet to put these files together. It's not a lot of extra work but it is something
extra and yet one more feature (requiring more time).
Option 3:
Would be to change the requirements that there is only ever one pages.xml file. This would
be acceptable for sites with half dozen or less pages.xml files but for someone with
several dozen (or hundred), this may not be the best. It would also require users to
unlearn a feature they may have gotten use to. Users may revolt.
Option 4:
I just thought of another ... Specify this as an Ant task (or set of tasks) at compile
time. So somewhere in your build.xml file:
And (jacked right out of Apache's Ant documentation):
<style basedir="doc" destdir="build/doc"
extension=".html" style="style/apache.xsl"/>
<xslt in="pages.xml" out="build/doc/allofthepages.xml"
style="style/apache.xsl">
<outputproperty name="method" value="xml"/>
<outputproperty name="standalone" value="yes"/>
<outputproperty name="encoding" value="iso8859_1"/>
<outputproperty name="indent" value="yes"/>
</xslt>
Then validate the output file:
<!-- Validate the pages.xml file -->
<target name="validate-configs" depends="init-build"
description="Validate pages.xml file">
<schemavalidate failonerror="yes" lenient="no"
warn="yes" disabledtd="true" fullchecking="true">
<fileset dir="${config-dir}" includes="allofthepages.xml"
/>
</schemavalidate>
</target>
This would be quite clean but you would most likely have the maven zealots screaming foul
because you're forcing them to 'lower their standards', and use Ant. I have no
idea how you would/could do this in Maven (obviously I've stated my allegiance :P )
> and have Seam check conversation names within all the documents
> (so as to enforce uniqueness).
We should definitely do this at deploy time, can you file a JIRA for
this?
Sure, which option of the above do you think would receive the warmest welcome?
=====================
btw, last post, the diff is between what I did and the file found at:
http://anonsvn.jboss.org/repos/seam/trunk/src/main/org/jboss/seam/ ... hopefully this is
the most up-to-date.
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Priority: Optional
Attachments: pages-2.1.xsd.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
5:56 a.m.
New subject: [jbossseam-issues] [JBoss JIRA] Updated: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Pete Muir updated JBSEAM-3414:
------------------------------
Fix Version/s: 2.1.0.CR1
Assignee: Pete Muir
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Assignee: Pete Muir
Priority: Optional
Fix For: 2.1.0.CR1
Attachments: pages-2.1.xsd.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
3:50 a.m.
New subject: [jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Pete Muir commented on JBSEAM-3414:
-----------------------------------
I can't get this to apply. Can you try attaching the patch as a file to the issue -
often there are encoding problems when doing a copy/paste...
Best way to create the diff is to use "svn diff pages-2.1.xsd > pages.patch"
on your local changes
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Assignee: Pete Muir
Priority: Optional
Fix For: 2.1.0.CR1
Attachments: pages-2.1.xsd.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
7:04 p.m.
New subject: [jbossseam-issues] [JBoss JIRA] Updated: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Arron Ferguson updated JBSEAM-3414:
-----------------------------------
Attachment: pages.patch
Peter,
I'm new to JIRA - Sorry, I didn't see that attachement feature under operations.
:P
It appears that:
svn co http://anonsvn.jboss.org/repos/seam/trunk/src/main/org/jboss/seam/
svn diff pages-2.1.xsd > pages.patch
creates the same file so it must be something to do with copy/paste. Having said that,
here is the patched version as an attachment ... third time's a charm? Hopefully.
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Assignee: Pete Muir
Priority: Optional
Fix For: 2.1.0.CR1
Attachments: pages-2.1.xsd.patch, pages.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
7:15 a.m.
New subject: [jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Pete Muir commented on JBSEAM-3414:
-----------------------------------
Why have you gone for xs:normalizedString here
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
and here
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
rather than xs:token?
BTW what about having a el-expression type which actually validates that the EL expression
is valid?
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Assignee: Pete Muir
Priority: Optional
Fix For: 2.1.0.CR1
Attachments: pages-2.1.xsd.patch, pages.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
7:17 a.m.
New subject: [jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Pete Muir commented on JBSEAM-3414:
-----------------------------------
Actually, you seem to switch from xs:token to xs:normalizedString from that point on.
Also, we should check what is actually allowed in outcome strings and check that.
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Assignee: Pete Muir
Priority: Optional
Fix For: 2.1.0.CR1
Attachments: pages-2.1.xsd.patch, pages.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
7:19 a.m.
New subject: [jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Pete Muir commented on JBSEAM-3414:
-----------------------------------
We can also validate the for attribute on attlist:message as it can only be a valid JSF
id
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Assignee: Pete Muir
Priority: Optional
Fix For: 2.1.0.CR1
Attachments: pages-2.1.xsd.patch, pages.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
12:13 p.m.
New subject: [jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Arron Ferguson commented on JBSEAM-3414:
----------------------------------------
Actually, you seem to switch from xs:token to xs:normalizedString
from that point on.
Also, we should check what is actually allowed in outcome strings and
check that.
This was partly due to my lack of knowledge of what is allowed and also partly because
I'm not sure if the following are considered equal:
<action if="{condition.state}" execute="{bean.action}" />
<action if=" { condition.state } " execute=" { bean.action }
" />
The above are both considered different within lexical space but are considered equal
within value space. The second example would not be valid as a token but it would be valid
as a normalizedString (which has removed tabs and newlines). I think it could be changed
to a regex pattern as in:
<xs:simpleType name="el-expression">
<xs:restriction base="xs:token">
<xs:pattern value="#\{\w*\.\w*\}"/>
</xs:restriction>
</xs:simpleType>
Which changes the attribute from xs:token to "pages:el-expression" as in:
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="pages:elexpression" />
<xs:attribute name="execute" use="required"
type="pages:el-expression" />
</xs:attributeGroup>
And actually anything that requires an EL expression can change from xs:token or
xs:normalizedString to pages:el-expression if you feel that stripping out whitespace from
EL expressions is fair game (I think it is, I wasn't sure if you guys agreed).
This should work because there's really no reason to have extra whitespace. But this
would have to be documented clearly (i.e., only EL expressions matching the pattern were
allowed) so that users don't get frustrated when they find out they can't add
extra whitespace for formatting reasons.
Btw, I'm about 95% finished the pages.xsd schema doc XSLT stylesheet. It's pretty
cool. I had to dust off some of the cobwebs in the back of my brain to perform some of the
more trickier stylesheet tricks (e.g., showing XML code pretty formatted with perfect
indenting). It generates a very large web page that describes the data types as well as
showing annotation/documentation (which can now have paragraphs, lists -both ordered and
unordered, and preformatted code). It's definitely in the spirit of javadoc and
doxygen and can be incredibly useful for documentation - especially if
annotation/documentation elements are used within the schema.
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Assignee: Pete Muir
Priority: Optional
Fix For: 2.1.0.CR1
Attachments: pages-2.1.xsd.patch, pages.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
1:46 p.m.
New subject: [jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Pete Muir commented on JBSEAM-3414:
-----------------------------------
I comitted a first go at this. Please check it out :-)
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Assignee: Pete Muir
Priority: Optional
Fix For: 2.1.0.CR1
Attachments: pages-2.1.xsd.patch, pages.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
2:35 p.m.
New subject: [jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Arron Ferguson commented on JBSEAM-3414:
----------------------------------------
Looks good Peter. :) I attached another patch with what we just talked about which is
the el-expression type and replaced most of the xs:normalizedString types with it
(excluding pageflow attributes). Attachment added (as pages-el-expressions.patch.
I'll start documenting then.
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Assignee: Pete Muir
Priority: Optional
Fix For: 2.1.0.CR1
Attachments: pages-2.1.xsd.patch, pages.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
2:37 p.m.
New subject: [jbossseam-issues] [JBoss JIRA] Updated: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Arron Ferguson updated JBSEAM-3414:
-----------------------------------
Attachment: pages-el-expressions.patch
Contains el-expressions simpletype for replacing xs:normalizedString types
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Assignee: Pete Muir
Priority: Optional
Fix For: 2.1.0.CR1
Attachments: pages-2.1.xsd.patch, pages-el-expressions.patch, pages.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
5:42 a.m.
New subject: [jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Pete Muir commented on JBSEAM-3414:
-----------------------------------
I applied a version of your patch that classifies EL expressions. The pattern you used for
EL was far too restrcitive - take a look at all the syntax that JBoss EL offers
(projection using |, paramters etc.). I went with a simple "anything goes" for
now, but if you feel like trying to work out a expression that allows for 1 - * bases
(e.g. #{foo}, #{foo.bar.baz}), parameterized expressions (#{foo.bar(baz).ping(pong)}),
projections, EL functions (#{s:hasRole('foo')}) and anything else that is valid
according to the EL spec or the JBoss EL docs that would be neat :-)
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Assignee: Pete Muir
Priority: Optional
Fix For: 2.1.0.CR1
Attachments: pages-2.1.xsd.patch, pages-el-expressions.patch, pages.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
6:37 a.m.
New subject: [jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Pete Muir commented on JBSEAM-3414:
-----------------------------------
Arron, for tracking purposes I created the linked issue for more docs for pages.xsd - that
should allow us to close this issue off before 2.1.0.CR1
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Assignee: Pete Muir
Priority: Optional
Fix For: 2.1.0.CR1
Attachments: pages-2.1.xsd.patch, pages-el-expressions.patch, pages.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
10:47 a.m.
New subject: [jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Arron Ferguson commented on JBSEAM-3414:
----------------------------------------
I applied a version of your patch that classifies EL expressions. The
pattern you used for EL
was far too restrcitive - take a look at all the syntax that JBoss EL offers (projection
using |,
paramters etc.).
Cool. :) I see what you mean - yes, that would have been too restrictive.
but if you feel like trying to work out a expression that allows for
1 - * bases
(e.g. #{foo}, #{foo.bar.baz}), parameterized expressions (#{foo.bar(baz).ping(pong)}),
projections, EL functions (#{s:hasRole('foo')}) and anything else that is valid
according
to the EL spec or the JBoss EL docs that would be neat :-)
I'll have to read up on that and see if I can submit another. I figure what I'll
do is document first which will give me a much more intimate understanding of this
particular file at which point I can reevaluate and see if there's anything else that
can be applied. We can call this phase one of the restriction process. :) Phase two will
come after documentation. :)
Arron, for tracking purposes I created the linked issue for more docs
for
pages.xsd - that should allow us to close this issue off before 2.1.0.CR1
Cool, thanks, I'll submit a patch to that. One of our faculty who is in charge of our
department's web space has redone our public web space and so I'm awaiting
file/web space which I will link to once I get the XSLT stylesheet completed and pages.xsd
documented. When that happens, I'll post in the forum a link (knowledge base), link to
the stylesheet (for anyone who wants it) and submit the pages.xsd patch (which will have
the annotations) to the 3434 issue that you've linked to.
:)
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Assignee: Pete Muir
Priority: Optional
Fix For: 2.1.0.CR1
Attachments: pages-2.1.xsd.patch, pages-el-expressions.patch, pages.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
1:57 p.m.
New subject: [jbossseam-issues] [JBoss JIRA] Closed: (JBSEAM-3414) More restrictive/descriptive data structure of the pages.xsd
[
https://jira.jboss.org/jira/browse/JBSEAM-3414?page=com.atlassian.jira.pl...
]
Pete Muir closed JBSEAM-3414.
-----------------------------
Resolution: Done
Close this off, if you want to change other specifics in pages.xsd, then lets do it
through other issues :-)
More restrictive/descriptive data structure of the pages.xsd
------------------------------------------------------------
Key: JBSEAM-3414
URL: https://jira.jboss.org/jira/browse/JBSEAM-3414
Project: Seam
Issue Type: Feature Request
Components: Build, Core, Documentation Issues, Documentation Translation,
Examples
Environment: N/A (applies to all
Reporter: Arron Ferguson
Assignee: Pete Muir
Priority: Optional
Fix For: 2.1.0.CR1
Attachments: pages-2.1.xsd.patch, pages-el-expressions.patch, pages.patch
The pages.xsd schema in its current form is not restrictive enough to be descriptive for
those that are referencing the schema as a document/contract for what needs to go into
pages.xml files. Because of this many errors can take place without the user knowing he
has entered invalid data (invalid either into the value space or the lexical space).
The W3C XML Schema Recommendation allows for a rich set of constructs that can help
define and restrict what data is allowed both in value space as well as lexical space. I
have gone through and updated the pages-2.1.xsd XML schema file (from SVN) and have made
changes to it and included it within this document.
Many of the changes that I've made include:
- adding type attributes to the Attribute elements (which helps the user to to know what
type of value should be given to an attribute)
- the creation of more simple types to be used for attributes (e.g., http-error-codes)
- reuse (creating simple types to be reused)
- restricting values of attributes
I have not yet included any documentation (Peter, as per our conversation on the forum)
yet because I think that this type of change should be done first and then document
what's left. On a side note, I'm about 80% complete of an XSLT stylesheet that
will create Javadoc-like documentation of the pages.xsd. This stylesheet uses the
annotation/documentation elements for description as well it tries to describe the content
models and what exactly all those elements and attributes mean. Essentially we're
talking about self-documentation so that everyone is clear as to what this schema is about
and how to create pages.xml files from it (just like how javadoc creates nice reference
documentation complete with in-document examples). :)
There are a few issues yet left which are id values of certain element types. I've
started off showing how uniqueness can be enforced (and it should be if there are
framework rules that state this in the user guide) by requiring that conversation names be
unique within a document. Note that this will only check within the document. This
presents a problem since the JBoss Seam specification/guide allows multiple pages.xml
files to exist. Seam developers will need to consider how to enforce this. One possibility
is to add structure to the pages.xml file that contains a set of URLs that point to the
other XML files and have Seam check conversation names within all the documents (so as to
enforce uniqueness).
Anyways, here's the pages.xsd as I've seen fit to change it:
=============================
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
targetNamespace="http://jboss.com/products/seam/pages"
xmlns:pages="http://jboss.com/products/seam/pages">
<xs:annotation>
<xs:documentation>About this format ...</xs:documentation>
</xs:annotation>
<xs:element name="pages">
<xs:annotation>
<xs:documentation>The root of a pages.xml
file</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:conversation"/>
<xs:element ref="pages:page"/>
<xs:element ref="pages:exception"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.pages"/>
</xs:complexType>
<xs:key name="conversation-key">
<xs:annotation>
<xs:documentation><p>You can read this as:</p>
<p>The pages element has a bunch of conversation elements, and
for each of those conversation elements, they must have a unique name within this
document.</p>
</xs:documentation>
</xs:annotation>
<xs:selector xpath="conversation"/>
<xs:field xpath="name"/>
</xs:key>
</xs:element>
<xs:attributeGroup name="attlist.pages">
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="login-view-id"
type="pages:view-id"/>
<xs:attribute name="http-port"
type="xs:unsignedLong"/>
<xs:attribute name="https-port"
type="xs:unsignedLong"/>
</xs:attributeGroup>
<xs:element name="exception">
<xs:annotation>
<xs:documentation>A Seam exception handler</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:end-conversation"/>
<xs:choice>
<xs:element ref="pages:http-error"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.exception"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.exception">
<xs:attribute name="class" type="xs:token"/>
<xs:attribute name="log" type="pages:tf-boolean"/>
<xs:attribute name="logLevel"
type="pages:loglevel-values"/>
</xs:attributeGroup>
<xs:element name="conversation">
<xs:annotation>
<xs:documentation>Natural conversation
configuration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.conversation">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="parameter-name" use="required"
type="xs:token" />
<xs:attribute name="parameter-value" type="xs:token"
/>
</xs:attributeGroup>
<xs:element name="page">
<xs:annotation>
<xs:documentation>Configuration for a specific page or set up
pages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="pages:restrict"/>
<xs:element ref="pages:description"/>
<xs:element ref="pages:param"/>
<xs:element ref="pages:header" />
<xs:element ref="pages:rewrite" />
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
<xs:element ref="pages:in"/>
<xs:element ref="pages:raise-event"/>
<xs:element ref="pages:action"/>
<xs:element ref="pages:navigation"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.page"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.page">
<xs:attribute name="action" type="xs:token" />
<xs:attribute name="view-id" type="pages:view-id"/>
<xs:attribute name="switch" default="enabled"
type="pages:ableness"/>
<xs:attribute name="no-conversation-view-id"
type="pages:view-id" />
<xs:attribute name="conversation-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="login-required" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="scheme" type="pages:schemes" />
<xs:attribute name="timeout" type="xs:unsignedLong" />
<xs:attribute name="concurrent-request-timeout"
type="xs:unsignedLong" >
<xs:annotation>
<xs:documentation>
Requests to conversations are serialized by default, and if
a lock cannot be acquired in time, the request will be
dropped. You can set the timeout on a page-by-page basis
here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="bundle" type="xs:token" />
<xs:attribute name="conversation" type="xs:token" />
<xs:attribute name="expires" type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="param">
<xs:annotation>
<xs:documentation>A page parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.param"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.param">
<xs:attribute name="name" type="xs:token" />
<xs:attribute name="value" type="xs:token" />
<xs:attribute name="converter" type="xs:token" />
<xs:attribute name="converterId" type="xs:token" />
<xs:attribute name="validator" type="xs:token" />
<xs:attribute name="validatorId" type="xs:token" />
<xs:attribute name="required"
type="pages:tf-boolean"/>
</xs:attributeGroup>
<xs:element name="header">
<xs:annotation>
<xs:documentation>HTTP headers to be added</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.header"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.header">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="value" type="xs:token" />
</xs:attributeGroup>
<xs:element name="rewrite">
<xs:annotation>
<xs:documentation>URL rewriting pattern for this
view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.rewrite"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rewrite">
<xs:attribute name="pattern" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="action">
<xs:annotation>
<xs:documentation>Page action</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="execute" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="restrict" type="xs:string">
<xs:annotation>
<xs:documentation>Security restrictions</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="navigation">
<xs:annotation>
<xs:documentation>Page navigation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="2">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0"
maxOccurs="unbounded" ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event" maxOccurs="1"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:rule"/>
</xs:choice>
<xs:attributeGroup ref="pages:attlist.navigation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.navigation">
<xs:attribute name="from-action"
type="xs:normalizedString" />
<xs:attribute name="evaluate" type="xs:normalizedString"
/>
</xs:attributeGroup>
<xs:element name="rule">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="pages:begin-conversation"/>
<xs:element ref="pages:end-conversation"/>
<xs:element ref="pages:start-task"/>
<xs:element ref="pages:begin-task"/>
<xs:element ref="pages:end-task"/>
<xs:element ref="pages:create-process"/>
<xs:element ref="pages:resume-process"/>
</xs:choice>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:out"/>
<xs:element minOccurs="0"
ref="pages:raise-event"/>
<xs:choice minOccurs="0">
<xs:element ref="pages:render"/>
<xs:element ref="pages:redirect"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.rule"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.rule">
<xs:attribute name="if-outcome" type="xs:normalizedString"
/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="raise-event">
<xs:annotation>
<xs:documentation>Event to be raised</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.raise-event"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.raise-event">
<xs:attribute name="type" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-conversation">
<xs:annotation>
<xs:documentation>This page begins a new
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-conversation">
<xs:attribute name="join" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="nested" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
<xs:attribute name="if" type="xs:normalizedString" />
<xs:attribute name="conversation" type="xs:token" />
</xs:attributeGroup>
<xs:element name="end-conversation">
<xs:annotation>
<xs:documentation>This page ends a
conversation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-conversation"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-conversation">
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean"/>
<xs:attribute name="if" type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="begin-task">
<xs:annotation>
<xs:documentation>Begin a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.begin-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.begin-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="start-task">
<xs:annotation>
<xs:documentation>Start a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.start-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.start-task">
<xs:attribute name="task-id" type="xs:token" />
<xs:attribute name="pageflow" type="xs:normalizedString"
/>
<xs:attribute name="flush-mode" type="pages:flush-modes"
/>
</xs:attributeGroup>
<xs:element name="end-task">
<xs:annotation>
<xs:documentation>Add a BPM task</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.end-task"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.end-task">
<xs:attribute name="transition" type="xs:token" />
<xs:attribute name="before-redirect" default="false"
type="pages:tf-boolean" />
</xs:attributeGroup>
<xs:element name="create-process">
<xs:annotation>
<xs:documentation>Create a BPM process</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.create-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-process">
<xs:attribute name="definition" type="xs:token" />
</xs:attributeGroup>
<xs:element name="resume-process">
<xs:annotation>
<xs:documentation>Resume a BPM process
instance</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.resume-process"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.resume-process">
<xs:attribute name="process-id" type="xs:token" />
</xs:attributeGroup>
<xs:element name="in">
<xs:annotation>
<xs:documentation>A page input</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.in"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.in">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" type="pages:allowed-scopes"
/>
<xs:attribute name="value" use="required"
type="xs:normalizedString" />
</xs:attributeGroup>
<xs:element name="out">
<xs:annotation>
<xs:documentation>A contextual output for a navigation
rule</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="pages:attlist.out"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.out">
<xs:attribute name="name" use="required"
type="xs:token" />
<xs:attribute name="scope" default="CONVERSATION"
type="pages:allowed-scopes" />
<xs:attribute name="value" use="required"
type="xs:token" />
</xs:attributeGroup>
<xs:element name="render">
<xs:annotation>
<xs:documentation>Render a view</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.render"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.render">
<xs:attribute name="view-id" type="pages:view-id" />
</xs:attributeGroup>
<xs:element name="redirect">
<xs:annotation>
<xs:documentation>Redirect to another view or
URL</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
<xs:element minOccurs="0" maxOccurs="unbounded"
ref="pages:param"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.redirect"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.redirect">
<xs:attribute name="view-id" type="pages:view-id" />
<xs:attribute name="url" type="pages:url" />
</xs:attributeGroup>
<xs:element name="http-error">
<xs:annotation>
<xs:documentation>Send an HTTP error code</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
ref="pages:message"/>
</xs:sequence>
<xs:attributeGroup ref="pages:attlist.http-error"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.http-error">
<xs:attribute name="error-code" use="required"
type="xs:unsignedLong" />
</xs:attributeGroup>
<xs:element name="message">
<xs:annotation>
<xs:documentation>Add a message to the faces
messages</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="pages:attlist.message"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.message">
<xs:attribute name="for"/>
<xs:attribute name="severity" default="INFO"
type="pages:loglevel-values" />
</xs:attributeGroup>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>A page description for workflow
switching</xs:documentation>
</xs:annotation>
</xs:element>
<xs:simpleType name="url">
<xs:restriction base="xs:token">
<xs:pattern value="http://.*|https://.*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="schemes">
<xs:restriction base="xs:token">
<xs:enumeration value="https"/>
<xs:enumeration value="http"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="view-id">
<xs:restriction base="xs:string">
<xs:pattern value="(/.*)|\*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ableness">
<xs:restriction base="xs:token">
<xs:enumeration value="enabled"/>
<xs:enumeration value="disabled"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="tf-boolean">
<xs:restriction base="xs:boolean">
<xs:pattern value="true"/>
<xs:pattern value="false"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="allowed-scopes">
<xs:restriction base="xs:token">
<xs:enumeration value="stateless"/>
<xs:enumeration value="event"/>
<xs:enumeration value="page"/>
<xs:enumeration value="conversation"/>
<xs:enumeration value="session"/>
<xs:enumeration value="business_process"/>
<xs:enumeration value="application"/>
<xs:enumeration value="STATELESS"/>
<xs:enumeration value="EVENT"/>
<xs:enumeration value="PAGE"/>
<xs:enumeration value="CONVERSATION"/>
<xs:enumeration value="SESSION"/>
<xs:enumeration value="BUSINESS_PROCESS"/>
<xs:enumeration value="APPLICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="loglevel-values">
<xs:restriction base="xs:token">
<xs:enumeration value="info"/>
<xs:enumeration value="warn"/>
<xs:enumeration value="error"/>
<xs:enumeration value="fatal"/>
<xs:enumeration value="debug"/>
<xs:enumeration value="trace"/>
<xs:enumeration value="INFO"/>
<xs:enumeration value="WARN"/>
<xs:enumeration value="ERROR"/>
<xs:enumeration value="FATAL"/>
<xs:enumeration value="DEBUG"/>
<xs:enumeration value="TRACE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="http-error-codes">
<xs:annotation>
<xs:documentation><p>Note: These do not include the HTTP
extensions.</p></xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="100"/>
<xs:enumeration value="101"/>
<xs:enumeration value="200"/>
<xs:enumeration value="201"/>
<xs:enumeration value="202"/>
<xs:enumeration value="203"/>
<xs:enumeration value="204"/>
<xs:enumeration value="205"/>
<xs:enumeration value="206"/>
<xs:enumeration value="300"/>
<xs:enumeration value="301"/>
<xs:enumeration value="302"/>
<xs:enumeration value="303"/>
<xs:enumeration value="304"/>
<xs:enumeration value="305"/>
<xs:enumeration value="306"/>
<xs:enumeration value="307"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="405"/>
<xs:enumeration value="406"/>
<xs:enumeration value="407"/>
<xs:enumeration value="408"/>
<xs:enumeration value="409"/>
<xs:enumeration value="410"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="414"/>
<xs:enumeration value="415"/>
<xs:enumeration value="416"/>
<xs:enumeration value="417"/>
<xs:enumeration value="500"/>
<xs:enumeration value="501"/>
<xs:enumeration value="502"/>
<xs:enumeration value="503"/>
<xs:enumeration value="504"/>
<xs:enumeration value="505"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="flush-modes">
<xs:restriction base="xs:token">
<xs:enumeration value="manual"/>
<xs:enumeration value="auto"/>
<xs:enumeration value="commit"/>
<xs:enumeration value="MANUAL"/>
<xs:enumeration value="AUTO"/>
<xs:enumeration value="COMMIT"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
5937
days inactive
5946
days old
21 comments
2 participants
participants (2)
-
Arron Ferguson (JIRA) -
Pete Muir (JIRA)