draft-ietf-forces-model-extension-00.txt   draft-ietf-forces-model-extension-01.txt 
Internet Engineering Task Force E. Haleplidis Internet Engineering Task Force E. Haleplidis
Internet-Draft University of Patras Internet-Draft University of Patras
Intended status: Standards Track September 25, 2013 Intended status: Standards Track November 16, 2013
Expires: March 29, 2014 Expires: May 20, 2014
ForCES Model Extension ForCES Model Extension
draft-ietf-forces-model-extension-00 draft-ietf-forces-model-extension-01
Abstract Abstract
Forwarding and Control Element Separation (ForCES) defines an Forwarding and Control Element Separation (ForCES) defines an
architectural framework and associated protocols to standardize architectural framework and associated protocols to standardize
information exchange between the control plane and the forwarding information exchange between the control plane and the forwarding
plane in a ForCES Network Element (ForCES NE). RFC5812 has defined plane in a ForCES Network Element (ForCES NE). RFC5812 has defined
the ForCES Model provides a formal way to represent the capabilities, the ForCES Model provides a formal way to represent the capabilities,
state, and configuration of forwarding elements within the context of state, and configuration of forwarding elements within the context of
the ForCES protocol, so that control elements (CEs) can control the the ForCES protocol, so that control elements (CEs) can control the
FEs accordingly. More specifically, the model describes the logical FEs accordingly. More specifically, the model describes the logical
functions that are present in an FE, what capabilities these functions that are present in an FE, what capabilities these
functions support, and how these functions are or can be functions support, and how these functions are or can be
interconnected. interconnected.
RFC5812 has been around for two years and experience in its use has RFC5812 has been around for two years and experience in its use has
shown room for small extensions without a need to alter the protocol shown room for small extensions without a need to alter the protocol
while retaining backward compatibility with older xml libraries. while retaining backward compatibility with older xml libraries.
This document extends the model to allow complex datatypes for This document extends the model to allow complex datatypes for
metadata, optional default values for datatypes and optional access metadata, optional default values for datatypes and optional access
types for structures. The document also introduces three new types for structures. The document also introduces two new features
features, bitmap as a new datatype, a new event condition a new event condition BecomesEqualTo and LFB properties.
BecomesEqualTo and LFB properties.
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on March 29, 2014. This Internet-Draft will expire on May 20, 2014.
Copyright Notice Copyright Notice
Copyright (c) 2013 IETF Trust and the persons identified as the Copyright (c) 2013 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 30 skipping to change at page 2, line 30
Table of Contents Table of Contents
1. Terminology and Conventions . . . . . . . . . . . . . . . . . 2 1. Terminology and Conventions . . . . . . . . . . . . . . . . . 2
1.1. Requirements Language . . . . . . . . . . . . . . . . . . 2 1.1. Requirements Language . . . . . . . . . . . . . . . . . . 2
1.2. Definitions . . . . . . . . . . . . . . . . . . . . . . . 2 1.2. Definitions . . . . . . . . . . . . . . . . . . . . . . . 2
2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4 2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4
3. ForCES Model Extension proposal . . . . . . . . . . . . . . . 4 3. ForCES Model Extension proposal . . . . . . . . . . . . . . . 4
3.1. Complex datatypes for Metadata . . . . . . . . . . . . . 4 3.1. Complex datatypes for Metadata . . . . . . . . . . . . . 4
3.2. Optional Default Value for Datatypes . . . . . . . . . . 6 3.2. Optional Default Value for Datatypes . . . . . . . . . . 6
3.3. Optional Access Type for Structs . . . . . . . . . . . . 7 3.3. Optional Access Type for Structs . . . . . . . . . . . . 7
3.4. New datatype: Bitmap . . . . . . . . . . . . . . . . . . 8 3.4. New Event Condition: BecomesEqualTo . . . . . . . . . . . 8
3.5. New Event Condition: BecomesEqualTo . . . . . . . . . . . 10 3.5. LFB Properties . . . . . . . . . . . . . . . . . . . . . 9
3.6. LFB Properties . . . . . . . . . . . . . . . . . . . . . 11 3.6. Enhancing XML Validation . . . . . . . . . . . . . . . . 11
3.7. Enhancing XML Validation . . . . . . . . . . . . . . . . 12 4. XML Extension Schema for LFB Class Library Documents . . . . 12
4. XML Extension Schema for LFB Class Library Documents . . . . 13 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 25
5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 26 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 25
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 27 7. Security Considerations . . . . . . . . . . . . . . . . . . . 25
7. Security Considerations . . . . . . . . . . . . . . . . . . . 27 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 25
8. References . . . . . . . . . . . . . . . . . . . . . . . . . 27 8.1. Normative References . . . . . . . . . . . . . . . . . . 25
8.1. Normative References . . . . . . . . . . . . . . . . . . 27 8.2. Informative References . . . . . . . . . . . . . . . . . 25
8.2. Informative References . . . . . . . . . . . . . . . . . 27 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 25
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 27
1. Terminology and Conventions 1. Terminology and Conventions
1.1. Requirements Language 1.1. Requirements Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119]. document are to be interpreted as described in [RFC2119].
1.2. Definitions 1.2. Definitions
skipping to change at page 4, line 32 skipping to change at page 4, line 32
The ForCES Model [RFC5812] presents a formal way to define FEs The ForCES Model [RFC5812] presents a formal way to define FEs
Logical Function Blocks (LFBs) using XML. [RFC5812] has been Logical Function Blocks (LFBs) using XML. [RFC5812] has been
published a more than two years and current experience in its use has published a more than two years and current experience in its use has
demonstrated need for adding new and changing existing modeling demonstrated need for adding new and changing existing modeling
concepts. concepts.
Specifically this document extends the ForCES Model to allow complex Specifically this document extends the ForCES Model to allow complex
datatypes for metadata, optional default values for datatypes and datatypes for metadata, optional default values for datatypes and
optional access types for structures. Additionally the document optional access types for structures. Additionally the document
introduces three new features, bitmap as a new datatype, a new event introduces two new features a new event condition BecomesEqualTo and
condition BecomesEqualTo and LFB properties. LFB properties.
These extensions are an addendum to the ForCES model [RFC5812] and do These extensions are an addendum to the ForCES model [RFC5812] and do
not require any changes on the ForCES protocol [RFC5810] as they are not require any changes on the ForCES protocol [RFC5810] as they are
simply changes of the schema definition. Additionally backward simply changes of the schema definition. Additionally backward
compatibility is ensured as xml libraries produced with the earlier compatibility is ensured as xml libraries produced with the earlier
schema are still valid with the new one. schema are still valid with the new one.
XXX: Discussion is needed to specify whether bitmap required protocol
definition of how bitmap is sent through the wire.
3. ForCES Model Extension proposal 3. ForCES Model Extension proposal
3.1. Complex datatypes for Metadata 3.1. Complex datatypes for Metadata
Section 4.6. (Element for Metadata Definitions) in the ForCES Model Section 4.6. (Element for Metadata Definitions) in the ForCES Model
[RFC5812] limits the datatype use in metadata to only atomic types. [RFC5812] limits the datatype use in metadata to only atomic types.
Figure 1 shows the xml schema excerpt where ony typeRef and atomic Figure 1 shows the xml schema excerpt where ony typeRef and atomic
are allowed for a metadata definition. are allowed for a metadata definition.
However there are cases where complex metadata are used in the However there are cases where complex metadata are used in the
skipping to change at page 5, line 41 skipping to change at page 5, line 41
<xsd:choice> <xsd:choice>
<xsd:element name="typeRef" type="typeRefNMTOKEN"/> <xsd:element name="typeRef" type="typeRefNMTOKEN"/>
<xsd:element name="atomic" type="atomicType"/> <xsd:element name="atomic" type="atomicType"/>
</xsd:choice> </xsd:choice>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
Figure 1: Initial MetadataDefType Defintion in the schema Figure 1: Initial MetadataDefType Definition in the schema
<xsd:complexType name="metadataDefsType"> <xsd:complexType name="metadataDefsType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="metadataDef" maxOccurs="unbounded"> <xsd:element name="metadataDef" maxOccurs="unbounded">
<xsd:complexType> <xsd:complexType>
<xsd:sequence> <xsd:sequence>
<xsd:element name="name" type="xsd:NMTOKEN"/> <xsd:element name="name" type="xsd:NMTOKEN"/>
<xsd:element ref="synopsis"/> <xsd:element ref="synopsis"/>
<xsd:element name="metadataID" type="xsd:integer"/> <xsd:element name="metadataID" type="xsd:integer"/>
<xsd:element ref="description" minOccurs="0"/> <xsd:element ref="description" minOccurs="0"/>
skipping to change at page 6, line 25 skipping to change at page 6, line 25
<xsd:field xpath="@componentID"/> <xsd:field xpath="@componentID"/>
</xsd:key> </xsd:key>
</xsd:element> </xsd:element>
</xsd:choice> </xsd:choice>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
Figure 2: New MetadataDefType Defintion for the schema Figure 2: New MetadataDefType Definition for the schema
3.2. Optional Default Value for Datatypes 3.2. Optional Default Value for Datatypes
In the original schema, default values can only be defined for In the original schema, default values can only be defined for
datatypes defined inside LFB components and not inside structures or datatypes defined inside LFB components and not inside structures or
arrays. Therefore default values of datatypes that are constantly arrays. Therefore default values of datatypes that are constantly
being reused, e.g. counters with default value of 0, have to be being reused, e.g. counters with default value of 0, have to be
constantly respecified. Additionally, datatypes inside complex constantly respecified. Additionally, datatypes inside complex
datatypes cannot be defined with a default value, e.g. a counter datatypes cannot be defined with a default value, e.g. a counter
inside a struct that has a default value of 0. inside a struct that has a default value of 0.
skipping to change at page 7, line 11 skipping to change at page 7, line 11
Figure 3: Initial Excerpt of typeDeclarationGroup Defintion in the Figure 3: Initial Excerpt of typeDeclarationGroup Defintion in the
schema schema
<xsd:sequence> <xsd:sequence>
<xsd:element name="typeRef" type="typeRefNMTOKEN"/> <xsd:element name="typeRef" type="typeRefNMTOKEN"/>
<xsd:element name="DefaultValue" type="xsd:token" <xsd:element name="DefaultValue" type="xsd:token"
minOccurs="0"/> minOccurs="0"/>
</xsd:sequence> </xsd:sequence>
Figure 4: New Excerpt of typeDeclarationGroup Defintion in the schema Figure 4: New Excerpt of typeDeclarationGroup Definition in the
schema
Additionally it appends to the declaration of the AtomicType this xml Additionally it appends to the declaration of the AtomicType this xml
(Figure 5) to allow default values to Atomic datatypes. (Figure 5) to allow default values to Atomic datatypes.
<xsd:element name="defaultValue" type="xsd:token" minOccurs="0"/> <xsd:element name="defaultValue" type="xsd:token" minOccurs="0"/>
Figure 5: Appending xml in of AtomicType Defintion in the schema Figure 5: Appending xml in of AtomicType Definition in the schema
3.3. Optional Access Type for Structs 3.3. Optional Access Type for Structs
In the original schema, the access type can be only be defined on In the original schema, the access type can be only be defined on
components of LFB and not on components in structs or arrays. components of LFB and not on components in structs or arrays.
However when it's a struct datatype it is not possible to fine-tune However when it's a struct datatype it is not possible to fine-tune
access type per component in the struct. A simple use case would be access type per component in the struct. A simple use case would be
to have a read-write struct component where one of the components is to have a read-write struct component where one of the components is
a counter where the access-type could be read-reset or read-only, a counter where the access-type could be read-reset or read-only,
e.g. a read-reset or a read-only counter inside a struct. e.g. a read-reset or a read-only counter inside a struct.
skipping to change at page 8, line 44 skipping to change at page 8, line 45
</xsd:attribute> </xsd:attribute>
<xsd:attribute name="componentID" type="xsd:unsignedInt" <xsd:attribute name="componentID" type="xsd:unsignedInt"
use="required"/> use="required"/>
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
Figure 7: New xml for the struct definition in the schema Figure 7: New xml for the struct definition in the schema
3.4. New datatype: Bitmap 3.4. New Event Condition: BecomesEqualTo
With the current schema it is valid to create a struct of booleans in
order to simulate a bitmap value. However each boolean is sent as
4bytes. This extension adds the bitmap, a set of sequential named
bits.
Bitmaps may be useful in describing capabilities, e.g. Link speed
capabilities as multiple boolean values.
EDITOR: Discussion may be required as to whether there is a need for
protocol description of how the bitmap is sent through the wire.
In the new schema, bits are named followed an optional bit value. An
example:
<dataTypeDef>
<name>BitmapExample</name>
<synopsis>A bitmap field example</synopsis>
<bitmap size="5">
<bit name="Bit1" position="1"/>
<bit name="Bit3" position="3"/>
</bitmap>
</dataTypeDef>
Figure 8: Example of bitmap Defintion
The ordering of the bits MUST be implemented in the order that are
defined in the xml library. Positions MUST range from 0 and reach
bitmap size-1.
If the size of the bitmap is not defined, then the size of the bitmap
MUST be the maximum position value of all the bit values, e.g. 4
The bitmap is defined in the model extension schema as follows:
<xsd:complexType name="bitmapType">
<xsd:sequence>
<xsd:element name="bit" maxOccurs="unbounded">
<xsd:complexType>
<xsd:attribute name="position" type="xsd:NMTOKEN"
use="required"/>
<xsd:attribute name="name" type="xsd:NMTOKEN"
use="required"/>
<xsd:attribute name="defaultValue" type="booleanValues"
use="optional"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="size" type="xsd:integer" use="optional"/>
</xsd:complexType>
<xsd:simpleType name="booleanValues">
<xsd:restriction base="xsd:integer">
<xsd:minInclusive value="0"/>
<xsd:maxInclusive value="1"/>
</xsd:restriction>
</xsd:simpleType>
Figure 9: New Excerpt of bitmap Defintion in the schema
Along with the needed addition to the typeDeclarationGroup
Definition:
<xsd:element name="bitmap" type="bitmapType"/>
Figure 10: New Excerpt of typeDeclarationGroup Defintion in the
schema
3.5. New Event Condition: BecomesEqualTo
This extensions adds one more event condition in the model schema, This extensions adds one more event condition in the model schema,
that of BecomesEqualTo. The difference between Greater Than and Less that of BecomesEqualTo. The difference between Greater Than and Less
Than, is that when the value is exactly that of the BecomesEqualTo, Than, is that when the value is exactly that of the BecomesEqualTo,
the event is triggered. This event condition is particular useful the event is triggered. This event condition is particular useful
when there is a need to monitor one or more states of an LFB or the when there is a need to monitor one or more states of an LFB or the
FE. For example in the CEHA [I-D.ietf-forces-ceha] document it may FE. For example in the CEHA [I-D.ietf-forces-ceha] document it may
be useful for the master CE to know which backup CEs have just become be useful for the master CE to know which backup CEs have just become
associated in order to connect to them and begin synchronizing the associated in order to connect to them and begin synchronizing the
state of the FE. The master CE could always poll for such state of the FE. The master CE could always poll for such
skipping to change at page 10, line 42 skipping to change at page 9, line 21
The event MUST be triggered only when the value of the targeted The event MUST be triggered only when the value of the targeted
component becomes equal to the event condition value and MUST NOT component becomes equal to the event condition value and MUST NOT
generate events while the targeted component's value remains equal to generate events while the targeted component's value remains equal to
the event condition's value. the event condition's value.
The BecomesEqualTo is appended to the schema as follows: The BecomesEqualTo is appended to the schema as follows:
<xsd:element name="eventBecomesEqualTo" <xsd:element name="eventBecomesEqualTo"
substitutionGroup="eventCondition"/> substitutionGroup="eventCondition"/>
Figure 11: New Excerpt of BecomesEqualTo event condition definition Figure 8: New Excerpt of BecomesEqualTo event condition definition in
in the schema the schema
It can become useful for the CE to be notified when the state has It can become useful for the CE to be notified when the state has
changed once the BecomesEqualTo event has been triggered, e.g. the CE changed once the BecomesEqualTo event has been triggered, e.g. the CE
may need to know when a backup CE has lost association. Such an may need to know when a backup CE has lost association. Such an
event can be generated either by defining a second event on the same event can be generated either by defining a second event on the same
component, namely an Event Changed, or by simply reusing component, namely an Event Changed, or by simply reusing
BecomesEqualTo and use event properties, in particular event BecomesEqualTo and use event properties, in particular event
hysteresis. We append the following definition for the event hysteresis. We append the following definition for the event
hysteresis defined in section 4.8.5.2 in [RFC5812], with V being the hysteresis defined in section 4.8.5.2 in [RFC5812], with V being the
hysteresis value: hysteresis value:
o For an <eventBecomesEqualTo/> condition, after the last o For an <eventBecomesEqualTo/> condition, after the last
notification a new <eventBecomesEqualTo/> notification MUST be notification a new <eventBecomesEqualTo/> notification MUST be
generated only one time once the value has changed by +/- V. generated only one time once the value has changed by +/- V.
For example using the value of 1 for V, will in effect create a For example using the value of 1 for V, will in effect create a
singular event that will notify the CE that the value has changed by singular event that will notify the CE that the value has changed by
at least 1. at least 1.
A developer of a CE must also take into account to use count or time A developer of a CE must also take into account to use count or time
filtering to avoid being overun by messages, e.g. in the case of filtering to avoid being overrun by messages, e.g. in the case of
rapid state changes. rapid state changes.
3.6. LFB Properties 3.5. LFB Properties
The current model definition specifies properties for components of The current model definition specifies properties for components of
LFBs. Experience however has proven valuable at least for debug LFBs. Experience however has proven valuable at least for debug
reasons, to have statistics per LFB instance to monitor sent/received reasons, to have statistics per LFB instance to monitor sent/received
messages and errors for communication between CE and FE. These messages and errors for communication between CE and FE. These
properties are read-only. properties are read-only.
Editorial: Need additional discussion whether we need these LFB In order to avoid ambiguity on protocol path semantics, this document
packets. Additional definition may be required to handle protocol reserves LFB component 0 for LFB properties. This reservation is
messages for LFB properties backwards compatible as no LFB definition uses LFB component 0. Any
command with a path starting from LFB component 0 refers to LFB
properties. The following change in the xml schema disallows usage
of LFB component 0:
<xsd:attribute name="componentID" type="xsd:unsignedInt"
use="required">
Figure 9: Initial xml for LFB Component IDs
<!-- Extension Added restriction to component ID -->
<xsd:attribute name="componentID" use="required">
<xsd:simpleType>
<xsd:restriction base="xsd:unsignedInt">
<xsd:minExclusive value="0"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<!-- End of extension -->
Figure 10: New xml for the disallowing usage of 0 as LFB Component
The following datatype definitions are to be used as properties for The following datatype definitions are to be used as properties for
LFB instances. LFB instances.
<dataTypeDef> <dataTypeDef>
<name>LFBProperties</name> <name>LFBProperties</name>
<synopsis>LFB Properties definition</synopsis> <synopsis>LFB Properties definition</synopsis>
<struct> <struct>
<component componentID="1"> <component componentID="1">
<name>PacketsSentToCE</name> <name>PacketsSentToCE</name>
skipping to change at page 12, line 42 skipping to change at page 11, line 38
<component componentID="8"> <component componentID="8">
<name>ReceivedErrorBytesFromCE</name> <name>ReceivedErrorBytesFromCE</name>
<synopsis>Error Bytes received from CE</synopsis> <synopsis>Error Bytes received from CE</synopsis>
<typeRef>uint32</typeRef> <typeRef>uint32</typeRef>
</component> </component>
</struct> </struct>
</dataTypeDef> </dataTypeDef>
Properties for LFB instances Properties for LFB instances
3.7. Enhancing XML Validation 3.6. Enhancing XML Validation
As specified earlier this is not an extension but an enhancement of As specified earlier this is not an extension but an enhancement of
the schema to provide additional validation rules. This includes the schema to provide additional validation rules. This includes
adding new key declarations to provide uniqueness as deinfed by the adding new key declarations to provide uniqueness as defined by the
ForCES Model [RFC5812]. Such validations work only on within the ForCES Model [RFC5812]. Such validations work only on within the
same xml file. same xml file.
The following validation rules have been appended in the original The following validation rules have been appended in the original
schema in [RFC5812]: schema in [RFC5812]:
1. Each metadata ID must be unique. 1. Each metadata ID must be unique.
2. LFB Class IDs must be unique. 2. LFB Class IDs must be unique.
skipping to change at page 13, line 30 skipping to change at page 12, line 25
4. XML Extension Schema for LFB Class Library Documents 4. XML Extension Schema for LFB Class Library Documents
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:ietf:params:xml:ns:forces:lfbmodel:1.0" xmlns="urn:ietf:params:xml:ns:forces:lfbmodel:1.0"
xmlns:lfb="urn:ietf:params:xml:ns:forces:lfbmodel:1.0" xmlns:lfb="urn:ietf:params:xml:ns:forces:lfbmodel:1.0"
targetNamespace="urn:ietf:params:xml:ns:forces:lfbmodel:1.0" targetNamespace="urn:ietf:params:xml:ns:forces:lfbmodel:1.0"
elementFormDefault="qualified" attributeFormDefault="unqualified"> elementFormDefault="qualified" attributeFormDefault="unqualified">
<xsd:annotation> <xsd:annotation>
<xsd:documentation xml:lang="en"> <xsd:documentation xml:lang="en">
Schema for Defining LFB Classes and associated types ( Schema for Defining LFB Classes and associated types
frames, data types for LFB attributes, and metadata). (frames, data types for LFB attributes, and metadata).
</xsd:documentation> </xsd:documentation>
</xsd:annotation> </xsd:annotation>
<xsd:element name="description" type="xsd:string" /> <xsd:element name="description" type="xsd:string"/>
<xsd:element name="synopsis" type="xsd:string" /> <xsd:element name="synopsis" type="xsd:string"/>
<!-- Document root element: LFBLibrary --> <!-- Document root element: LFBLibrary -->
<xsd:element name="LFBLibrary"> <xsd:element name="LFBLibrary">
<xsd:complexType> <xsd:complexType>
<xsd:sequence> <xsd:sequence>
<xsd:element ref="description" minOccurs="0" /> <xsd:element ref="description" minOccurs="0"/>
<xsd:element name="load" type="loadType" <xsd:element name="load" type="loadType"
minOccurs="0" maxOccurs="unbounded" /> minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="frameDefs" type="frameDefsType" <xsd:element name="frameDefs" type="frameDefsType"
minOccurs="0" /> minOccurs="0"/>
<xsd:element name="dataTypeDefs" type="dataTypeDefsType" <xsd:element name="dataTypeDefs" type="dataTypeDefsType"
minOccurs="0" /> minOccurs="0"/>
<xsd:element name="metadataDefs" type="metadataDefsType" <xsd:element name="metadataDefs" type="metadataDefsType"
minOccurs="0" /> minOccurs="0"/>
<xsd:element name="LFBClassDefs" type="LFBClassDefsType" <xsd:element name="LFBClassDefs" type="LFBClassDefsType"
minOccurs="0" /> minOccurs="0"/>
</xsd:sequence> </xsd:sequence>
<xsd:attribute name="provides" type="xsd:Name" <xsd:attribute name="provides" type="xsd:Name"
use="required" /> use="required"/>
</xsd:complexType> </xsd:complexType>
<!-- Uniqueness constraints --> <!-- Uniqueness constraints -->
<xsd:key name="frame"> <xsd:key name="frame">
<xsd:selector xpath="lfb:frameDefs/lfb:frameDef" /> <xsd:selector xpath="lfb:frameDefs/lfb:frameDef"/>
<xsd:field xpath="lfb:name" /> <xsd:field xpath="lfb:name"/>
</xsd:key> </xsd:key>
<xsd:key name="dataType"> <xsd:key name="dataType">
<xsd:selector xpath="lfb:dataTypeDefs/lfb:dataTypeDef" /> <xsd:selector xpath="lfb:dataTypeDefs/lfb:dataTypeDef"/>
<xsd:field xpath="lfb:name" /> <xsd:field xpath="lfb:name"/>
</xsd:key> </xsd:key>
<xsd:key name="metadataDef"> <xsd:key name="metadataDef">
<xsd:selector xpath="lfb:metadataDefs/lfb:metadataDef" /> <xsd:selector xpath="lfb:metadataDefs/lfb:metadataDef"/>
<xsd:field xpath="lfb:name" /> <xsd:field xpath="lfb:name"/>
</xsd:key> </xsd:key>
<xsd:key name="metadataDefID"> <xsd:key name="metadataDefID">
<xsd:selector xpath="lfb:metadataDefs/lfb:metadataDef" /> <xsd:selector xpath="lfb:metadataDefs/lfb:metadataDef"/>
<xsd:field xpath="lfb:metadataID" /> <xsd:field xpath="lfb:metadataID"/>
</xsd:key> </xsd:key>
<xsd:key name="LFBClassDef"> <xsd:key name="LFBClassDef">
<xsd:selector xpath="lfb:LFBClassDefs/lfb:LFBClassDef" /> <xsd:selector xpath="lfb:LFBClassDefs/lfb:LFBClassDef"/>
<xsd:field xpath="lfb:name" /> <xsd:field xpath="lfb:name"/>
</xsd:key> </xsd:key>
<xsd:key name="LFBClassDefID"> <xsd:key name="LFBClassDefID">
<xsd:selector xpath="lfb:LFBClassDefs/lfb:LFBClassDef" /> <xsd:selector xpath="lfb:LFBClassDefs/lfb:LFBClassDef"/>
<xsd:field xpath="@LFBClassID" /> <xsd:field xpath="@LFBClassID"/>
</xsd:key> </xsd:key>
</xsd:element> </xsd:element>
<xsd:complexType name="loadType"> <xsd:complexType name="loadType">
<xsd:attribute name="library" type="xsd:Name" use="required" /> <xsd:attribute name="library" type="xsd:Name" use="required"/>
<xsd:attribute name="location" type="xsd:anyURI" <xsd:attribute name="location" type="xsd:anyURI"
use="optional" /> use="optional"/>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="frameDefsType"> <xsd:complexType name="frameDefsType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="frameDef" maxOccurs="unbounded"> <xsd:element name="frameDef" maxOccurs="unbounded">
<xsd:complexType> <xsd:complexType>
<xsd:sequence> <xsd:sequence>
<xsd:element name="name" type="xsd:NMTOKEN" /> <xsd:element name="name" type="xsd:NMTOKEN"/>
<xsd:element ref="synopsis" /> <xsd:element ref="synopsis"/>
<xsd:element ref="description" <xsd:element ref="description"
minOccurs="0" /> minOccurs="0"/>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="dataTypeDefsType"> <xsd:complexType name="dataTypeDefsType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="dataTypeDef" maxOccurs="unbounded"> <xsd:element name="dataTypeDef" maxOccurs="unbounded">
<xsd:complexType> <xsd:complexType>
<xsd:sequence> <xsd:sequence>
<xsd:element name="name" type="xsd:NMTOKEN" /> <xsd:element name="name" type="xsd:NMTOKEN"/>
<xsd:element name="derivedFrom" type="xsd:NMTOKEN" <xsd:element name="derivedFrom" type="xsd:NMTOKEN"
minOccurs="0" /> minOccurs="0"/>
<xsd:element ref="synopsis" /> <xsd:element ref="synopsis"/>
<xsd:element ref="description" <xsd:element ref="description"
minOccurs="0" /> minOccurs="0"/>
<xsd:group ref="typeDeclarationGroup" /> <xsd:group ref="typeDeclarationGroup"/>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
<!-- Predefined (built-in) atomic data-types are: char, uchar, <!-- Predefined (built-in) atomic data-types are: char, uchar,
int16, uint16, int32, uint32, int64, uint64, string[N], string, int16, uint16, int32, uint32, int64, uint64, string[N], string,
byte[N], boolean, octetstring[N], float32, float64 --> byte[N], boolean, octetstring[N], float32, float64 -->
<xsd:group name="typeDeclarationGroup"> <xsd:group name="typeDeclarationGroup">
<xsd:choice> <xsd:choice>
<!-- Extension --> <!-- Extension -->
<xsd:sequence> <xsd:sequence>
<!-- /Extension --> <!-- /Extension -->
<xsd:element name="typeRef" type="typeRefNMTOKEN" /> <xsd:element name="typeRef" type="typeRefNMTOKEN"/>
<!-- Extension --> <!-- Extension -->
<xsd:element name="DefaultValue" type="xsd:token" <xsd:element name="DefaultValue" type="xsd:token"
minOccurs="0" /> minOccurs="0"/>
</xsd:sequence> </xsd:sequence>
<xsd:element name="bitmap" type="bitmapType"/>
<!-- /Extension --> <!-- /Extension -->
<xsd:element name="atomic" type="atomicType" /> <xsd:element name="atomic" type="atomicType"/>
<xsd:element name="array" type="arrayType"> <xsd:element name="array" type="arrayType">
<!-- Extension --> <!-- Extension -->
<!--declare keys to have unique IDs --> <!--declare keys to have unique IDs -->
<xsd:key name="contentKeyID"> <xsd:key name="contentKeyID">
<xsd:selector xpath="lfb:contentKey" /> <xsd:selector xpath="lfb:contentKey"/>
<xsd:field xpath="@contentKeyID" /> <xsd:field xpath="@contentKeyID"/>
</xsd:key> </xsd:key>
<!-- /Extension --> <!-- /Extension -->
</xsd:element> </xsd:element>
<xsd:element name="struct" type="structType"> <xsd:element name="struct" type="structType">
<!-- Extension --> <!-- Extension -->
<!-- key for componentIDs uniqueness in a struct --> <!-- key declaration to make componentIDs unique in a struct -->
<xsd:key name="structComponentID"> <xsd:key name="structComponentID">
<xsd:selector xpath="lfb:component" /> <xsd:selector xpath="lfb:component"/>
<xsd:field xpath="@componentID" /> <xsd:field xpath="@componentID"/>
</xsd:key> </xsd:key>
<!-- /Extension --> <!-- /Extension -->
</xsd:element> </xsd:element>
<xsd:element name="union" type="structType" /> <xsd:element name="union" type="structType"/>
<xsd:element name="alias" type="typeRefNMTOKEN" /> <xsd:element name="alias" type="typeRefNMTOKEN"/>
</xsd:choice> </xsd:choice>
</xsd:group> </xsd:group>
<xsd:simpleType name="typeRefNMTOKEN"> <xsd:simpleType name="typeRefNMTOKEN">
<xsd:restriction base="xsd:token"> <xsd:restriction base="xsd:token">
<xsd:pattern value="\c+" /> <xsd:pattern value="\c+"/>
<xsd:pattern value="string\[\d+\]" /> <xsd:pattern value="string\[\d+\]"/>
<xsd:pattern value="byte\[\d+\]" /> <xsd:pattern value="byte\[\d+\]"/>
<xsd:pattern value="octetstring\[\d+\]" /> <xsd:pattern value="octetstring\[\d+\]"/>
</xsd:restriction> </xsd:restriction>
</xsd:simpleType> </xsd:simpleType>
<xsd:complexType name="atomicType"> <xsd:complexType name="atomicType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="baseType" type="typeRefNMTOKEN" /> <xsd:element name="baseType" type="typeRefNMTOKEN"/>
<xsd:element name="rangeRestriction" <xsd:element name="rangeRestriction" type="rangeRestrictionType"
type="rangeRestrictionType" minOccurs="0" /> minOccurs="0"/>
<xsd:element name="specialValues" type="specialValuesType" <xsd:element name="specialValues" type="specialValuesType"
minOccurs="0"> minOccurs="0">
<!-- Extension --> <!-- Extension -->
<xsd:key name="SpecialValue"> <xsd:key name="SpecialValue">
<xsd:selector xpath="specialValue" /> <xsd:selector xpath="specialValue"/>
<xsd:field xpath="@value" /> <xsd:field xpath="@value"/>
</xsd:key> </xsd:key>
<!-- /Extension --> <!-- /Extension -->
</xsd:element> </xsd:element>
<!-- Extension --> <!-- Extension -->
<xsd:element name="defaultValue" type="xsd:token" <xsd:element name="defaultValue" type="xsd:token"
minOccurs="0" /> minOccurs="0"/>
<!-- /Extension --> <!-- /Extension -->
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="rangeRestrictionType"> <xsd:complexType name="rangeRestrictionType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="allowedRange" maxOccurs="unbounded"> <xsd:element name="allowedRange" maxOccurs="unbounded">
<xsd:complexType> <xsd:complexType>
<xsd:attribute name="min" type="xsd:integer" <xsd:attribute name="min" type="xsd:integer"
use="required" /> use="required"/>
<xsd:attribute name="max" type="xsd:integer" <xsd:attribute name="max" type="xsd:integer"
use="required" /> use="required"/>
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="specialValuesType"> <xsd:complexType name="specialValuesType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="specialValue" maxOccurs="unbounded"> <xsd:element name="specialValue" maxOccurs="unbounded">
<xsd:complexType> <xsd:complexType>
<xsd:sequence> <xsd:sequence>
<xsd:element name="name" type="xsd:NMTOKEN" /> <xsd:element name="name" type="xsd:NMTOKEN"/>
<xsd:element ref="synopsis" /> <xsd:element ref="synopsis"/>
</xsd:sequence> </xsd:sequence>
<xsd:attribute name="value" type="xsd:token" /> <xsd:attribute name="value" type="xsd:token"/>
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
<!-- Extension -->
<xsd:complexType name="bitmapType">
<xsd:sequence>
<xsd:element name="bit" maxOccurs="unbounded">
<xsd:complexType>
<xsd:attribute name="position" type="xsd:NMTOKEN"
use="required"/>
<xsd:attribute name="name" type="xsd:NMTOKEN"
use="required"/>
<xsd:attribute name="defaultValue" type="booleanValues"
use="optional"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="size" type="xsd:integer" use="optional"/>
</xsd:complexType>
<xsd:simpleType name="booleanValues">
<xsd:restriction base="xsd:integer">
<xsd:minInclusive value="0"/>
<xsd:maxInclusive value="1"/>
</xsd:restriction>
</xsd:simpleType>
<!-- /Extension -->
<xsd:complexType name="arrayType"> <xsd:complexType name="arrayType">
<xsd:sequence> <xsd:sequence>
<xsd:group ref="typeDeclarationGroup" /> <xsd:group ref="typeDeclarationGroup"/>
<xsd:element name="contentKey" minOccurs="0" <xsd:element name="contentKey" minOccurs="0"
maxOccurs="unbounded"> maxOccurs="unbounded">
<xsd:complexType> <xsd:complexType>
<xsd:sequence> <xsd:sequence>
<xsd:element name="contentKeyField" <xsd:element name="contentKeyField"
type="xsd:string" maxOccurs="unbounded" /> type="xsd:string" maxOccurs="unbounded"/>
</xsd:sequence> </xsd:sequence>
<xsd:attribute name="contentKeyID" type="xsd:integer" <xsd:attribute name="contentKeyID" type="xsd:integer"
use="required" /> use="required"/>
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
</xsd:sequence> </xsd:sequence>
<xsd:attribute name="type" use="optional" <xsd:attribute name="type" use="optional" default="variable-size">
default="variable-size">
<xsd:simpleType> <xsd:simpleType>
<xsd:restriction base="xsd:string"> <xsd:restriction base="xsd:string">
<xsd:enumeration value="fixed-size" /> <xsd:enumeration value="fixed-size"/>
<xsd:enumeration value="variable-size" /> <xsd:enumeration value="variable-size"/>
</xsd:restriction> </xsd:restriction>
</xsd:simpleType> </xsd:simpleType>
</xsd:attribute> </xsd:attribute>
<xsd:attribute name="length" type="xsd:integer" <xsd:attribute name="length" type="xsd:integer"
use="optional" /> use="optional"/>
<xsd:attribute name="maxLength" type="xsd:integer" <xsd:attribute name="maxLength" type="xsd:integer"
use="optional" /> use="optional"/>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="structType"> <xsd:complexType name="structType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="derivedFrom" type="typeRefNMTOKEN" <xsd:element name="derivedFrom" type="typeRefNMTOKEN"
minOccurs="0" /> minOccurs="0"/>
<xsd:element name="component" maxOccurs="unbounded"> <xsd:element name="component" maxOccurs="unbounded">
<xsd:complexType> <xsd:complexType>
<xsd:sequence> <xsd:sequence>
<xsd:element name="name" type="xsd:NMTOKEN" /> <xsd:element name="name" type="xsd:NMTOKEN"/>
<xsd:element ref="synopsis" /> <xsd:element ref="synopsis"/>
<xsd:element ref="description" <xsd:element ref="description"
minOccurs="0" /> minOccurs="0"/>
<xsd:element name="optional" minOccurs="0" /> <xsd:element name="optional" minOccurs="0"/>
<xsd:group ref="typeDeclarationGroup" /> <xsd:group ref="typeDeclarationGroup"/>
</xsd:sequence> </xsd:sequence>
<!-- Extension --> <xsd:attribute name="access" use="optional"
<xsd:attribute name="access" use="optional" default="read-write">
default="read-write">
<xsd:simpleType> <xsd:simpleType>
<xsd:list itemType="accessModeType"/> <xsd:list itemType="accessModeType"/>
</xsd:simpleType> </xsd:simpleType>
</xsd:attribute> </xsd:attribute>
<!-- /Extension --> <xsd:attribute name="componentID" type="xsd:unsignedInt"
<xsd:attribute name="componentID" use="required"/>
type="xsd:unsignedInt" use="required" />
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="metadataDefsType"> <xsd:complexType name="metadataDefsType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="metadataDef" maxOccurs="unbounded"> <xsd:element name="metadataDef" maxOccurs="unbounded">
<xsd:complexType> <xsd:complexType>
<xsd:sequence> <xsd:sequence>
<xsd:element name="name" type="xsd:NMTOKEN" /> <xsd:element name="name" type="xsd:NMTOKEN"/>
<xsd:element ref="synopsis" /> <xsd:element ref="synopsis"/>
<xsd:element name="metadataID" type="xsd:integer"/> <xsd:element name="metadataID" type="xsd:integer"/>
<xsd:element ref="description" <xsd:element ref="description"
minOccurs="0" /> minOccurs="0"/>
<xsd:choice> <xsd:choice>
<xsd:element name="typeRef" <xsd:element name="typeRef" type="typeRefNMTOKEN"/>
type="typeRefNMTOKEN" /> <xsd:element name="atomic" type="atomicType"/>
<xsd:element name="atomic" type="atomicType" />
<!-- Extension --> <!-- Extension -->
<xsd:element name="array" type="arrayType"> <xsd:element name="array" type="arrayType">
<!--declare keys to have unique IDs --> <!--declare keys to have unique IDs -->
<xsd:key name="contentKeyID1"> <xsd:key name="contentKeyID1">
<xsd:selector xpath="lfb:contentKey" /> <xsd:selector xpath="lfb:contentKey"/>
<xsd:field xpath="@contentKeyID" /> <xsd:field xpath="@contentKeyID"/>
</xsd:key> </xsd:key>
<!-- /Extension --> <!-- /Extension -->
</xsd:element> </xsd:element>
<xsd:element name="struct" type="structType"> <xsd:element name="struct" type="structType">
<!-- Extension --> <!-- Extension -->
<!-- key declaration to make componentIDs <!-- key declaration to make componentIDs unique
unique in a struct --> in a struct -->
<xsd:key name="structComponentID1"> <xsd:key name="structComponentID1">
<xsd:selector xpath="lfb:component" /> <xsd:selector xpath="lfb:component"/>
<xsd:field xpath="@componentID" /> <xsd:field xpath="@componentID"/>
</xsd:key> </xsd:key>
<!-- /Extension --> <!-- /Extension -->
</xsd:element> </xsd:element>
</xsd:choice> </xsd:choice>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="LFBClassDefsType"> <xsd:complexType name="LFBClassDefsType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="LFBClassDef" maxOccurs="unbounded"> <xsd:element name="LFBClassDef" maxOccurs="unbounded">
<xsd:complexType> <xsd:complexType>
<xsd:sequence> <xsd:sequence>
<xsd:element name="name" type="xsd:NMTOKEN" /> <xsd:element name="name" type="xsd:NMTOKEN"/>
<xsd:element ref="synopsis" /> <xsd:element ref="synopsis"/>
<xsd:element name="version" type="versionType" /> <xsd:element name="version" type="versionType"/>
<xsd:element name="derivedFrom" type="xsd:NMTOKEN" <xsd:element name="derivedFrom" type="xsd:NMTOKEN"
minOccurs="0" /> minOccurs="0"/>
<xsd:element name="inputPorts" <xsd:element name="inputPorts"
type="inputPortsType" type="inputPortsType" minOccurs="0"/>
minOccurs="0" />
<xsd:element name="outputPorts" <xsd:element name="outputPorts"
type="outputPortsType" type="outputPortsType" minOccurs="0"/>
minOccurs="0" />
<xsd:element name="components" <xsd:element name="components"
type="LFBComponentsType" type="LFBComponentsType" minOccurs="0"/>
minOccurs="0" />
<xsd:element name="capabilities" <xsd:element name="capabilities"
type="LFBCapabilitiesType" type="LFBCapabilitiesType" minOccurs="0"/>
minOccurs="0" />
<xsd:element name="events" type="eventsType" <xsd:element name="events" type="eventsType"
minOccurs="0" /> minOccurs="0"/>
<xsd:element ref="description" <xsd:element ref="description"
minOccurs="0" /> minOccurs="0"/>
</xsd:sequence> </xsd:sequence>
<xsd:attribute name="LFBClassID" <xsd:attribute name="LFBClassID" type="xsd:unsignedInt"
type="xsd:unsignedInt" use="required" /> use="required"/>
</xsd:complexType> </xsd:complexType>
<!-- Key constraint to ensure unique attribute names <!-- Key constraint to ensure unique attribute names
within a class: --> within a class: -->
<xsd:key name="components"> <xsd:key name="components">
<xsd:selector xpath="lfb:components/lfb:component" /> <xsd:selector xpath="lfb:components/lfb:component"/>
<xsd:field xpath="lfb:name" /> <xsd:field xpath="lfb:name"/>
</xsd:key> </xsd:key>
<xsd:key name="capabilities"> <xsd:key name="capabilities">
<xsd:selector xpath="lfb:capabilities/lfb:capability"/> <xsd:selector xpath="lfb:capabilities/lfb:capability"/>
<xsd:field xpath="lfb:name" /> <xsd:field xpath="lfb:name"/>
</xsd:key> </xsd:key>
<xsd:key name="events"> <xsd:key name="events">
<xsd:selector xpath="lfb:events/lfb:event" /> <xsd:selector xpath="lfb:events/lfb:event"/>
<xsd:field xpath="lfb:name" /> <xsd:field xpath="lfb:name"/>
</xsd:key> </xsd:key>
<xsd:key name="eventsIDs"> <xsd:key name="eventsIDs">
<xsd:selector xpath="lfb:events/lfb:event" /> <xsd:selector xpath="lfb:events/lfb:event"/>
<xsd:field xpath="@eventID" /> <xsd:field xpath="@eventID"/>
</xsd:key> </xsd:key>
<xsd:key name="componentIDs"> <xsd:key name="componentIDs">
<xsd:selector xpath="lfb:components/lfb:component" /> <xsd:selector xpath="lfb:components/lfb:component"/>
<xsd:field xpath="@componentID" /> <xsd:field xpath="@componentID"/>
</xsd:key> </xsd:key>
<xsd:key name="capabilityIDs"> <xsd:key name="capabilityIDs">
<xsd:selector xpath="lfb:capabilities/lfb:capability"/> <xsd:selector xpath="lfb:capabilities/lfb:capability"/>
<xsd:field xpath="@componentID" /> <xsd:field xpath="@componentID"/>
</xsd:key> </xsd:key>
<xsd:key name="ComponentCapabilityComponentIDUniqueness"> <xsd:key name="ComponentCapabilityComponentIDUniqueness">
<xsd:selector <xsd:selector
xpath="lfb:components/lfb:component| xpath="lfb:components/lfb:component|
lfb:capabilities/lfb:capability|lfb:events" /> lfb:capabilities/lfb:capability|lfb:events"/>
<xsd:field xpath="@componentID|@baseID" /> <xsd:field xpath="@componentID|@baseID"/>
</xsd:key> </xsd:key>
</xsd:element> </xsd:element>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
<xsd:simpleType name="versionType"> <xsd:simpleType name="versionType">
<xsd:restriction base="xsd:NMTOKEN"> <xsd:restriction base="xsd:NMTOKEN">
<xsd:pattern value="[1-9][0-9]*\.([1-9][0-9]*|0)" /> <xsd:pattern value="[1-9][0-9]*\.([1-9][0-9]*|0)"/>
</xsd:restriction> </xsd:restriction>
</xsd:simpleType> </xsd:simpleType>
<xsd:complexType name="inputPortsType"> <xsd:complexType name="inputPortsType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="inputPort" type="inputPortType" <xsd:element name="inputPort" type="inputPortType"
maxOccurs="unbounded" /> maxOccurs="unbounded"/>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="inputPortType"> <xsd:complexType name="inputPortType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="name" type="xsd:NMTOKEN" /> <xsd:element name="name" type="xsd:NMTOKEN"/>
<xsd:element ref="synopsis" /> <xsd:element ref="synopsis"/>
<xsd:element name="expectation" type="portExpectationType"/> <xsd:element name="expectation" type="portExpectationType"/>
<xsd:element ref="description" minOccurs="0" /> <xsd:element ref="description" minOccurs="0"/>
</xsd:sequence> </xsd:sequence>
<xsd:attribute name="group" type="xsd:boolean" <xsd:attribute name="group" type="xsd:boolean"
use="optional" default="0" /> use="optional" default="0"/>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="portExpectationType"> <xsd:complexType name="portExpectationType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="frameExpected" minOccurs="0"> <xsd:element name="frameExpected" minOccurs="0">
<xsd:complexType> <xsd:complexType>
<xsd:sequence> <xsd:sequence>
<!-- ref must refer to a name of a defined <!-- ref must refer to a name of a defined
frame type --> frame type -->
<xsd:element name="ref" type="xsd:string" <xsd:element name="ref" type="xsd:string"
maxOccurs="unbounded" /> maxOccurs="unbounded"/>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
<xsd:element name="metadataExpected" minOccurs="0"> <xsd:element name="metadataExpected" minOccurs="0">
<xsd:complexType> <xsd:complexType>
<xsd:choice maxOccurs="unbounded"> <xsd:choice maxOccurs="unbounded">
<!-- ref must refer to a name of a defined <!--ref must refer to a name of a defined metadata-->
metadata --> <xsd:element name="ref" type="metadataInputRefType"/>
<xsd:element name="ref"
type="metadataInputRefType" />
<xsd:element name="one-of" <xsd:element name="one-of"
type="metadataInputChoiceType" /> type="metadataInputChoiceType"/>
</xsd:choice> </xsd:choice>
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="metadataInputChoiceType"> <xsd:complexType name="metadataInputChoiceType">
<xsd:choice minOccurs="2" maxOccurs="unbounded"> <xsd:choice minOccurs="2" maxOccurs="unbounded">
<!-- ref must refer to a name of a defined metadata --> <!-- ref must refer to a name of a defined metadata -->
<xsd:element name="ref" type="xsd:NMTOKEN" /> <xsd:element name="ref" type="xsd:NMTOKEN"/>
<xsd:element name="one-of" type="metadataInputChoiceType" /> <xsd:element name="one-of" type="metadataInputChoiceType"/>
<xsd:element name="metadataSet" <xsd:element name="metadataSet" type="metadataInputSetType"/>
type="metadataInputSetType"/>
</xsd:choice> </xsd:choice>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="metadataInputSetType"> <xsd:complexType name="metadataInputSetType">
<xsd:choice minOccurs="2" maxOccurs="unbounded"> <xsd:choice minOccurs="2" maxOccurs="unbounded">
<!-- ref must refer to a name of a defined metadata --> <!-- ref must refer to a name of a defined metadata -->
<xsd:element name="ref" type="metadataInputRefType" /> <xsd:element name="ref" type="metadataInputRefType"/>
<xsd:element name="one-of" type="metadataInputChoiceType"/> <xsd:element name="one-of" type="metadataInputChoiceType"/>
</xsd:choice> </xsd:choice>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="metadataInputRefType"> <xsd:complexType name="metadataInputRefType">
<xsd:simpleContent> <xsd:simpleContent>
<xsd:extension base="xsd:NMTOKEN"> <xsd:extension base="xsd:NMTOKEN">
<xsd:attribute name="dependency" use="optional" <xsd:attribute name="dependency" use="optional"
default="required"> default="required">
<xsd:simpleType> <xsd:simpleType>
<xsd:restriction base="xsd:string"> <xsd:restriction base="xsd:string">
<xsd:enumeration value="required" /> <xsd:enumeration value="required"/>
<xsd:enumeration value="optional" /> <xsd:enumeration value="optional"/>
</xsd:restriction> </xsd:restriction>
</xsd:simpleType> </xsd:simpleType>
</xsd:attribute> </xsd:attribute>
<xsd:attribute name="defaultValue" type="xsd:token" <xsd:attribute name="defaultValue" type="xsd:token"
use="optional" /> use="optional"/>
</xsd:extension> </xsd:extension>
</xsd:simpleContent> </xsd:simpleContent>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="outputPortsType"> <xsd:complexType name="outputPortsType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="outputPort" type="outputPortType" <xsd:element name="outputPort" type="outputPortType"
maxOccurs="unbounded" /> maxOccurs="unbounded"/>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="outputPortType"> <xsd:complexType name="outputPortType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="name" type="xsd:NMTOKEN" /> <xsd:element name="name" type="xsd:NMTOKEN"/>
<xsd:element ref="synopsis" /> <xsd:element ref="synopsis"/>
<xsd:element name="product" type="portProductType" /> <xsd:element name="product" type="portProductType"/>
<xsd:element ref="description" minOccurs="0" /> <xsd:element ref="description" minOccurs="0"/>
</xsd:sequence> </xsd:sequence>
<xsd:attribute name="group" type="xsd:boolean" <xsd:attribute name="group" type="xsd:boolean"
use="optional" default="0" /> use="optional" default="0"/>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="portProductType"> <xsd:complexType name="portProductType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="frameProduced" minOccurs="0"> <xsd:element name="frameProduced" minOccurs="0">
<xsd:complexType> <xsd:complexType>
<xsd:sequence> <xsd:sequence>
<!-- ref must refer to a name of a defined <!-- ref must refer to a name of a defined
frame type --> frame type -->
<xsd:element name="ref" type="xsd:NMTOKEN" <xsd:element name="ref" type="xsd:NMTOKEN"
maxOccurs="unbounded" /> maxOccurs="unbounded"/>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
<xsd:element name="metadataProduced" minOccurs="0"> <xsd:element name="metadataProduced" minOccurs="0">
<xsd:complexType> <xsd:complexType>
<xsd:choice maxOccurs="unbounded"> <xsd:choice maxOccurs="unbounded">
<!-- ref must refer to a name of a defined <!-- ref must refer to a name of a
metadata --> defined metadata -->
<xsd:element name="ref" <xsd:element name="ref"
type="metadataOutputRefType" /> type="metadataOutputRefType"/>
<xsd:element name="one-of" <xsd:element name="one-of"
type="metadataOutputChoiceType" /> type="metadataOutputChoiceType"/>
</xsd:choice> </xsd:choice>
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="metadataOutputChoiceType"> <xsd:complexType name="metadataOutputChoiceType">
<xsd:choice minOccurs="2" maxOccurs="unbounded"> <xsd:choice minOccurs="2" maxOccurs="unbounded">
<!-- ref must refer to a name of a defined metadata --> <!-- ref must refer to a name of a defined metadata -->
<xsd:element name="ref" type="xsd:NMTOKEN" /> <xsd:element name="ref" type="xsd:NMTOKEN"/>
<xsd:element name="one-of" type="metadataOutputChoiceType"/> <xsd:element name="one-of" type="metadataOutputChoiceType"/>
<xsd:element name="metadataSet" <xsd:element name="metadataSet" type="metadataOutputSetType"/>
type="metadataOutputSetType" />
</xsd:choice> </xsd:choice>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="metadataOutputSetType"> <xsd:complexType name="metadataOutputSetType">
<xsd:choice minOccurs="2" maxOccurs="unbounded"> <xsd:choice minOccurs="2" maxOccurs="unbounded">
<!-- ref must refer to a name of a defined metadata --> <!-- ref must refer to a name of a defined metadata -->
<xsd:element name="ref" type="metadataOutputRefType" /> <xsd:element name="ref" type="metadataOutputRefType"/>
<xsd:element name="one-of" <xsd:element name="one-of" type="metadataOutputChoiceType"/>
type="metadataOutputChoiceType" />
</xsd:choice> </xsd:choice>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="metadataOutputRefType"> <xsd:complexType name="metadataOutputRefType">
<xsd:simpleContent> <xsd:simpleContent>
<xsd:extension base="xsd:NMTOKEN"> <xsd:extension base="xsd:NMTOKEN">
<xsd:attribute name="availability" use="optional" <xsd:attribute name="availability" use="optional"
default="unconditional"> default="unconditional">
<xsd:simpleType> <xsd:simpleType>
<xsd:restriction base="xsd:string"> <xsd:restriction base="xsd:string">
<xsd:enumeration value="unconditional" /> <xsd:enumeration value="unconditional"/>
<xsd:enumeration value="conditional" /> <xsd:enumeration value="conditional"/>
</xsd:restriction> </xsd:restriction>
</xsd:simpleType> </xsd:simpleType>
</xsd:attribute> </xsd:attribute>
</xsd:extension> </xsd:extension>
</xsd:simpleContent> </xsd:simpleContent>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="LFBComponentsType"> <xsd:complexType name="LFBComponentsType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="component" maxOccurs="unbounded"> <xsd:element name="component" maxOccurs="unbounded">
<xsd:complexType> <xsd:complexType>
<xsd:sequence> <xsd:sequence>
<xsd:element name="name" type="xsd:NMTOKEN" /> <xsd:element name="name" type="xsd:NMTOKEN"/>
<xsd:element ref="synopsis" /> <xsd:element ref="synopsis"/>
<xsd:element ref="description" <xsd:element ref="description"
minOccurs="0" /> minOccurs="0"/>
<xsd:element name="optional" minOccurs="0" /> <xsd:element name="optional" minOccurs="0"/>
<xsd:group ref="typeDeclarationGroup" /> <xsd:group ref="typeDeclarationGroup"/>
<xsd:element name="defaultValue" type="xsd:token" <xsd:element name="defaultValue" type="xsd:token"
minOccurs="0" /> minOccurs="0"/>
</xsd:sequence> </xsd:sequence>
<xsd:attribute name="access" use="optional" <xsd:attribute name="access" use="optional"
default="read-write"> default="read-write">
<xsd:simpleType> <xsd:simpleType>
<xsd:list itemType="accessModeType" /> <xsd:list itemType="accessModeType"/>
</xsd:simpleType> </xsd:simpleType>
</xsd:attribute> </xsd:attribute>
<xsd:attribute name="componentID" <!-- Extension Added restriction to component ID -->
type="xsd:unsignedInt" use="required" /> <xsd:attribute name="componentID" use="required">
<xsd:simpleType>
<xsd:restriction base="xsd:unsignedInt">
<xsd:minExclusive value="0"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<!-- End of extension -->
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
<xsd:simpleType name="accessModeType"> <xsd:simpleType name="accessModeType">
<xsd:restriction base="xsd:NMTOKEN"> <xsd:restriction base="xsd:NMTOKEN">
<xsd:enumeration value="read-only" /> <xsd:enumeration value="read-only"/>
<xsd:enumeration value="read-write" /> <xsd:enumeration value="read-write"/>
<xsd:enumeration value="write-only" /> <xsd:enumeration value="write-only"/>
<xsd:enumeration value="read-reset" /> <xsd:enumeration value="read-reset"/>
<xsd:enumeration value="trigger-only" /> <xsd:enumeration value="trigger-only"/>
</xsd:restriction> </xsd:restriction>
</xsd:simpleType> </xsd:simpleType>
<xsd:complexType name="LFBCapabilitiesType"> <xsd:complexType name="LFBCapabilitiesType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="capability" maxOccurs="unbounded"> <xsd:element name="capability" maxOccurs="unbounded">
<xsd:complexType> <xsd:complexType>
<xsd:sequence> <xsd:sequence>
<xsd:element name="name" type="xsd:NMTOKEN" /> <xsd:element name="name" type="xsd:NMTOKEN"/>
<xsd:element ref="synopsis" /> <xsd:element ref="synopsis"/>
<xsd:element ref="description" <xsd:element ref="description"
minOccurs="0" /> minOccurs="0"/>
<xsd:element name="optional" minOccurs="0" /> <xsd:element name="optional" minOccurs="0"/>
<xsd:group ref="typeDeclarationGroup" /> <xsd:group ref="typeDeclarationGroup"/>
</xsd:sequence> </xsd:sequence>
<xsd:attribute name="componentID" type="xsd:integer" <xsd:attribute name="componentID" type="xsd:integer"
use="required" /> use="required"/>
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
<xsd:complexType name="eventsType"> <xsd:complexType name="eventsType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="event" maxOccurs="unbounded"> <xsd:element name="event" maxOccurs="unbounded">
<xsd:complexType> <xsd:complexType>
<xsd:sequence> <xsd:sequence>
<xsd:element name="name" type="xsd:NMTOKEN" /> <xsd:element name="name" type="xsd:NMTOKEN"/>
<xsd:element ref="synopsis" /> <xsd:element ref="synopsis"/>
<xsd:element name="eventTarget" <xsd:element name="eventTarget"
type="eventPathType" /> type="eventPathType"/>
<xsd:element ref="eventCondition" /> <xsd:element ref="eventCondition"/>
<xsd:element name="eventReports" <xsd:element name="eventReports"
type="eventReportsType" minOccurs="0" /> type="eventReportsType" minOccurs="0"/>
<xsd:element ref="description" <xsd:element ref="description"
minOccurs="0" /> minOccurs="0"/>
</xsd:sequence> </xsd:sequence>
<xsd:attribute name="eventID" type="xsd:integer" <xsd:attribute name="eventID" type="xsd:integer"
use="required" /> use="required"/>
</xsd:complexType> </xsd:complexType>
</xsd:element> </xsd:element>
</xsd:sequence> </xsd:sequence>
<xsd:attribute name="baseID" type="xsd:integer" <xsd:attribute name="baseID" type="xsd:integer"
use="optional" /> use="optional"/>
</xsd:complexType> </xsd:complexType>
<!-- the substitution group for the event conditions --> <!-- the substitution group for the event conditions -->
<xsd:element name="eventCondition" abstract="true" /> <xsd:element name="eventCondition" abstract="true"/>
<xsd:element name="eventCreated" <xsd:element name="eventCreated"
substitutionGroup="eventCondition" /> substitutionGroup="eventCondition"/>
<xsd:element name="eventDeleted" <xsd:element name="eventDeleted"
substitutionGroup="eventCondition" /> substitutionGroup="eventCondition"/>
<xsd:element name="eventChanged" <xsd:element name="eventChanged"
substitutionGroup="eventCondition" /> substitutionGroup="eventCondition"/>
<xsd:element name="eventGreaterThan" <xsd:element name="eventGreaterThan"
substitutionGroup="eventCondition" /> substitutionGroup="eventCondition"/>
<xsd:element name="eventLessThan" <xsd:element name="eventLessThan"
substitutionGroup="eventCondition" /> substitutionGroup="eventCondition"/>
<!-- Extension --> <!-- Extension -->
<xsd:element name="eventBecomesEqualTo" <xsd:element name="eventBecomesEqualTo"
substitutionGroup="eventCondition"/> substitutionGroup="eventCondition"/>
<!-- /Extension --> <!-- /Extension -->
<xsd:complexType name="eventPathType"> <xsd:complexType name="eventPathType">
<xsd:sequence> <xsd:sequence>
<xsd:element ref="eventPathPart" maxOccurs="unbounded" /> <xsd:element ref="eventPathPart" maxOccurs="unbounded"/>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
<!-- the substitution group for the event path parts --> <!-- the substitution group for the event path parts -->
<xsd:element name="eventPathPart" type="xsd:string" <xsd:element name="eventPathPart" type="xsd:string"
abstract="true" /> abstract="true"/>
<xsd:element name="eventField" type="xsd:string" <xsd:element name="eventField" type="xsd:string"
substitutionGroup="eventPathPart" /> substitutionGroup="eventPathPart"/>
<xsd:element name="eventSubscript" type="xsd:string" <xsd:element name="eventSubscript" type="xsd:string"
substitutionGroup="eventPathPart" /> substitutionGroup="eventPathPart"/>
<xsd:complexType name="eventReportsType"> <xsd:complexType name="eventReportsType">
<xsd:sequence> <xsd:sequence>
<xsd:element name="eventReport" type="eventPathType" <xsd:element name="eventReport" type="eventPathType"
maxOccurs="unbounded" /> maxOccurs="unbounded"/>
</xsd:sequence> </xsd:sequence>
</xsd:complexType> </xsd:complexType>
<xsd:simpleType name="booleanType"> <xsd:simpleType name="booleanType">
<xsd:restriction base="xsd:string"> <xsd:restriction base="xsd:string">
<xsd:enumeration value="0" /> <xsd:enumeration value="0"/>
<xsd:enumeration value="1" /> <xsd:enumeration value="1"/>
</xsd:restriction> </xsd:restriction>
</xsd:simpleType> </xsd:simpleType>
</xsd:schema> </xsd:schema>
OpenFlow XML Library OpenFlow XML Library
5. Acknowledgements 5. Acknowledgements
The author would like to acknowledge Joel Halpern, Jamal Hadi and The author would like to acknowledge Joel Halpern, Jamal Hadi and
Dave Hood for their comments and discussion that helped shape this Dave Hood for their comments and discussion that helped shape this
document in a better way. document in a better way.
6. IANA Considerations 6. IANA Considerations
skipping to change at page 27, line 7 skipping to change at page 25, line 14
OpenFlow XML Library OpenFlow XML Library
5. Acknowledgements 5. Acknowledgements
The author would like to acknowledge Joel Halpern, Jamal Hadi and The author would like to acknowledge Joel Halpern, Jamal Hadi and
Dave Hood for their comments and discussion that helped shape this Dave Hood for their comments and discussion that helped shape this
document in a better way. document in a better way.
6. IANA Considerations 6. IANA Considerations
This memo includes no request to IANA. This specification requests that LFB Component ID 0 to be reserved.
7. Security Considerations 7. Security Considerations
The security considerations that have been described in the ForCES The security considerations that have been described in the ForCES
Model RFC [RFC5812] apply to this document as well. Model RFC [RFC5812] apply to this document as well.
8. References 8. References
8.1. Normative References 8.1. Normative References
[I-D.ietf-forces-ceha] [I-D.ietf-forces-ceha]
Ogawa, K., Wang, W., Haleplidis, E., and J. Salim, "ForCES Ogawa, K., Wang, W., Haleplidis, E., and J. Salim, "ForCES
Intra-NE High Availability", draft-ietf-forces-ceha-07 Intra-NE High Availability", draft-ietf-forces-ceha-08
(work in progress), May 2013. (work in progress), October 2013.
[OpenFlowSpec1.1] [OpenFlowSpec1.1]
http://www.OpenFlow.org/, "The OpenFlow 1.1 http://www.OpenFlow.org/, "The OpenFlow 1.1
Specification.", , <http://www.OpenFlow.org/documents/ Specification.", , <http://www.OpenFlow.org/documents/
OpenFlow-spec-v1.1.0.pdf>. OpenFlow-spec-v1.1.0.pdf>.
[RFC5810] Doria, A., Hadi Salim, J., Haas, R., Khosravi, H., Wang, [RFC5810] Doria, A., Hadi Salim, J., Haas, R., Khosravi, H., Wang,
W., Dong, L., Gopal, R., and J. Halpern, "Forwarding and W., Dong, L., Gopal, R., and J. Halpern, "Forwarding and
Control Element Separation (ForCES) Protocol Control Element Separation (ForCES) Protocol
Specification", RFC 5810, March 2010. Specification", RFC 5810, March 2010.
 End of changes. 153 change blocks. 
350 lines changed or deleted 267 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/