[prev in list] [next in list] [prev in thread] [next in thread]
List: midgard-dev
Subject: [midgard-cvs] cvs: midgard /proposals/storage20/namespace/api Makefile nsapistruct.sgml
From: jpbrunon <cvslog () midgard-project ! org>
Date: 2000-10-30 18:14:34
[Download RAW message or body]
jpbrunon Mon Oct 30 19:14:34 2000 EDT
Modified files:
/midgard/proposals/storage20/namespace/api Makefile
nsapistruct.sgml
Log:
update data structures, still alpha
Index: midgard/proposals/storage20/namespace/api/Makefile
diff -u midgard/proposals/storage20/namespace/api/Makefile:1.2 \
midgard/proposals/storage20/namespace/api/Makefile:1.3
--- midgard/proposals/storage20/namespace/api/Makefile:1.2 Sat Oct 28 11:37:40 2000
+++ midgard/proposals/storage20/namespace/api/Makefile Mon Oct 30 19:14:33 2000
@@ -10,10 +10,13 @@
# rtf does not work with images now.
all: img txt html ps pdf
+toto:
+ echo $(SGML_SOURCES)
+
# Documents to build in each format
# ! images -> documents dependencies omitted to have simple implicit rules
txt: $(TXT_DIR)/ns-api.txt
-html: img_jpg $(HTML_DIR)/ns-api
+html: img_jpg $(HTML_DIR)/ns-api toto
ps: img_eps $(PS_DIR)/ns-api.ps
pdf: img_eps $(PDF_DIR)/ns-api.pdf
rtf: img_eps $(RTF_DIR)/ns-api.rtf
Index: midgard/proposals/storage20/namespace/api/nsapistruct.sgml
diff -u midgard/proposals/storage20/namespace/api/nsapistruct.sgml:1.1 \
midgard/proposals/storage20/namespace/api/nsapistruct.sgml:1.2
--- midgard/proposals/storage20/namespace/api/nsapistruct.sgml:1.1 Sat Oct 28 \
11:39:18 2000
+++ midgard/proposals/storage20/namespace/api/nsapistruct.sgml Mon Oct 30 19:14:33 \
2000 @@ -5,6 +5,9 @@
Most fields are strings.
See the proposed C language header file ...
</para>
+ <para>
+ All attribute values are STRING, syntax is about string format.
+ </para>
<section id="nsapiconv">
<title>Conventions used (beta)</title>
@@ -39,10 +42,74 @@
<entry>{Format}</entry>
<entry>STRING formatted according to {format}</entry>
</row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
+ <section id="nsapisstrformat">
+ <title>List of string formats (beta)</title>
+ <table>
+ <title>String formats used</title>
+ <tgroup cols="3">
+ <colspec colnum="1" colwidth="1.50in">
+ <colspec colnum="3" colwidth="2.25in">
+ <thead>
<row>
- <entry>item_1 [| item_i]+</entry>
- <entry>One of the items (OR)</entry>
+ <entry>Name</entry>
+ <entry>Description</entry>
+ <entry>Format</entry>
</row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>{DistinguishedName}</entry>
+ <entry>
+ <emphasis>Global Unique IDentifier (GUID)</emphasis>.
+ Selecting a LDAP-like <emphasis>Distinguished Name (DN)</emphasis> as the \
GUID format has the advantage of including the parent GUID -and all its other \
ancestors- in the GUID itself. + </entry>
+ <entry>
+ The string format of the DN is defined in LDAP <emphasis>RFC 1779</emphasis>.
+ A {DistinguishedName} string may be parsed and exploded into components (RDN) \
using utility functions. + The "<emphasis><link \
linkend="nsapidn">DistinguishedName</link></emphasis>" structure will then be used. \
+ </entry> + </row>
+ <row>
+ <entry>{ObjectIdentifier}</entry>
+ <entry>
+ The <emphasis>Object Identifier</emphasis> is the unique identifier of any \
kind of structure: entry (record) or attribute type (field). + </entry>
+ <entry>
+ The Object Identifier string can be either a "classic" identifier or a list \
of numbers separated by a dot. + </entry>
+ </row>
+ <row>
+ <entry>{GeneralizedTime}</entry>
+ <entry>
+ <emphasis>Generalized Time</emphasis> is Greewhich Mean Time (GMT) with a \
precision of one second. + </entry>
+ <entry>
+ Format is "YYYYMMDDHHMMSSZ" where "YYYY" is the year, "MM" the month, "DD" \
the day of the month, "HH" the hour (00 to 23), "MM" the minutes, "SS" the seconds, \
and 'Z' means Zulu. + </entry>
+ </row>
+ <row>
+ <entry>{MidgardVersion}</entry>
+ <entry>
+ Version of an entry (record).
+ </entry>
+ <entry>
+ Version is list of numbers separated by a dot.
+ </entry>
+ </row>
+ <row>
+ <entry>{LanguageOption}</entry>
+ <entry>
+ Attribute (field) option for language.
+ </entry>
+ <entry>
+ Format is "lang-ll-CC" where "ll" is the language code (ISO 639), and "CC" is \
the country code (ISO 3166). + </entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -54,7 +121,7 @@
<title>Entry structure (record)</title>
<tgroup cols="3">
<colspec colnum="1" colwidth="1.00in">
- <colspec colnum="2" colwidth="1.00in">
+ <colspec colnum="2" colwidth="1.75in">
<thead>
<row>
<entry>Field</entry>
@@ -65,20 +132,10 @@
<tbody>
<row>
<entry>guid</entry>
- <entry>{DistinguishedName} STRING</entry>
+ <entry>{DistinguishedName}</entry>
<entry>Global Unique IDentifier</entry>
</row>
<row>
- <entry>classList</entry>
- <entry>[AttributeValue]+</entry>
- <entry>List of classes</entry>
- </row>
- <row>
- <entry>version</entry>
- <entry>[AttributeValue]</entry>
- <entry>Version of the entry</entry>
- </row>
- <row>
<entry>attributeList</entry>
<entry>[Attribute]*</entry>
<entry>List of attributes (fields) of the entry</entry>
@@ -86,25 +143,13 @@
</tbody>
</tgroup>
</table>
- <para>
- Allowing that one entry belongs to several classes adds more flexibility.
- Subtyping ...
- </para>
<section>
- <title>GUID format (alpha)</title>
- <para>
- Selecting a LDAP-like Distinguished Name (DN) as the GUID format has the advantage \
of including the parent GUID -and all other ancestors- in the GUID \
itself.
- The string format of the DN is defined in RFC ...
- </para>
- <para>
- The Distinguished Name may be parsed and exploded into components (RDN) using \
utility functions.
- The "DistinguishedName" structure will then be used.
- </para>
+ <title id ="nsapidn">DistinguishedName (GUID) (alpha)</title>
<table>
<title>DistinguishedName structure (GUID)</title>
<tgroup cols="3">
<colspec colnum="1" colwidth="1.00in">
- <colspec colnum="2" colwidth="1.00in">
+ <colspec colnum="2" colwidth="1.75in">
<thead>
<row>
<entry>Field</entry>
@@ -128,7 +173,7 @@
<title>Attribute structure (field)</title>
<tgroup cols="3">
<colspec colnum="1" colwidth="1.00in">
- <colspec colnum="2" colwidth="1.00in">
+ <colspec colnum="2" colwidth="1.75in">
<thead>
<row>
<entry>Field</entry>
@@ -139,7 +184,7 @@
<tbody>
<row>
<entry>type</entry>
- <entry>{ObjectIdentifier} STRING</entry>
+ <entry>{ObjectIdentifier}</entry>
<entry>Type of the attribute</entry>
</row>
<row>
@@ -154,7 +199,7 @@
<title>AttributeTypeAndValue structure</title>
<tgroup cols="3">
<colspec colnum="1" colwidth="1.00in">
- <colspec colnum="2" colwidth="1.00in">
+ <colspec colnum="2" colwidth="1.75in">
<thead>
<row>
<entry>Field</entry>
@@ -165,7 +210,7 @@
<tbody>
<row>
<entry>type</entry>
- <entry>{ObjectIdentifier}[;{Option}] STRING</entry>
+ <entry>{ObjectIdentifier}[;{Option}]</entry>
<entry>Type of the attribute</entry>
</row>
<row>
@@ -180,20 +225,21 @@
The exact format of string for values depends on the syntax of the attribute type.
</para>
<para>
- The type can be extended by setting an option, as the language of the attribute \
values. + The type can be extended by setting an option.
</para>
<para>
- Subtyping ...
+ The only option yet defined is the language of the attribute values.
+ Its format is {LanguageOption}.
</para>
<para>
- All attribute values are STRING, syntax is about string format.
+ Subtyping ...
</para>
<table>
<title>Predefined types of attributes</title>
<tgroup cols="4">
- <colspec colnum="1" colwidth="1.00in">
- <colspec colnum="2" colwidth="1.00in">
- <colspec colnum="3" colwidth="1.00in">
+ <colspec colnum="1" colwidth="1.25in">
+ <colspec colnum="2" colwidth="1.25in">
+ <colspec colnum="3" colwidth="1.35in">
<thead>
<row>
<entry>Name</entry>
@@ -232,6 +278,12 @@
<entry>2.5.18.2</entry>
<entry>{GeneralizedTime}</entry>
<entry>Last modification date (time stamp) of the entry</entry>
+ </row>
+ <row>
+ <entry>mgdVersion</entry>
+ <entry>1.3.6.1.4.1.6994.?</entry>
+ <entry>{MidgardVersion}</entry>
+ <entry>Version of the entry (record)</entry>
</row>
</tbody>
</tgroup>
---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@midgard-project.org
For additional commands, e-mail: cvs-help@midgard-project.org
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic