idnits 2.17.00 (12 Aug 2021) /tmp/idnits21023/draft-melnikov-acap-xml-01.txt: ** The Abstract section seems to be numbered Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Looks like you're using RFC 2026 boilerplate. This must be updated to follow RFC 3978/3979, as updated by RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- ** The document seems to lack a 1id_guidelines paragraph about 6 months document validity -- however, there's a paragraph with a matching beginning. Boilerplate error? ** The document seems to lack a 1id_guidelines paragraph about the list of current Internet-Drafts -- however, there's a paragraph with a matching beginning. Boilerplate error? ** The document seems to lack a 1id_guidelines paragraph about the list of Shadow Directories -- however, there's a paragraph with a matching beginning. Boilerplate error? == No 'Intended status' indicated for this document; assuming Proposed Standard == The page length should not exceed 58 lines per page, but there was 1 longer page, the longest (page 1) being 468 lines Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack an Introduction section. ** The document seems to lack an IANA Considerations section. (See Section 2.2 of https://www.ietf.org/id-info/checklist for how to handle the case when there are no actions for IANA.) ** There are 46 instances of too long lines in the document, the longest one being 59 characters in excess of 72. ** There are 14 instances of lines with control characters in the document. ** The abstract seems to contain references ([LDIF]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. ** The document seems to lack a both a reference to RFC 2119 and the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords -- however, there's a paragraph with a matching beginning. Boilerplate error? RFC 2119 keyword, line 163: '... MUST be represented as ele...' RFC 2119 keyword, line 173: '...ets of a dataset MUST be represented w...' RFC 2119 keyword, line 174: '...dataset> element MUST be subdataset of...' RFC 2119 keyword, line 203: '... -- dataset-name MUST be equal or subo...' RFC 2119 keyword, line 306: '...ange 0x00 - 0x1F MUST be base-64 encod...' (1 more instance...) Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (November 2000) is 7850 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Missing reference section? 'LDIF' on line 74 looks like a reference -- Missing reference section? 'KEYWORDS' on line 385 looks like a reference -- Missing reference section? 'UTF8' on line 393 looks like a reference -- Missing reference section? 'ACAP' on line 381 looks like a reference -- Missing reference section? 'MEDIA-TYPES' on line 397 looks like a reference -- Missing reference section? 'ABNF' on line 377 looks like a reference -- Missing reference section? 'URL-BASIC' on line 389 looks like a reference Summary: 11 errors (**), 0 flaws (~~), 3 warnings (==), 9 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Network Working Group 2 Internet Draft: XML DTD for ACAP A. Melnikov 3 Document: draft-melnikov-acap-xml-01.txt Messaging Direct, Ltd. 4 Expires: May 2001 November 2000 6 XML DTD for ACAP - ACAP data interchange format 8 Status of this Memo: 10 This document is an Internet-Draft and is in full conformance with 11 all provisions of Section 10 of RFC2026. 13 Internet-Drafts are working documents of the Internet Engineering 14 Task Force (IETF), its areas, and its working groups. Note that 15 other groups may also distribute working documents as 16 Internet-Drafts. 18 Internet-Drafts are draft documents valid for a maximum of six 19 months and may be updated, replaced, or obsoleted by other documents 20 at any time. It is inappropriate to use Internet- Drafts as 21 reference material or to cite them other than as "work in progress." 23 The list of current Internet-Drafts can be accessed at 24 26 The list of Internet-Draft Shadow Directories can be accessed at 27 . 29 A version of this draft document is intended for submission to the 30 RFC editor as a Proposed Standard for the Internet Community. 31 Discussion and suggestions for improvement are requested. 33 Copyright Notice 35 Copyright (C) The Internet Society 2000. All Rights Reserved. 37 0. Meta-information on this draft 39 This information is intended to facilitate discussion. It will be 40 removed when this document leaves the Internet-Draft stage. 42 0.1. Open issues and work to do 44 0). Default XML encoding is UTF-8? 46 1). Do we want data type for numbers? 48 2). I would like to use strong data types. Use NOTATION declaration? 50 3). When use base-64 encoding for attribute values? 52 Other open issues may be found in the document. They are marked with >>> 54 0.2. Changes from revision 00 56 1). Added attribute for dataset quota. 58 1. Abstract 60 This document describes a XML DTD suitable for describing application 61 configuration information or modifications made to configuration information. 62 The file format is typically used to import and export configuration information 63 between ACAP servers, or to describe a set of changes which are to be applied 64 to a ACAP database or a set of ACAP databases. 66 There are a number of situations where a common interchange format is 67 desirable. For example, one might wish to export a copy of the 68 contents of a ACAP server to a file, move that file to a 69 different machine, and import the contents into a second ACAP server. 70 In addition, well-defined interchange format facilitates the development of data 71 import or migration tools. 73 This document describes the interchange format that has the same objective for ACAP 74 as [LDIF] has for LDAP. 76 2. Conventions used in this document 78 The key words "MUST", "MUST NOT", "SHOULD", "SHOULD NOT", and "MAY" 79 in this document are to be interpreted as defined in "Key words for 80 use in RFCs to Indicate Requirement Levels" [KEYWORDS]. 82 When UTF-8 [UTF8] is referred to in this document, it refers to 83 Unicode version 2.0, and not Unicode version 1.1. 85 XML elements are enclosed in angle brackets in order to distinguish them from 86 ACAP terms with same names. 88 2. "ACAP in XML" DTD 90 2.1. Basic data types 92 96 100 104 108 112 116 120 124 128 2.2. ACAP servers and ACAP operations 130 The root element of the DTD descibed in this document is . It represents 131 the collection of ACAP servers. Each ACAP server is represented by element. 132 Nested elements represent some ACAP operation () or a collection of an ACAP 133 operations (, ). There is a one-to-one correlation between ACAP operations 134 which change ACAP database (modify (add or replace), delete, and entry rename), 135 and the names of the elements that describe these operations (, and 136 elements). This correspondence is intentional, and permits a straightforward 137 translation from the described operation to protocol operations. 139 141 143 146 148 150 153 Note: If mode is equal to "replace" then entry content (if element is used) 154 or acl (if element is used) is removed first and then all attributes/acls are added. 156 >>>Maybe add 'add' as the default value? 158 160 Note: Dataset attributes (default dataset ACLs, dataset inheritance and others) 161 must be represented as the attributes of the "" entry of a dataset 162 as described in Section 5 of [ACAP]. dataset.acl and dataset.acl. 163 MUST be represented as element (see description in Section 2.3.2) 165 170 Note: Although ACAP is missing command for setting quotas, some out of band mechanism 171 can be used by import utility to set them. 173 Note: Subdatasets of a dataset MUST be represented with dataset/entry element nesting. 174 As the result dataset name in element MUST be subdataset of the higher level 175 if any. For example, the following ACAP tree 176 /option/ 177 site/ 178 common/ 179 vendor.MD.Execmail/ 180 Telementry 181 MainWindow 182 vendor.MD.M-Store/ 183 SASL 185 may be represented as 186 187 188 189 ... 190 ... 191 192 193 194 195 ... 196 197 198 200 202 206 Note: From [ACAP]: "acl object" specifyis what the ACL applies to. 207 This is a parenthesized list. The list contains just the dataset name 208 when referring to the default ACL for a dataset. The list contains a 209 dataset name and an attribute name when referring to the default ACL 210 for an attribute in a dataset. The list contains a dataset name, an 211 attribute name, and an entry name when referring to the ACL for an 212 attribute of an entry of a dataset. 214 216 219 221 224 226 229 231 236 Note: Hierarchical rename is not allowed for an entry 238 240 242 248 250 253 2.3. Entries and Attributes 255 2.3.1. Predefined Attributes 257 259 262 264 267 269 272 1.3.2 Attribute Metadata 274 Different ACAP attribute metadata items are represented in different ways: 276 1). attribute name is represented as element attribute "name" 278 2). attribute acl is represented as element 280 3). attribute value is represented as one of the following elements : , , 281 , or 283 285 289 >>> Does any client will need "size" attribute metadata? 291 293 295 299 301 303 306 Note 1: Binary data that contains characters in the range 0x00 - 0x1F MUST be base-64 encoded. 307 The data that contains characters in the range 0x80 - 0xFF must be base-64 encoded if it is not 308 already in UTF-8. 310 Note 2: All symbols that have special meaning in XML MUST be encode according to XML rules 311 (for example character '<' must be encoded as <). 313 315 --> 317 319 321 3. Examples 323 Example 1: 325 326 327 328 329 330 331 332 333 334 sent mail 335 Pet: Yak 336 text/enriched 337 L. Eva Message 338 lem@pop.isp.com 339 smtp://smtp.isp.com 340 -- 341 L. Eva Message 342 344 345 347 348 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 381 [ACAP] Newman, Myers, "ACAP -- Application Configuration Access 382 Protocol", RFC 2244, Innosoft, Netscape, November 1997. 383 385 [KEYWORDS] Bradner, "Key words for use in RFCs to Indicate 386 Requirement Levels", RFC 2119, Harvard University, March 1997. 387 389 [URL-BASIC] Berners-Lee, Masinter, McCahill, "Uniform Resource 390 Locators (URL)", RFC 1738, CERN, Xerox Corporation, University of 391 Minnesota, December 1994. 393 [UTF8] Yergeau, F. "UTF-8, a transformation format of ISO 10646", 394 RFC 2279, Alis Technologies, January 1998. 395 397 [MEDIA-TYPES] Freed, Borenstein, "Multipurpose Internet Mail Extensions 398 (MIME) Part Two: Media Types", RFC 2046, Innosoft, First Virtual, 399 November 1996 400 402 5. Security Considerations 404 <> 406 6. Acknowledgments 408 <> 410 7. Author's Address 412 Alexey Melnikov 413 Messaging Direct, Ltd. 415 Address: 10117 Jaspet Avenue, Edmonton, Alberta, Canada, T5J1W8 416 Tel: 1 (780) 424-4922 Ext. 357 418 Email: mel@messagingdirect.com 420 8. Full Copyright Statement 422 Copyright (C) The Internet Society 2000. All Rights Reserved. 424 This document and translations of it may be copied and furnished to 425 others, and derivative works that comment on or otherwise explain it 426 or assist in its implementation may be prepared, copied, published 427 and distributed, in whole or in part, without restriction of any 428 kind, provided that the above copyright notice and this paragraph 429 are included on all such copies and derivative works. However, this 430 document itself may not be modified in any way, such as by removing 431 the copyright notice or references to the Internet Society or other 432 Internet organizations, except as needed for the purpose of 433 developing Internet standards in which case the procedures for 434 copyrights defined in the Internet Standards process must be 435 followed, or as required to translate it into languages other than 436 English. 438 The limited permissions granted above are perpetual and will not be 439 revoked by the Internet Society or its successors or assigns. 441 This document and the information contained herein is provided on an 442 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 443 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 444 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 445 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 446 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 448 Acknowledgement 450 Funding for the RFC Editor function is currently provided by the 451 Internet Society.