RFC5023 日本語訳
5023 The Atom Publishing Protocol. J. Gregorio, Ed., B. de hOra, Ed.. October 2007. (Format: TXT=102274 bytes) (Status: PROPOSED STANDARD)
プログラムでの自動翻訳です。
英語原文
Network Working Group J. Gregorio, Ed.
Request for Comments: 5023 Google
Category: Standards Track B. de hOra, Ed.
NewBay Software
October 2007
ワーキンググループのJ.グレゴリオ、エドをネットワークでつないでください。コメントのために以下を要求してください。 5023年のGoogleカテゴリ: エド規格Track B.de hOra、NewBay Software2007年10月
The Atom Publishing Protocol
原子出版プロトコル
Status of This Memo
このメモの状態
This document specifies an Internet standards track protocol for the Internet community, and requests discussion and suggestions for improvements. Please refer to the current edition of the "Internet Official Protocol Standards" (STD 1) for the standardization state and status of this protocol. Distribution of this memo is unlimited.
このドキュメントは、インターネットコミュニティにインターネット標準化過程プロトコルを指定して、改良のために議論と提案を要求します。 このプロトコルの標準化状態と状態への「インターネット公式プロトコル標準」(STD1)の現行版を参照してください。 このメモの分配は無制限です。
Abstract
要約
The Atom Publishing Protocol (AtomPub) is an application-level protocol for publishing and editing Web resources. The protocol is based on HTTP transfer of Atom-formatted representations. The Atom format is documented in the Atom Syndication Format.
Atom出版プロトコル(AtomPub)は、ウェブリソースを発行して、編集するためのアプリケーションレベルプロトコルです。 プロトコルはAtomによってフォーマットされた表現のHTTP転送に基づいています。 Atom書式はAtom Syndication Formatに記録されます。
Gregorio & de hOra Standards Track [Page 1] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[1ページ]RFC5023Atom出版プロトコル2007年10月
Table of Contents
目次
1. Introduction ....................................................4
2. Notational Conventions ..........................................4
2.1. XML-Related Conventions ....................................4
2.1.1. Referring to Information Items ......................4
2.1.2. RELAX NG Schema .....................................4
2.1.3. Use of "xml:base" and "xml:lang" ....................5
3. Terminology .....................................................5
4. Protocol Model ..................................................6
4.1. Identity and Naming ........................................6
4.2. Documents and Resource Classification ......................7
4.3. Control and Publishing .....................................8
4.4. Client Implementation Considerations .......................9
5. Protocol Operations .............................................9
5.1. Retrieving a Service Document .............................10
5.2. Listing Collection Members ................................10
5.3. Creating a Resource .......................................11
5.4. Editing a Resource ........................................11
5.4.1. Retrieving a Resource ..............................11
5.4.2. Editing a Resource .................................12
5.4.3. Deleting a Resource ................................12
5.5. Use of HTTP Response Codes ................................12
6. Protocol Documents .............................................13
6.1. Document Types ............................................13
6.2. Document Extensibility ....................................13
7. Category Documents .............................................14
7.1. Example ...................................................14
7.2. Element Definitions .......................................14
7.2.1. The "app:categories" Element .......................14
8. Service Documents ..............................................15
8.1. Workspaces ................................................16
8.2. Example ...................................................16
8.3. Element Definitions .......................................17
8.3.1. The "app:service" Element ..........................17
8.3.2. The "app:workspace" Element ........................18
8.3.3. The "app:collection" Element .......................18
8.3.4. The "app:accept" Element ...........................19
8.3.5. Usage in Atom Feed Documents .......................19
8.3.6. The "app:categories" Element .......................20
9. Creating and Editing Resources .................................20
9.1. Member URIs ...............................................20
9.2. Creating Resources with POST ..............................20
9.2.1. Example ............................................21
9.3. Editing Resources with PUT ................................22
9.4. Deleting Resources with DELETE ............................22
9.5. Caching and Entity Tags ...................................22
9.5.1. Example ............................................23
1. 序論…4 2. 記号法のコンベンション…4 2.1. XML関連のコンベンション…4 2.1.1. 情報項目を示します…4 2.1.2. NG図式を弛緩してください…4 2.1.3. 「xml: ベース」と「xml: lang」の使用…5 3. 用語…5 4. モデルについて議定書の中で述べてください…6 4.1. アイデンティティと命名…6 4.2. ドキュメントとリソース分類…7 4.3. コントロールと出版…8 4.4. クライアント実装問題…9 5. 操作について議定書の中で述べてください…9 5.1. サービスドキュメントを検索します…10 5.2. 収集メンバーを記載します…10 5.3. リソースを作成します…11 5.4. リソースを編集します…11 5.4.1. リソースを検索します…11 5.4.2. リソースを編集します…12 5.4.3. リソースを削除します…12 5.5. HTTP応答コードの使用…12 6. ドキュメントについて議定書の中で述べてください…13 6.1. タイプを記録してください…13 6.2. 伸展性を記録してください…13 7. カテゴリドキュメント…14 7.1. 例…14 7.2. 要素定義…14 7.2.1. 「装置: カテゴリ、」 要素…14 8. ドキュメントを調整してください…15 8.1. ワークスペース…16 8.2. 例…16 8.3. 要素定義…17 8.3.1. 「装置: 」 要素を調整してください…17 8.3.2. 「装置: ワークスペース、」 要素…18 8.3.3. 「装置: 収集、」 要素…18 8.3.4. 「装置: 受け入れてください」という要素…19 8.3.5. 原子給送ドキュメントの用法…19 8.3.6. 「装置: カテゴリ、」 要素…20 9. リソースを作成して、編集します…20 9.1. メンバーURI…20 9.2. ポストでリソースを作成します…20 9.2.1. 例…21 9.3. 置かれて、リソースを編集します。22 9.4. リソースを削除する、削除します。22 9.5. キャッシュと実体タグ…22 9.5.1. 例…23
Gregorio & de hOra Standards Track [Page 2] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[2ページ]RFC5023Atom出版プロトコル2007年10月
9.6. Media Resources and Media Link Entries ....................25
9.6.1. Examples ...........................................26
9.7. The Slug Header ...........................................30
9.7.1. Slug Header Syntax .................................31
9.7.2. Example ............................................31
10. Listing Collections ...........................................32
10.1. Collection Partial Lists .................................32
10.2. The "app:edited" Element .................................33
11. Atom Format Link Relation Extensions ..........................34
11.1. The "edit" Link Relation .................................34
11.2. The "edit-media" Link Relation ...........................34
12. The Atom Format Type Parameter ................................34
12.1. The "type" parameter .....................................34
12.1.1. Conformance .......................................35
13. Atom Publishing Controls ......................................35
13.1. The "app:control" Element ................................35
13.1.1. The "app:draft" Element ...........................36
14. Securing the Atom Publishing Protocol .........................36
15. Security Considerations .......................................37
15.1. Denial of Service ........................................37
15.2. Replay Attacks ...........................................37
15.3. Spoofing Attacks .........................................37
15.4. Linked Resources .........................................38
15.5. Digital Signatures and Encryption ........................38
15.6. URIs and IRIs ............................................38
15.7. Code Injection and Cross Site Scripting ..................39
16. IANA Considerations ...........................................39
16.1. Content-Type Registration for 'application/atomcat+xml' ..39
16.2. Content-Type Registration for 'application/atomsvc+xml' ..40
16.3. Header Field Registration for 'SLUG' .....................42
16.4. The Link Relation Registration "edit" ....................42
16.5. The Link Relation Registration "edit-media" ..............42
16.6. The Atom Format Media Type Parameter .....................43
17. References ....................................................43
17.1. Normative References .....................................43
17.2. Informative References ...................................44
Appendix A. Contributors ..........................................46
Appendix B. RELAX NG Compact Schema ...............................46
9.6. メディアリソースとメディアはエントリーをリンクします…25 9.6.1. 例…26 9.7. スラグヘッダー…30 9.7.1. ヘッダー構文を猛打してください…31 9.7.2. 例…31 10. 収集を記載します…32 10.1. 収集の部分的なリスト…32 10.2. 「装置: 」 要素を編集します…33 11. 原子形式リンク関係拡大…34 11.1. 「編集」リンク関係…34 11.2. 「編集メディア」は関係をリンクします…34 12. 原子形式型引数…34 12.1. 「タイプ」パラメタ…34 12.1.1. 順応…35 13. 原子出版は制御されます…35 13.1. 「装置: 制御してください」という要素…35 13.1.1. 「装置: 」 要素を作成してください…36 14. 原子出版を保証して、議定書を作ってください…36 15. セキュリティ問題…37 15.1. サービス妨害…37 15.2. 反射攻撃…37 15.3. スプーフィングは攻撃されます…37 15.4. リソースをリンクします…38 15.5. デジタル署名と暗号化…38 15.6. URIと虹彩…38 15.7. 注射とクロスサイトスクリプティングをコード化してください…39 16. IANA問題…39 16.1. 'アプリケーション/atomcat+xml'のためのコンテントタイプ登録。39 16.2. 'アプリケーション/atomsvc+xml'のためのコンテントタイプ登録。40 16.3. 'スラグ'のためのヘッダーフィールド登録…42 16.4. リンク関係登録「編集」…42 16.5. リンク関係登録「編集メディア」…42 16.6. 原子形式メディアはパラメタをタイプします…43 17. 参照…43 17.1. 標準の参照…43 17.2. 有益な参照…44 付録A.貢献者…46付録B.はNGのコンパクトな図式を弛緩します…46
Gregorio & de hOra Standards Track [Page 3] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[3ページ]RFC5023Atom出版プロトコル2007年10月
1. Introduction
1. 序論
The Atom Publishing Protocol is an application-level protocol for publishing and editing Web Resources using HTTP [RFC2616] and XML 1.0 [REC-xml]. The protocol supports the creation of Web Resources and provides facilities for:
Atom出版プロトコルは、HTTP[RFC2616]とXML1.0[REC-xml]を使用することでウェブResourcesを発行して、編集するためのアプリケーションレベルプロトコルです。 プロトコルは、ウェブResourcesの作成をサポートして、以下のために便宜を与えます。
o Collections: Sets of Resources, which can be retrieved in whole or
in part.
o 収集: Resourcesのセット。(Resourcesを全体か一部検索できます)。
o Services: Discovery and description of Collections.
o サービス: Collectionsの発見と記述。
o Editing: Creating, editing, and deleting Resources.
o 編集: Resourcesを作成して、編集して、削除します。
The Atom Publishing Protocol is different from many contemporary protocols in that the server is given wide latitude in processing requests from clients. See Section 4.4 for more details.
Atom出版プロトコルは多くの現代のプロトコルと広い緯度をサーバに与えるという点においてクライアントからの処理要求で異なっています。 その他の詳細に関してセクション4.4を見てください。
2. Notational Conventions
2. 記号法のコンベンション
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119].
キーワード“MUST"、「必須NOT」が「必要です」、“SHALL"、「」、“SHOULD"、「「推薦され」て、「5月」の、そして、「任意」のNOTは[RFC2119]で説明されるように本書では解釈されることであるべきですか?
2.1. XML-Related Conventions
2.1. XML関連のコンベンション
2.1.1. Referring to Information Items
2.1.1. 情報項目を示します。
Atom Protocol Document formats are specified in terms of the XML Information Set [REC-xml-infoset], serialized as XML 1.0 [REC-xml].
原子プロトコルDocument形式はXML1.0[REC-xml]として連載されたXML情報Set[REC-xml-infoset]に関して指定されます。
The Infoset terms "Element Information Item" and "Attribute Information Item" are shortened to "element" and "attribute" respectively. Therefore, when this specification uses the term "element", it is referring to an Element Information Item, and when it uses the term "attribute", it is referring to an Attribute Information Item.
Infoset用語「要素情報の品目」と「属性情報項目」はそれぞれ「要素」と「属性」に短くされます。 したがって、この仕様が「要素」という用語を使用すると、Element情報Itemについて言及しています、そして、「属性」という用語を使用すると、Attribute情報Itemについて言及しています。
2.1.2. RELAX NG Schema
2.1.2. NG図式を寛げてください。
Some sections of this specification are illustrated with fragments of a non-normative RELAX NG Compact schema [RNC]. However, the text of this specification provides the definition of conformance. Complete schemas appear in Appendix B.
この仕様の数人のセクションが非標準のRELAX NG Compact図式[RNC]の断片で例証されます。 しかしながら、この仕様のテキストは順応の定義を提供します。 完全なschemasはAppendix Bに現れます。
Gregorio & de hOra Standards Track [Page 4] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[4ページ]RFC5023Atom出版プロトコル2007年10月
2.1.3. Use of "xml:base" and "xml:lang"
2.1.3. 「xml: ベース」と「xml: lang」の使用
XML elements defined by this specification MAY have an "xml:base" attribute [REC-xmlbase]. When xml:base is used, it serves the function described in Section 5.1.1 of URI Generic Syntax [RFC3986], by establishing the base URI (or IRI, Internationalized Resource Identifier [RFC3987]) for resolving relative references found within the scope of the "xml:base" attribute.
この仕様で定義されたXML要素は「xml: ベース」属性[REC-xmlbase]を持っているかもしれません。 xml: ベースが使用されている、.1セクション5.1URI Generic Syntax[RFC3986]で説明された機能を果たします、いつで範囲の中で見つけられた相対参照を決議するために、ベースURI(または、IRI、Internationalized Resource Identifier[RFC3987])を確立することによって「xml: ベース」は結果と考えるか。
Any element defined by this specification MAY have an "xml:lang" attribute, whose content indicates the natural language for the element and its descendants. Requirements regarding the content and interpretation of "xml:lang" are specified in Section 2.12 of XML 1.0 [REC-xml].
この仕様で定義されたどんな要素も内容が要素とその子孫のために自然言語を示す「xml: lang」属性を持っているかもしれません。 「xml: lang」の内容と解釈に関する要件はXML1.0[REC-xml]のセクション2.12で指定されます。
3. Terminology
3. 用語
For convenience, this protocol can be referred to as the "Atom Protocol" or "AtomPub". The following terminology is used by this specification:
便利において、「原子プロトコル」か"AtomPub"とこのプロトコルを呼ぶことができます。 以下の用語はこの仕様で使用されます:
o URI - A Uniform Resource Identifier as defined in [RFC3986]. In
this specification, the phrase "the URI of a document" is
shorthand for "a URI which, when dereferenced, is expected to
produce that document as a representation".
o URI--[RFC3986]で定義されるUniform Resource Identifier。 この仕様では、「ドキュメントのURI」という句は「「反-参照をつけ」られると表現としてそのドキュメントを製作すると予想されるURI」のための速記です。
o IRI - An Internationalized Resource Identifier as defined in
[RFC3987]. Before an IRI found in a document is used by HTTP, the
IRI is first converted to a URI. See Section 4.1.
o IRI--[RFC3987]で定義されるInternationalized Resource Identifier。 HTTPによって使用される前に、IRIは最初に、URIに変換されます。 セクション4.1を見てください。
o Resource - A network-accessible data object or service identified
by an IRI, as defined in [RFC2616]. See [REC-webarch] for further
discussion on Resources.
o リソース--ネットワークアクセス可能なデータオブジェクトか[RFC2616]で定義されるようにIRIによって特定されたサービス。 Resourcesのさらなる議論に関して[REC-webarch]を見てください。
o relation (or "relation of") - Refers to the "rel" attribute value
of an atom:link element.
o または、関係、(「関係、」、)、--原子: リンク要素の"rel"属性値について言及します。
o Representation - An entity included with a request or response as
defined in [RFC2616].
o 表現--[RFC2616]で定義される要求か応答で実体を含んでいます。
o Collection - A Resource that contains a set of Member Resources.
Collections are represented as Atom Feeds. See Section 9.
o 収集--メンバーResourcesの1セットを含むResource。 収集はAtom Feedsとして表されます。 セクション9を見てください。
Gregorio & de hOra Standards Track [Page 5] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[5ページ]RFC5023Atom出版プロトコル2007年10月
o Member (or Member Resource) - A Resource whose IRI is listed in a
Collection by an atom:link element with a relation of "edit" or
"edit-media". See Section 9.1. The protocol defines two kinds of
Members:
o メンバー(または、メンバーResource)--IRIがCollectionに原子によって記載されるResource: 「編集」か「編集メディア」の関係に要素をリンクしてください。 セクション9.1を見てください。 プロトコルは2種類のメンバーを定義します:
* Entry Resource - Members of a Collection that are represented
as Atom Entry Documents, as defined in [RFC4287].
* エントリーResource--[RFC4287]で定義されるようなAtom Entry Documentsとして代理をされるCollectionのメンバー。
* Media Resource - Members of a Collection that have
representations other than Atom Entry Documents.
* メディアResource--Atom Entry Documents以外の表現を持っているCollectionのメンバー。
o Media Link Entry - An Entry Resource that contains metadata about
a Media Resource. See Section 9.6.
o メディアLink Entry--メディアResourceに関するメタデータを含むEntry Resource。 セクション9.6を見てください。
o Workspace - A named group of Collections. See Section 8.1.
o ワークスペース--Collectionsの命名されたグループ。 セクション8.1を見てください。
o Service Document - A document that describes the location and
capabilities of one or more Collections, grouped into Workspaces.
See Section 8.
o Documentを調整してください--位置について説明するドキュメントとWorkspacesに分類された1Collectionsの能力。 セクション8を見てください。
o Category Document - A document that describes the categories
allowed in a Collection. See Section 7.
o カテゴリDocument--Collectionに許容されたカテゴリについて説明するドキュメント。 セクション7を見てください。
4. Protocol Model
4. プロトコルモデル
The Atom Protocol specifies operations for publishing and editing Resources using HTTP. It uses Atom-formatted representations to describe the state and metadata of those Resources. It defines how Collections of Resources can be organized, and it specifies formats to support their discovery, grouping and categorization.
AtomプロトコルはHTTPを使用することでResourcesを発行して、編集するための操作を指定します。 それは、それらのResourcesに関する状態とメタデータについて説明するのにAtomによってフォーマットされた表現を使用します。 それはResourcesのCollectionsを組織化できて、彼らの発見、組分け、および分類をサポートするためにどう形式を指定するかを定義します。
4.1. Identity and Naming
4.1. アイデンティティと命名
Atom Protocol documents allow the use of IRIs [RFC3987] as well as URIs [RFC3986] to identify Resources. Before an IRI in a document is used by HTTP, the IRI is first converted to a URI according to the procedure defined in Section 3.1 of [RFC3987]. In accordance with that specification, the conversion SHOULD be applied as late as possible. Conversion does not imply Resource creation -- the IRI and the URI into which it is converted identify the same Resource.
原子プロトコルドキュメントで、URI[RFC3986]と同様にIRIs[RFC3987]の使用はResourcesを特定できます。 ドキュメントのIRIがHTTPによって使用される前に、[RFC3987]のセクション3.1で定義された手順によると、IRIは最初に、URIに変換されます。 仕様、変換SHOULDはできるだけ遅く、適用されます。 変換はResource作成を含意しません--それが変換されるIRIとURIは同じResourceを特定します。
While the Atom Protocol specifies the formats of the representations that are exchanged and the actions that can be performed on the IRIs embedded in those representations, it does not constrain the form of the URIs that are used. HTTP [RFC2616] specifies that the URI space of each server is controlled by that server, and this protocol imposes no further constraints on that control.
Atomプロトコルが交換される表現の形式とそれらの表現に埋め込まれたIRIsに実行できる動作を指定している間、それは使用されたURIのフォームを抑制しません。 HTTP[RFC2616]は、それぞれのサーバのURIスペースがそのサーバによって制御されて、このプロトコルがそのコントロールに更なる規制を全く課さないと指定します。
Gregorio & de hOra Standards Track [Page 6] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[6ページ]RFC5023Atom出版プロトコル2007年10月
4.2. Documents and Resource Classification
4.2. ドキュメントとリソース分類
A Resource whose IRI is listed in a Collection is called a Member Resource. The protocol defines two kinds of Member Resources -- Entry Resources and Media Resources. Entry Resources are represented as Atom Entry Documents [RFC4287]. Media Resources can have representations in any media type. A Media Resource is described within a Collection using an Entry called a Media Link Entry. This diagram shows the classification of Resources within the Atom Protocol:
IRIがCollectionに記載されているResourceはメンバーResourceと呼ばれます。 プロトコルは2種類のメンバーResourcesを定義します--エントリーResourcesとメディアResources。 エントリーResourcesはAtom Entry Documents[RFC4287]として表されます。 メディアResourcesはどんなメディアタイプでも表現を持つことができます。 メディアResourceは、Collectionの中でメディアLink Entryと呼ばれるEntryを使用することで説明されます。 このダイヤグラムはAtomプロトコルの中にResourcesの分類を示しています:
Member Resources
|
-----------------
| |
Entry Resources Media Resources
|
Media Link Entry
メンバーリソース| ----------------- | | エントリーリソースメディアリソース| メディアはエントリーをリンクします。
The Atom Protocol defines Collection Resources for managing and organizing both kinds of Member Resource. A Collection is represented by an Atom Feed Document. A Collection Feed's Entries contain the IRIs of, and metadata about, the Collection's Member Resources. A Collection Feed can contain any number of Entries, which might represent all the Members of the Collection, or an ordered subset of them (see Section 10.1). In the diagram of a Collection below, there are two Entries. The first contains the IRI of an Entry Resource. The second contains the IRIs of both a Media Resource and a Media Link Entry, which contains the metadata for that Media Resource:
Atomプロトコルは、メンバーResourceの両方の種類を管理して、組織化するためにCollection Resourcesを定義します。 CollectionはAtom Feed Documentによって表されます。 Collection FeedのEntriesがIRIsを含んでいる、メタデータ、CollectionのメンバーおよそResources。 Collection FeedはいろいろなEntriesか彼らの規則正しい部分集合を含むことができます(セクション10.1を見てください)。(EntriesはCollectionのすべてのメンバーの代理をするかもしれません)。 以下のCollectionのダイヤグラムには、2Entriesがあります。 1番目はEntry ResourceのIRIを含んでいます。 2番目はメディアResourceとメディアLink Entryの両方のIRIsを含んでいます:(IRIsはそのメディアResourceのためのメタデータを含みます)。
Collection
|
o- Entry
| |
| o- Member Entry IRI (Entry Resource)
|
o- Entry
|
o- Member Entry IRI (Media Link Entry)
|
o- Media IRI (Media Resource)
収集| o- エントリー| | | o- メンバーエントリーIRI(エントリーリソース)| o- エントリー| o- メンバーエントリーIRI(メディアはエントリーをリンクします)| o- メディアIRI(メディアリソース)
The Atom Protocol does not make a distinction between Feeds used for Collections and other Atom Feeds. The only mechanism that this specification supplies for indicating that a Feed is a Collection Feed is the presence of the Feed's IRI in a Service Document.
AtomプロトコルはCollectionsと他のAtom Feedsに使用されるFeedsの間で区別をしません。 FeedがCollection Feedであることを示すのにこの仕様が供給する唯一のメカニズムはService DocumentでのFeedのIRIの存在です。
Gregorio & de hOra Standards Track [Page 7] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[7ページ]RFC5023Atom出版プロトコル2007年10月
Service Documents represent server-defined groups of Collections, and are used to initialize the process of creating and editing Resources. These groups of Collections are called Workspaces. Workspaces have names, but no IRIs, and no specified processing model. The Service Document can indicate which media types, and which categories, a Collection will accept. In the diagram below, there are two Workspaces each describing the IRIs, acceptable media types, and categories for a Collection:
サービスDocumentsは、Collectionsのサーバで定義されたグループを代表して、Resourcesを作成して、編集するプロセスを初期化するのに使用されます。 CollectionsのこれらのグループはWorkspacesと呼ばれます。 ワークスペースには、名前を持っていますが、IRIsがなく、およびどんな指定された処理モデルもありません。 Collectionは、Service Documentがどのメディアタイプ、およびどのカテゴリを示すことができるかと受け入れるでしょう。 以下のダイヤグラムには、CollectionのためにそれぞれIRIs、許容メディアタイプ、およびカテゴリについて説明する2Workspacesがあります:
Service
o- Workspace
| |
| o- Collection
| |
| o- IRI, categories, media types
|
o- Workspace
|
o- Collection
|
o- IRI, categories, media types
oワークスペースを修理してください。| | | o- 収集| | | o- IRI、カテゴリ、メディアタイプ| o- ワークスペース| o- 収集| o- IRI、カテゴリ、メディアタイプ
4.3. Control and Publishing
4.3. コントロールと出版
The Atom Publishing Protocol uses HTTP methods to author Member Resources as follows:
Atom出版プロトコルは以下の作者メンバーResourcesにHTTPメソッドを使用します:
o GET is used to retrieve a representation of a known Resource.
o GETは、知られているResourceの表現を検索するのに使用されます。
o POST is used to create a new, dynamically named, Resource. When
the client submits non-Atom-Entry representations to a Collection
for creation, two Resources are always created -- a Media Entry
for the requested Resource, and a Media Link Entry for metadata
about the Resource that will appear in the Collection.
o ポストは、新しくて、ダイナミックに命名されたResourceを作成するのに使用されます。 クライアントが作成のために非原子のエントリー表現をCollectionに提出すると、2Resourcesがいつも作成されます--要求されたResourceのためのメディアEntry、およびCollectionに現れるResourceに関するメタデータのためのメディアLink Entry。
o PUT is used to edit a known Resource. It is not used for Resource
creation.
o PUTは、知られているResourceを編集するのに使用されます。 それはResource作成に使用されません。
o DELETE is used to remove a known Resource.
o DELETEは、知られているResourceを取り外すのに使用されます。
The Atom Protocol only covers the creating, editing, and deleting of Entry and Media Resources. Other Resources could be created, edited, and deleted as the result of manipulating a Collection, but the number of those Resources, their media types, and effects of Atom Protocol operations on them are outside the scope of this specification.
AtomプロトコルはEntryとメディアResourcesの作成、編集、および削除をカバーするだけです。 この仕様の範囲の外にCollectionを操作するという結果、しかし、それらのResources、彼らのメディアタイプの数、およびAtomプロトコル操作のそれらへの効果があって、他のResourcesを作成して、編集されて、削除できました。
Gregorio & de hOra Standards Track [Page 8] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[8ページ]RFC5023Atom出版プロトコル2007年10月
Since all aspects of client-server interaction are defined in terms of HTTP, [RFC2616] should be consulted for any areas not covered in this specification.
クライアント/サーバ相互作用の全面がHTTPで定義されるので、[RFC2616]はこの仕様でカバーされなかった少しの領域にも相談されるべきです。
4.4. Client Implementation Considerations
4.4. クライアント実装問題
The Atom Protocol imposes few restrictions on the actions of servers. Unless a constraint is specified here, servers can be expected to vary in behavior, in particular around the manipulation of Atom Entries sent by clients. For example, although this specification only defines the expected behavior of Collections with respect to GET and POST, this does not imply that PUT, DELETE, PROPPATCH, and others are forbidden on Collection Resources -- only that this specification does not define what the server's response would be to those methods. Similarly, while some HTTP status codes are mentioned explicitly, clients ought to be prepared to handle any status code from a server. Servers can choose to accept, reject, delay, moderate, censor, reformat, translate, relocate, or re-categorize the content submitted to them. Only some of these choices are immediately relayed back to the client in responses to client requests; other choices may only become apparent later, in the feed or published entries. The same series of requests to two different publishing sites can result in a different series of HTTP responses, different resulting feeds, or different entry contents.
Atomプロトコルはわずかな制限しかサーバの動作に課しません。 規制がここで指定されない場合、サーバが振舞いにおいて異なると予想できます、特にクライアントによって送られたAtom Entriesの操作の周りで。 例えば、この仕様はGETとポストに関してCollectionsの予想された動きを定義するだけですが、これは、PUT、DELETE、PROPPATCH、および他のものはCollection Resourcesで禁じられます--この仕様が、サーバの応答がそれらのメソッドへの何であるかを定義するだけではないのを含意しません。 同様に、いくつかのHTTPステータスコードが明らかに言及されている間、クライアントは. サーバが受け入れるのを選ぶことができるサーバ、廃棄物、遅れ、中道主義者、検閲官、再フォーマットからどんなステータスコードも扱うか、翻訳するか、移動するか、またはそれらに提出された内容を再分類する用意ができているべきです。 これらの選択のいくつかだけがすぐに、クライアント要求への応答でクライアントにリレーして戻されます。 後で他の選択は給送か発行されたエントリーで明らかになるだけであるかもしれません。 2つの異なった出版サイトへの同じシリーズの要求は異なったシリーズのHTTP応答、異なった結果として起こる給送、または異なったエントリーコンテンツをもたらすことができます。
As a result, client software has to be written flexibly to accept what the server decides are the results of its submissions. Any server response or server content modification not explicitly forbidden by this specification or HTTP [RFC2616] is therefore allowed.
その結果、クライアントソフトウェアは、サーバが差出の結果であると決めるものを受け入れるために柔軟に書かれていなければなりません。 したがって、この仕様かHTTP[RFC2616]によって明らかに禁じられなかった少しのサーバ応答やサーバ内容変更も許されています。
5. Protocol Operations
5. プロトコル操作
While specific HTTP status codes are shown in the interaction diagrams below, an AtomPub client should be prepared to handle any status code. For example, a PUT to a Member URI could result in the return of a "204 No Content" status code, which still indicates success.
特定のHTTPステータスコードが以下の相互作用ダイヤグラムで示されている間、AtomPubクライアントはあらゆるステータスコードを扱う用意ができているべきです。 例えば、メンバーURIへのPUTは「204いいえ内容」ステータスコードの復帰をもたらすことができました。(まだ、ステータスコードは成功を示しています)。
Gregorio & de hOra Standards Track [Page 9] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[9ページ]RFC5023Atom出版プロトコル2007年10月
5.1. Retrieving a Service Document
5.1. サービスドキュメントを検索します。
Client Server
| |
| 1.) GET to Service Document URI |
|------------------------------------------>|
| |
| 2.) 200 Ok |
| Service Document |
|<------------------------------------------|
| |
クライアントサーバ| | | 1.) サービスドキュメントURIを始めてください。| |------------------------------------------>| | | | 2.) 200 OK| | サービスドキュメント| |<------------------------------------------| | |
1. The client sends a GET request to the URI of the Service
Document.
1. クライアントはGET要求をService DocumentのURIに送ります。
2. The server responds with a Service Document enumerating the IRIs
of a group of Collections and the capabilities of those
Collections supported by the server. The content of this
document can vary based on aspects of the client request,
including, but not limited to, authentication credentials.
2. Service DocumentがCollectionsのグループのIRIsを数え上げて、それらのCollectionsの能力がサーバによってサポートされている状態で、サーバは反応します。このドキュメントの中身はクライアント要求の局面に基づいて異なることができます、含んでいます、他、認証資格証明書。
5.2. Listing Collection Members
5.2. 収集メンバーを記載します。
To list the Members of a Collection, the client sends a GET request to the URI of a Collection. An Atom Feed Document is returned whose Entries contain the IRIs of Member Resources. The returned Feed may describe all, or only a partial list, of the Members in a Collection (see Section 10).
Collectionのメンバーを記載するために、クライアントはGET要求をCollectionのURIに送ります。 EntriesがメンバーResourcesのIRIsを含むAtom Feed Documentを返します。 返されたFeedはCollectionでメンバーの部分的なリストだけについて説明するかもしれません(セクション10を見てください)。
Client Server
| |
| 1.) GET to Collection URI |
|------------------------------->|
| |
| 2.) 200 Ok |
| Atom Feed Document |
|<-------------------------------|
| |
クライアントサーバ| | | 1.) 収集URIを始めてください。| |------------------------------->| | | | 2.) 200 OK| | 原子給送ドキュメント| |<-------------------------------| | |
1. The client sends a GET request to the URI of the Collection.
1. クライアントはGET要求をCollectionのURIに送ります。
2. The server responds with an Atom Feed Document containing the
IRIs of the Collection Members.
2. Atom Feed DocumentがCollectionメンバーのIRIsを含んでいて、サーバは反応します。
Gregorio & de hOra Standards Track [Page 10] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[10ページ]RFC5023Atom出版プロトコル2007年10月
5.3. Creating a Resource
5.3. リソースを作成します。
Client Server
| |
| 1.) POST to Collection URI |
| Member Representation |
|------------------------------------------>|
| |
| 2.) 201 Created |
| Location: Member Entry URI |
|<------------------------------------------|
| |
クライアントサーバ| | | 1.) 収集URIへのポスト| | メンバー表現| |------------------------------------------>| | | | 2.) 作成された201| | 位置: メンバーエントリーURI| |<------------------------------------------| | |
1. The client POSTs a representation of the Member to the URI of the
Collection.
1. CollectionのURIへのメンバーのクライアントPOSTs a表現。
2. If the Member Resource was created successfully, the server
responds with a status code of 201 and a Location header that
contains the IRI of the newly created Entry Resource. Media
Resources could have also been created and their IRIs can be
found through the Entry Resource. See Section 9.6 for more
details.
2. メンバーResourceが首尾よく作成されたなら、サーバは201のステータスコードと新たに作成されたEntry ResourceのIRIを含むLocationヘッダーと共に反応します。 また、メディアResourcesを作成したかもしれません、そして、Entry Resourceを通して彼らのIRIsを見つけることができます。 その他の詳細に関してセクション9.6を見てください。
5.4. Editing a Resource
5.4. リソースを編集します。
Once a Resource has been created and its Member URI is known, that URI can be used to retrieve, edit, and delete the Resource. Section 11 describes extensions to the Atom Syndication Format used in the Atom Protocol for editing purposes.
いったんResourceが作成されて、メンバーURIが知られていると、Resourceを検索して、編集して、削除するのにそのURIを使用できます。 セクション11は編集目的にAtomプロトコルに使用されるAtom Syndication Formatに拡大について説明します。
5.4.1. Retrieving a Resource
5.4.1. リソースを検索します。
Client Server
| |
| 1.) GET to Member URI |
|------------------------------------------>|
| |
| 2.) 200 Ok |
| Member Representation |
|<------------------------------------------|
| |
クライアントサーバ| | | 1.) メンバーURIを始めてください。| |------------------------------------------>| | | | 2.) 200 OK| | メンバー表現| |<------------------------------------------| | |
1. The client sends a GET request to the URI of a Member Resource to
retrieve its representation.
1. クライアントは、表現を検索するためにメンバーResourceのURIにGET要求を送ります。
2. The server responds with the representation of the Member
Resource.
2. サーバはメンバーの表現でResourceを反応させます。
Gregorio & de hOra Standards Track [Page 11] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[11ページ]RFC5023Atom出版プロトコル2007年10月
5.4.2. Editing a Resource
5.4.2. Editing a Resource
Client Server
| |
| 1.) PUT to Member URI |
| Member Representation |
|------------------------------------------>|
| |
| 2.) 200 OK |
|<------------------------------------------|
Client Server | | | 1.) PUT to Member URI | | Member Representation | |------------------------------------------>| | | | 2.) 200 OK | |<------------------------------------------|
1. The client sends a PUT request to store a representation of a
Member Resource.
1. The client sends a PUT request to store a representation of a Member Resource.
2. If the request is successful, the server responds with a status
code of 200.
2. If the request is successful, the server responds with a status code of 200.
5.4.3. Deleting a Resource
5.4.3. Deleting a Resource
Client Server
| |
| 1.) DELETE to Member URI |
|------------------------------------------>|
| |
| 2.) 200 OK |
|<------------------------------------------|
| |
Client Server | | | 1.) DELETE to Member URI | |------------------------------------------>| | | | 2.) 200 OK | |<------------------------------------------| | |
1. The client sends a DELETE request to the URI of a Member
Resource.
1. The client sends a DELETE request to the URI of a Member Resource.
2. If the deletion is successful, the server responds with a status
code of 200.
2. If the deletion is successful, the server responds with a status code of 200.
A different approach is taken for deleting Media Resources; see Section 9.4 for details.
A different approach is taken for deleting Media Resources; see Section 9.4 for details.
5.5. Use of HTTP Response Codes
5.5. Use of HTTP Response Codes
The Atom Protocol uses the response status codes defined in HTTP to indicate the success or failure of an operation. Consult the HTTP specification [RFC2616] for detailed definitions of each status code.
The Atom Protocol uses the response status codes defined in HTTP to indicate the success or failure of an operation. Consult the HTTP specification [RFC2616] for detailed definitions of each status code.
Implementers are asked to note that according to the HTTP specification, HTTP 4xx and 5xx response entities SHOULD include a human-readable explanation of the error.
Implementers are asked to note that according to the HTTP specification, HTTP 4xx and 5xx response entities SHOULD include a human-readable explanation of the error.
Gregorio & de hOra Standards Track [Page 12] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 12] RFC 5023 The Atom Publishing Protocol October 2007
6. Protocol Documents
6. Protocol Documents
6.1. Document Types
6.1. Document Types
This specification defines two kinds of documents -- Category Documents and Service Documents.
This specification defines two kinds of documents -- Category Documents and Service Documents.
A Category Document (Section 7) contains lists of categories specified using the "atom:category" element from the Atom Syndication Format (see Section 4.2.2 of [RFC4287]).
A Category Document (Section 7) contains lists of categories specified using the "atom:category" element from the Atom Syndication Format (see Section 4.2.2 of [RFC4287]).
A Service Document (Section 8) groups available Collections into Workspaces.
A Service Document (Section 8) groups available Collections into Workspaces.
The namespace name [REC-xml-names] for either kind of document is:
The namespace name [REC-xml-names] for either kind of document is:
http://www.w3.org/2007/app
http://www.w3.org/2007/app
Atom Publishing Protocol XML Documents MUST be "namespace-well- formed" as specified in Section 7 of [REC-xml-names].
Atom Publishing Protocol XML Documents MUST be "namespace-well- formed" as specified in Section 7 of [REC-xml-names].
This specification uses the prefix "app:" for the namespace name. The prefix "atom:" is used for "http://www.w3.org/2005/Atom", the namespace name of the Atom Syndication Format [RFC4287]. These namespace prefixes are not semantically significant.
This specification uses the prefix "app:" for the namespace name. The prefix "atom:" is used for "http://www.w3.org/2005/Atom", the namespace name of the Atom Syndication Format [RFC4287]. These namespace prefixes are not semantically significant.
This specification does not define any DTDs for Atom Protocol formats, and hence does not require them to be "valid" in the sense used by [REC-xml].
This specification does not define any DTDs for Atom Protocol formats, and hence does not require them to be "valid" in the sense used by [REC-xml].
6.2. Document Extensibility
6.2. Document Extensibility
Unrecognized markup in an Atom Publishing Protocol document is considered "foreign markup" as defined in Section 6 of the Atom Syndication Format [RFC4287]. Foreign markup can be used anywhere within a Category or Service Document unless it is explicitly forbidden. Processors that encounter foreign markup MUST NOT stop processing and MUST NOT signal an error. Clients SHOULD preserve foreign markup when transmitting such documents.
Unrecognized markup in an Atom Publishing Protocol document is considered "foreign markup" as defined in Section 6 of the Atom Syndication Format [RFC4287]. Foreign markup can be used anywhere within a Category or Service Document unless it is explicitly forbidden. Processors that encounter foreign markup MUST NOT stop processing and MUST NOT signal an error. Clients SHOULD preserve foreign markup when transmitting such documents.
The namespace name "http://www.w3.org/2007/app" is reserved for forward-compatible revisions of the Category and Service Document types. This does not exclude the addition of elements and attributes that might not be recognized by processors conformant to this specification. Such unrecognized markup from the "http://www.w3.org/2007/app" namespace MUST be treated as foreign markup.
The namespace name "http://www.w3.org/2007/app" is reserved for forward-compatible revisions of the Category and Service Document types. This does not exclude the addition of elements and attributes that might not be recognized by processors conformant to this specification. Such unrecognized markup from the "http://www.w3.org/2007/app" namespace MUST be treated as foreign markup.
Gregorio & de hOra Standards Track [Page 13] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 13] RFC 5023 The Atom Publishing Protocol October 2007
7. Category Documents
7. Category Documents
Category Documents contain lists of categories described using the "atom:category" element from the Atom Syndication Format [RFC4287]. Categories can also appear in Service Documents, where they indicate the categories allowed in a Collection (see Section 8.3.6).
Category Documents contain lists of categories described using the "atom:category" element from the Atom Syndication Format [RFC4287]. Categories can also appear in Service Documents, where they indicate the categories allowed in a Collection (see Section 8.3.6).
Category Documents are identified with the "application/atomcat+xml" media type (see Section 16.1).
Category Documents are identified with the "application/atomcat+xml" media type (see Section 16.1).
7.1. Example
7.1. Example
<?xml version="1.0" ?>
<app:categories
xmlns:app="http://www.w3.org/2007/app"
xmlns:atom="http://www.w3.org/2005/Atom"
fixed="yes" scheme="http://example.com/cats/big3">
<atom:category term="animal" />
<atom:category term="vegetable" />
<atom:category term="mineral" />
</app:categories>
<?xml version="1.0" ?> <app:categories xmlns:app="http://www.w3.org/2007/app" xmlns:atom="http://www.w3.org/2005/Atom" fixed="yes" scheme="http://example.com/cats/big3"> <atom:category term="animal" /> <atom:category term="vegetable" /> <atom:category term="mineral" /> </app:categories>
This Category Document contains atom:category elements, with the terms 'animal', 'vegetable', and 'mineral'. None of the categories use the "label" attribute defined in [RFC4287]. They all inherit the "http://example.com/cats/big3" "scheme" attribute declared on the app:categories element. Therefore if the 'mineral' category were to appear in an Atom Entry or Feed Document, it would appear as:
This Category Document contains atom:category elements, with the terms 'animal', 'vegetable', and 'mineral'. None of the categories use the "label" attribute defined in [RFC4287]. They all inherit the "http://example.com/cats/big3" "scheme" attribute declared on the app:categories element. Therefore if the 'mineral' category were to appear in an Atom Entry or Feed Document, it would appear as:
<atom:category scheme="http://example.com/cats/big3" term="mineral"/>
<atom:category scheme="http://example.com/cats/big3" term="mineral"/>
7.2. Element Definitions
7.2. Element Definitions
7.2.1. The "app:categories" Element
7.2.1. The "app:categories" Element
The root of a Category Document is the "app:categories" element. An
app:categories element can contain zero or more atom:category
elements from the Atom Syndication Format [RFC4287] namespace
("http://www.w3.org/2005/Atom").
The root of a Category Document is the "app:categories" element. An app:categories element can contain zero or more atom:category elements from the Atom Syndication Format [RFC4287] namespace ("http://www.w3.org/2005/Atom").
An atom:category child element that has no "scheme" attribute inherits the attribute from its app:categories parent. An atom: category child element with an existing "scheme" attribute does not inherit the "scheme" value of its app:categories parent element.
An atom:category child element that has no "scheme" attribute inherits the attribute from its app:categories parent. An atom: category child element with an existing "scheme" attribute does not inherit the "scheme" value of its app:categories parent element.
Gregorio & de hOra Standards Track [Page 14] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 14] RFC 5023 The Atom Publishing Protocol October 2007
atomCategory =
element atom:category {
atomCommonAttributes,
attribute term { text },
attribute scheme { atomURI }?,
attribute label { text }?,
undefinedContent
}
atomCategory = element atom:category { atomCommonAttributes, attribute term { text }, attribute scheme { atomURI }?, attribute label { text }?, undefinedContent }
appInlineCategories =
element app:categories {
attribute fixed { "yes" | "no" }?,
attribute scheme { atomURI }?,
(atomCategory*,
undefinedContent)
}
appInlineCategories = element app:categories { attribute fixed { "yes" | "no" }?, attribute scheme { atomURI }?, (atomCategory*, undefinedContent) }
appOutOfLineCategories =
element app:categories {
attribute href { atomURI },
undefinedContent
}
appOutOfLineCategories = element app:categories { attribute href { atomURI }, undefinedContent }
appCategories = appInlineCategories | appOutOfLineCategories
appCategories = appInlineCategories | appOutOfLineCategories
7.2.1.1. Attributes of "app:categories"
7.2.1.1. Attributes of "app:categories"
The app:categories element can contain a "fixed" attribute, with a value of either "yes" or "no", indicating whether the list of categories is a fixed or an open set. The absence of the "fixed" attribute is equivalent to the presence of a "fixed" attribute with a value of "no".
The app:categories element can contain a "fixed" attribute, with a value of either "yes" or "no", indicating whether the list of categories is a fixed or an open set. The absence of the "fixed" attribute is equivalent to the presence of a "fixed" attribute with a value of "no".
Alternatively, the app:categories element MAY contain an "href" attribute, whose value MUST be an IRI reference identifying a Category Document. If the "href" attribute is provided, the app: categories element MUST be empty and MUST NOT have the "fixed" or "scheme" attributes.
Alternatively, the app:categories element MAY contain an "href" attribute, whose value MUST be an IRI reference identifying a Category Document. If the "href" attribute is provided, the app: categories element MUST be empty and MUST NOT have the "fixed" or "scheme" attributes.
8. Service Documents
8. Service Documents
For authoring to commence, a client needs to discover the capabilities and locations of the available Collections. Service Documents are designed to support this discovery process.
For authoring to commence, a client needs to discover the capabilities and locations of the available Collections. Service Documents are designed to support this discovery process.
How Service Documents are discovered is not defined in this specification.
How Service Documents are discovered is not defined in this specification.
Gregorio & de hOra Standards Track [Page 15] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 15] RFC 5023 The Atom Publishing Protocol October 2007
Service Documents are identified with the "application/atomsvc+xml" media type (see Section 16.2).
Service Documents are identified with the "application/atomsvc+xml" media type (see Section 16.2).
8.1. Workspaces
8.1. Workspaces
A Service Document groups Collections into Workspaces. Operations on Workspaces, such as creation or deletion, are not defined by this specification. This specification assigns no meaning to Workspaces; that is, a Workspace does not imply any specific processing assumptions.
A Service Document groups Collections into Workspaces. Operations on Workspaces, such as creation or deletion, are not defined by this specification. This specification assigns no meaning to Workspaces; that is, a Workspace does not imply any specific processing assumptions.
There is no requirement that a server support multiple Workspaces. In addition, a Collection MAY appear in more than one Workspace.
There is no requirement that a server support multiple Workspaces. In addition, a Collection MAY appear in more than one Workspace.
8.2. Example
8.2. Example
<?xml version="1.0" encoding='utf-8'?>
<service xmlns="http://www.w3.org/2007/app"
xmlns:atom="http://www.w3.org/2005/Atom">
<workspace>
<atom:title>Main Site</atom:title>
<collection
href="http://example.org/blog/main" >
<atom:title>My Blog Entries</atom:title>
<categories
href="http://example.com/cats/forMain.cats" />
</collection>
<collection
href="http://example.org/blog/pic" >
<atom:title>Pictures</atom:title>
<accept>image/png</accept>
<accept>image/jpeg</accept>
<accept>image/gif</accept>
</collection>
</workspace>
<workspace>
<atom:title>Sidebar Blog</atom:title>
<collection
href="http://example.org/sidebar/list" >
<atom:title>Remaindered Links</atom:title>
<accept>application/atom+xml;type=entry</accept>
<categories fixed="yes">
<atom:category
scheme="http://example.org/extra-cats/"
term="joke" />
<atom:category
scheme="http://example.org/extra-cats/"
term="serious" />
<?xml version="1.0" encoding='utf-8'?> <service xmlns="http://www.w3.org/2007/app" xmlns:atom="http://www.w3.org/2005/Atom"> <workspace> <atom:title>Main Site</atom:title> <collection href="http://example.org/blog/main" > <atom:title>My Blog Entries</atom:title> <categories href="http://example.com/cats/forMain.cats" /> </collection> <collection href="http://example.org/blog/pic" > <atom:title>Pictures</atom:title> <accept>image/png</accept> <accept>image/jpeg</accept> <accept>image/gif</accept> </collection> </workspace> <workspace> <atom:title>Sidebar Blog</atom:title> <collection href="http://example.org/sidebar/list" > <atom:title>Remaindered Links</atom:title> <accept>application/atom+xml;type=entry</accept> <categories fixed="yes"> <atom:category scheme="http://example.org/extra-cats/" term="joke" /> <atom:category scheme="http://example.org/extra-cats/" term="serious" />
Gregorio & de hOra Standards Track [Page 16] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 16] RFC 5023 The Atom Publishing Protocol October 2007
</categories>
</collection>
</workspace>
</service>
</categories> </collection> </workspace> </service>
The Service Document above describes two Workspaces. The first Workspace is called "Main Site", and has two Collections called "My Blog Entries" and "Pictures", whose IRIs are "http://example.org/blog/main" and "http://example.org/blog/pic" respectively. The "Pictures" Collection includes three "accept" elements indicating the types of image files the client can send to the Collection to create new Media Resources (entries associated with Media Resources are discussed in Section 9.6).
The Service Document above describes two Workspaces. The first Workspace is called "Main Site", and has two Collections called "My Blog Entries" and "Pictures", whose IRIs are "http://example.org/blog/main" and "http://example.org/blog/pic" respectively. The "Pictures" Collection includes three "accept" elements indicating the types of image files the client can send to the Collection to create new Media Resources (entries associated with Media Resources are discussed in Section 9.6).
The second Workspace is called "Sidebar Blog" and has a single Collection called "Remaindered Links" whose IRI is "http://example.org/sidebar/list". The Collection has an "accept" element whose content is "application/atom+xml;type=entry", indicating it will accept Atom Entries from a client.
The second Workspace is called "Sidebar Blog" and has a single Collection called "Remaindered Links" whose IRI is "http://example.org/sidebar/list". The Collection has an "accept" element whose content is "application/atom+xml;type=entry", indicating it will accept Atom Entries from a client.
Within each of the two Entry Collections, the "categories" element provides a list of available categories for Member Entries. In the "My Blog Entries" Collection, the list of available categories is available through the "href" attribute. The "Sidebar Blog" Collection provides a category list within the Service Document, but states the list is fixed, signaling a request from the server that Entries be POSTed using only those two categories.
Within each of the two Entry Collections, the "categories" element provides a list of available categories for Member Entries. In the "My Blog Entries" Collection, the list of available categories is available through the "href" attribute. The "Sidebar Blog" Collection provides a category list within the Service Document, but states the list is fixed, signaling a request from the server that Entries be POSTed using only those two categories.
8.3. Element Definitions
8.3. Element Definitions
8.3.1. The "app:service" Element
8.3.1. The "app:service" Element
The root of a Service Document is the "app:service" element.
The root of a Service Document is the "app:service" element.
The app:service element is the container for service information associated with one or more Workspaces. An app:service element MUST contain one or more app:workspace elements.
The app:service element is the container for service information associated with one or more Workspaces. An app:service element MUST contain one or more app:workspace elements.
namespace app = "http://www.w3.org/2007/app" start = appService
namespace app = "http://www.w3.org/2007/app" start = appService
appService =
element app:service {
appCommonAttributes,
( appWorkspace+
& extensionElement* )
}
appService = element app:service { appCommonAttributes, ( appWorkspace+ & extensionElement* ) }
Gregorio & de hOra Standards Track [Page 17] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 17] RFC 5023 The Atom Publishing Protocol October 2007
8.3.2. The "app:workspace" Element
8.3.2. The "app:workspace" Element
Workspaces are server-defined groups of Collections. The "app: workspace" element contains zero or more app:collection elements describing the Collections of Resources available for editing.
Workspaces are server-defined groups of Collections. The "app: workspace" element contains zero or more app:collection elements describing the Collections of Resources available for editing.
appWorkspace =
element app:workspace {
appCommonAttributes,
( atomTitle
& appCollection*
& extensionSansTitleElement* )
}
appWorkspace = element app:workspace { appCommonAttributes, ( atomTitle & appCollection* & extensionSansTitleElement* ) }
atomTitle = element atom:title { atomTextConstruct }
atomTitle = element atom:title { atomTextConstruct }
8.3.2.1. The "atom:title" Element
8.3.2.1. The "atom:title" Element
The app:workspace element MUST contain one "atom:title" element (as defined in [RFC4287]), giving a human-readable title for the Workspace.
The app:workspace element MUST contain one "atom:title" element (as defined in [RFC4287]), giving a human-readable title for the Workspace.
8.3.3. The "app:collection" Element
8.3.3. The "app:collection" Element
The "app:collection" element describes a Collection. The app: collection element MUST contain one atom:title element.
The "app:collection" element describes a Collection. The app: collection element MUST contain one atom:title element.
The app:collection element MAY contain any number of app:accept elements, indicating the types of representations accepted by the Collection. The order of such elements is not significant.
The app:collection element MAY contain any number of app:accept elements, indicating the types of representations accepted by the Collection. The order of such elements is not significant.
The app:collection element MAY contain any number of app:categories elements.
The app:collection element MAY contain any number of app:categories elements.
appCollection =
element app:collection {
appCommonAttributes,
attribute href { atomURI },
( atomTitle
& appAccept*
& appCategories*
& extensionSansTitleElement* )
}
appCollection = element app:collection { appCommonAttributes, attribute href { atomURI }, ( atomTitle & appAccept* & appCategories* & extensionSansTitleElement* ) }
8.3.3.1. The "href" Attribute
8.3.3.1. The "href" Attribute
The app:collection element MUST contain an "href" attribute, whose value gives the IRI of the Collection.
The app:collection element MUST contain an "href" attribute, whose value gives the IRI of the Collection.
Gregorio & de hOra Standards Track [Page 18] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 18] RFC 5023 The Atom Publishing Protocol October 2007
8.3.3.2. The "atom:title" Element
8.3.3.2. The "atom:title" Element
The "atom:title" element is defined in [RFC4287] and gives a human- readable title for the Collection.
The "atom:title" element is defined in [RFC4287] and gives a human- readable title for the Collection.
8.3.4. The "app:accept" Element
8.3.4. The "app:accept" Element
The content of an "app:accept" element value is a media range as defined in [RFC2616]. The media range specifies a type of representation that can be POSTed to a Collection.
The content of an "app:accept" element value is a media range as defined in [RFC2616]. The media range specifies a type of representation that can be POSTed to a Collection.
The app:accept element is similar to the HTTP Accept request-header [RFC2616]. Media type parameters are allowed within app:accept, but app:accept has no notion of preference -- "accept-params" or "q" arguments, as specified in Section 14.1 of [RFC2616] are not significant.
The app:accept element is similar to the HTTP Accept request-header [RFC2616]. Media type parameters are allowed within app:accept, but app:accept has no notion of preference -- "accept-params" or "q" arguments, as specified in Section 14.1 of [RFC2616] are not significant.
White space (as defined in [REC-xml]) around the app:accept element's media range is insignificant and MUST be ignored.
White space (as defined in [REC-xml]) around the app:accept element's media range is insignificant and MUST be ignored.
A value of "application/atom+xml;type=entry" MAY appear in any app: accept list of media ranges and indicates that Atom Entry Documents can be POSTed to the Collection. If no app:accept element is present, clients SHOULD treat this as equivalent to an app:accept element with the content "application/atom+xml;type=entry".
A value of "application/atom+xml;type=entry" MAY appear in any app: accept list of media ranges and indicates that Atom Entry Documents can be POSTed to the Collection. If no app:accept element is present, clients SHOULD treat this as equivalent to an app:accept element with the content "application/atom+xml;type=entry".
If one app:accept element exists and is empty, clients SHOULD assume that the Collection does not support the creation of new Entries.
If one app:accept element exists and is empty, clients SHOULD assume that the Collection does not support the creation of new Entries.
appAccept =
element app:accept {
appCommonAttributes,
( text? )
}
appAccept = element app:accept { appCommonAttributes, ( text? ) }
8.3.5. Usage in Atom Feed Documents
8.3.5. Usage in Atom Feed Documents
The app:collection element MAY appear as a child of an atom:feed or atom:source element in an Atom Feed Document. Its content identifies a Collection by which new Entries can be added to appear in the feed. When it appears in an atom:feed or atom:source element, the app: collection element is considered foreign markup as defined in Section 6 of [RFC4287].
The app:collection element MAY appear as a child of an atom:feed or atom:source element in an Atom Feed Document. Its content identifies a Collection by which new Entries can be added to appear in the feed. When it appears in an atom:feed or atom:source element, the app: collection element is considered foreign markup as defined in Section 6 of [RFC4287].
Gregorio & de hOra Standards Track [Page 19] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 19] RFC 5023 The Atom Publishing Protocol October 2007
8.3.6. The "app:categories" Element
8.3.6. The "app:categories" Element
The "app:categories" element provides a list of the categories that can be applied to the members of a Collection. See Section 7.2.1 for the detailed definition of app:categories.
The "app:categories" element provides a list of the categories that can be applied to the members of a Collection. See Section 7.2.1 for the detailed definition of app:categories.
The server MAY reject attempts to create or store members whose categories are not present in its categories list. A Collection that indicates the category set is open SHOULD NOT reject otherwise acceptable members whose categories are not in its categories list. The absence of an app:categories element means that the category handling of the Collection is unspecified. A "fixed" category list that contains zero categories indicates the Collection does not accept category data.
The server MAY reject attempts to create or store members whose categories are not present in its categories list. A Collection that indicates the category set is open SHOULD NOT reject otherwise acceptable members whose categories are not in its categories list. The absence of an app:categories element means that the category handling of the Collection is unspecified. A "fixed" category list that contains zero categories indicates the Collection does not accept category data.
9. Creating and Editing Resources
9. Creating and Editing Resources
9.1. Member URIs
9.1. Member URIs
The Member URI allows clients to retrieve, edit, and delete a Member Resource using HTTP's GET, PUT, and DELETE methods. Entry Resources are represented as Atom Entry documents.
The Member URI allows clients to retrieve, edit, and delete a Member Resource using HTTP's GET, PUT, and DELETE methods. Entry Resources are represented as Atom Entry documents.
Member URIs appear in two places. They are returned in a Location header after successful Resource creation using POST, as described in Section 9.2 below. They can also appear in a Collection Feed's Entries, as atom:link elements with a link relation of "edit".
Member URIs appear in two places. They are returned in a Location header after successful Resource creation using POST, as described in Section 9.2 below. They can also appear in a Collection Feed's Entries, as atom:link elements with a link relation of "edit".
A Member Entry SHOULD contain such an atom:link element with a link relation of "edit", which indicates the Member URI.
A Member Entry SHOULD contain such an atom:link element with a link relation of "edit", which indicates the Member URI.
9.2. Creating Resources with POST
9.2. Creating Resources with POST
To add members to a Collection, clients send POST requests to the URI of the Collection.
To add members to a Collection, clients send POST requests to the URI of the Collection.
Successful member creation is indicated with a 201 ("Created")
response code. When the Collection responds with a status code of
201, it SHOULD also return a response body, which MUST be an Atom
Entry Document representing the newly created Resource. Since the
server is free to alter the POSTed Entry, for example, by changing
the content of the atom:id element, returning the Entry can be useful
to the client, enabling it to correlate the client and server views
of the new Entry.
Successful member creation is indicated with a 201 ("Created") response code. When the Collection responds with a status code of 201, it SHOULD also return a response body, which MUST be an Atom Entry Document representing the newly created Resource. Since the server is free to alter the POSTed Entry, for example, by changing the content of the atom:id element, returning the Entry can be useful to the client, enabling it to correlate the client and server views of the new Entry.
When a Member Resource is created, its Member Entry URI MUST be returned in a Location header in the Collection's response.
When a Member Resource is created, its Member Entry URI MUST be returned in a Location header in the Collection's response.
Gregorio & de hOra Standards Track [Page 20] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 20] RFC 5023 The Atom Publishing Protocol October 2007
If the creation request contained an Atom Entry Document, and the subsequent response from the server contains a Content-Location header that matches the Location header character-for-character, then the client is authorized to interpret the response entity as being a complete representation of the newly created Entry. Without a matching Content-Location header, the client MUST NOT assume the returned entity is a complete representation of the created Resource.
If the creation request contained an Atom Entry Document, and the subsequent response from the server contains a Content-Location header that matches the Location header character-for-character, then the client is authorized to interpret the response entity as being a complete representation of the newly created Entry. Without a matching Content-Location header, the client MUST NOT assume the returned entity is a complete representation of the created Resource.
The request body sent with the POST need not be an Atom Entry. For
example, it might be a picture or a movie. Collections MAY return a
response with a status code of 415 ("Unsupported Media Type") to
indicate that the media type of the POSTed entity is not allowed or
supported by the Collection. For a discussion of the issues in
creating such content, see Section 9.6.
The request body sent with the POST need not be an Atom Entry. For example, it might be a picture or a movie. Collections MAY return a response with a status code of 415 ("Unsupported Media Type") to indicate that the media type of the POSTed entity is not allowed or supported by the Collection. For a discussion of the issues in creating such content, see Section 9.6.
9.2.1. Example
9.2.1. Example
Below, the client sends a POST request containing an Atom Entry representation using the URI of the Collection:
Below, the client sends a POST request containing an Atom Entry representation using the URI of the Collection:
POST /edit/ HTTP/1.1
Host: example.org
User-Agent: Thingio/1.0
Authorization: Basic ZGFmZnk6c2VjZXJldA==
Content-Type: application/atom+xml;type=entry
Content-Length: nnn
Slug: First Post
POST /edit/ HTTP/1.1 Host: example.org User-Agent: Thingio/1.0 Authorization: Basic ZGFmZnk6c2VjZXJldA== Content-Type: application/atom+xml;type=entry Content-Length: nnn Slug: First Post
<?xml version="1.0"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<title>Atom-Powered Robots Run Amok</title>
<id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
<updated>2003-12-13T18:30:02Z</updated>
<author><name>John Doe</name></author>
<content>Some text.</content>
</entry>
<?xml version="1.0"?> <entry xmlns="http://www.w3.org/2005/Atom"> <title>Atom-Powered Robots Run Amok</title> <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id> <updated>2003-12-13T18:30:02Z</updated> <author><name>John Doe</name></author> <content>Some text.</content> </entry>
The server signals a successful creation with a status code of 201. The response includes a Location header indicating the Member Entry URI of the Atom Entry, and a representation of that Entry in the body of the response.
The server signals a successful creation with a status code of 201. The response includes a Location header indicating the Member Entry URI of the Atom Entry, and a representation of that Entry in the body of the response.
HTTP/1.1 201 Created
Date: Fri, 7 Oct 2005 17:17:11 GMT
Content-Length: nnn
Content-Type: application/atom+xml;type=entry;charset="utf-8"
Location: http://example.org/edit/first-post.atom
ETag: "c180de84f991g8"
HTTP/1.1 201 Created Date: Fri, 7 Oct 2005 17:17:11 GMT Content-Length: nnn Content-Type: application/atom+xml;type=entry;charset="utf-8" Location: http://example.org/edit/first-post.atom ETag: "c180de84f991g8"
Gregorio & de hOra Standards Track [Page 21] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 21] RFC 5023 The Atom Publishing Protocol October 2007
<?xml version="1.0"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<title>Atom-Powered Robots Run Amok</title>
<id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
<updated>2003-12-13T18:30:02Z</updated>
<author><name>John Doe</name></author>
<content>Some text.</content>
<link rel="edit"
href="http://example.org/edit/first-post.atom"/>
</entry>
<?xml version="1.0"?> <entry xmlns="http://www.w3.org/2005/Atom"> <title>Atom-Powered Robots Run Amok</title> <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id> <updated>2003-12-13T18:30:02Z</updated> <author><name>John Doe</name></author> <content>Some text.</content> <link rel="edit" href="http://example.org/edit/first-post.atom"/> </entry>
The Entry created and returned by the Collection might not match the Entry POSTed by the client. A server MAY change the values of various elements in the Entry, such as the atom:id, atom:updated, and atom:author values, and MAY choose to remove or add other elements and attributes, or change element content and attribute values.
The Entry created and returned by the Collection might not match the Entry POSTed by the client. A server MAY change the values of various elements in the Entry, such as the atom:id, atom:updated, and atom:author values, and MAY choose to remove or add other elements and attributes, or change element content and attribute values.
9.3. Editing Resources with PUT
9.3. Editing Resources with PUT
To edit a Member Resource, a client sends a PUT request to its Member URI, as specified in [RFC2616].
To edit a Member Resource, a client sends a PUT request to its Member URI, as specified in [RFC2616].
To avoid unintentional loss of data when editing Member Entries or Media Link Entries, an Atom Protocol client SHOULD preserve all metadata that has not been intentionally modified, including unknown foreign markup as defined in Section 6 of [RFC4287].
To avoid unintentional loss of data when editing Member Entries or Media Link Entries, an Atom Protocol client SHOULD preserve all metadata that has not been intentionally modified, including unknown foreign markup as defined in Section 6 of [RFC4287].
9.4. Deleting Resources with DELETE
9.4. Deleting Resources with DELETE
To delete a Member Resource, a client sends a DELETE request to its Member URI, as specified in [RFC2616]. The deletion of a Media Link Entry SHOULD result in the deletion of the corresponding Media Resource.
To delete a Member Resource, a client sends a DELETE request to its Member URI, as specified in [RFC2616]. The deletion of a Media Link Entry SHOULD result in the deletion of the corresponding Media Resource.
9.5. Caching and Entity Tags
9.5. Caching and Entity Tags
Implementers are advised to pay attention to cache controls and to make use of the mechanisms available in HTTP when editing Resources, in particular, entity-tags as outlined in [NOTE-detect-lost-update]. Clients are not assured to receive the most recent representations of Collection Members using GET if the server is authorizing intermediaries to cache them.
Implementers are advised to pay attention to cache controls and to make use of the mechanisms available in HTTP when editing Resources, in particular, entity-tags as outlined in [NOTE-detect-lost-update]. Clients are not assured to receive the most recent representations of Collection Members using GET if the server is authorizing intermediaries to cache them.
Gregorio & de hOra Standards Track [Page 22] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 22] RFC 5023 The Atom Publishing Protocol October 2007
9.5.1. Example
9.5.1. Example
Below, the client creates a Member Entry using POST:
Below, the client creates a Member Entry using POST:
POST /myblog/entries HTTP/1.1
Host: example.org
Authorization: Basic ZGFmZnk6c2VjZXJldA==
Content-Type: application/atom+xml;type=entry
Content-Length: nnn
Slug: First Post
POST /myblog/entries HTTP/1.1 Host: example.org Authorization: Basic ZGFmZnk6c2VjZXJldA== Content-Type: application/atom+xml;type=entry Content-Length: nnn Slug: First Post
<?xml version="1.0" ?>
<entry xmlns="http://www.w3.org/2005/Atom">
<title>Atom-Powered Robots Run Amok</title>
<id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
<updated>2007-02-123T17:09:02Z</updated>
<author><name>Captain Lansing</name></author>
<content>It's something moving... solid metal</content>
</entry>
<?xml version="1.0" ?> <entry xmlns="http://www.w3.org/2005/Atom"> <title>Atom-Powered Robots Run Amok</title> <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id> <updated>2007-02-123T17:09:02Z</updated> <author><name>Captain Lansing</name></author> <content>It's something moving... solid metal</content> </entry>
The server signals a successful creation with a status code of 201, and returns an ETag header in the response. Because, in this case, the server returned a Content-Location header and Location header with the same value, the returned Entry representation can be understood to be a complete representation of the newly created Entry (see Section 9.2).
The server signals a successful creation with a status code of 201, and returns an ETag header in the response. Because, in this case, the server returned a Content-Location header and Location header with the same value, the returned Entry representation can be understood to be a complete representation of the newly created Entry (see Section 9.2).
HTTP/1.1 201 Created
Date: Fri, 23 Feb 2007 21:17:11 GMT
Content-Length: nnn
Content-Type: application/atom+xml;type=entry
Location: http://example.org/edit/first-post.atom
Content-Location: http://example.org/edit/first-post.atom
ETag: "e180ee84f0671b1"
HTTP/1.1 201 Created Date: Fri, 23 Feb 2007 21:17:11 GMT Content-Length: nnn Content-Type: application/atom+xml;type=entry Location: http://example.org/edit/first-post.atom Content-Location: http://example.org/edit/first-post.atom ETag: "e180ee84f0671b1"
<?xml version="1.0" ?>
<entry xmlns="http://www.w3.org/2005/Atom">
<title>Atom-Powered Robots Run Amok</title>
<id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
<updated>2007-02-123T17:09:02Z</updated>
<author><name>Captain Lansing</name></author>
<content>It's something moving... solid metal</content>
</entry>
<?xml version="1.0" ?> <entry xmlns="http://www.w3.org/2005/Atom"> <title>Atom-Powered Robots Run Amok</title> <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id> <updated>2007-02-123T17:09:02Z</updated> <author><name>Captain Lansing</name></author> <content>It's something moving... solid metal</content> </entry>
The client can, if it wishes, use the returned ETag value to later construct a "Conditional GET" as defined in [RFC2616]. In this case, prior to editing, the client sends the ETag value for the Member using the If-None-Match header.
The client can, if it wishes, use the returned ETag value to later construct a "Conditional GET" as defined in [RFC2616]. In this case, prior to editing, the client sends the ETag value for the Member using the If-None-Match header.
Gregorio & de hOra Standards Track [Page 23] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 23] RFC 5023 The Atom Publishing Protocol October 2007
GET /edit/first-post.atom HTTP/1.1
Host: example.org
Authorization: Basic ZGFmZnk6c2VjZXJldA==
If-None-Match: "e180ee84f0671b1"
GET /edit/first-post.atom HTTP/1.1 Host: example.org Authorization: Basic ZGFmZnk6c2VjZXJldA== If-None-Match: "e180ee84f0671b1"
If the Entry has not been modified, the response will be a status
code of 304 ("Not Modified"). This allows the client to determine
whether it still has the most recent representation of the Entry at
the time of editing.
If the Entry has not been modified, the response will be a status code of 304 ("Not Modified"). This allows the client to determine whether it still has the most recent representation of the Entry at the time of editing.
HTTP/1.1 304 Not Modified
Date: Sat, 24 Feb 2007 13:17:11 GMT
HTTP/1.1 304 Not Modified Date: Sat, 24 Feb 2007 13:17:11 GMT
After editing, the client can PUT the Entry and send the ETag entity value in an If-Match header, informing the server to accept the entry on the condition that the entity value sent still matches the server's.
After editing, the client can PUT the Entry and send the ETag entity value in an If-Match header, informing the server to accept the entry on the condition that the entity value sent still matches the server's.
PUT /edit/first-post.atom HTTP/1.1
Host: example.org
Authorization: Basic ZGFmZnk6c2VjZXJldA==
Content-Type: application/atom+xml;type=entry
Content-Length: nnn
If-Match: "e180ee84f0671b1"
PUT /edit/first-post.atom HTTP/1.1 Host: example.org Authorization: Basic ZGFmZnk6c2VjZXJldA== Content-Type: application/atom+xml;type=entry Content-Length: nnn If-Match: "e180ee84f0671b1"
<?xml version="1.0" ?>
<entry xmlns="http://www.w3.org/2005/Atom">
<title>Atom-Powered Robots Run Amok</title>
<id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
<updated>2007-02-24T16:34:06Z</updated>
<author><name>Captain Lansing</name></author>
<content>Update: it's a hoax!</content>
</entry>
<?xml version="1.0" ?> <entry xmlns="http://www.w3.org/2005/Atom"> <title>Atom-Powered Robots Run Amok</title> <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id> <updated>2007-02-24T16:34:06Z</updated> <author><name>Captain Lansing</name></author> <content>Update: it's a hoax!</content> </entry>
The server however has since received a more recent copy than the
client's, and it responds with a status code of 412 ("Precondition
Failed").
The server however has since received a more recent copy than the client's, and it responds with a status code of 412 ("Precondition Failed").
HTTP/1.1 412 Precondition Failed
Date: Sat, 24 Feb 2007 16:34:11 GMT
HTTP/1.1 412 Precondition Failed Date: Sat, 24 Feb 2007 16:34:11 GMT
This informs the client that the server has a more recent version of the Entry and will not allow the sent entity to be stored.
This informs the client that the server has a more recent version of the Entry and will not allow the sent entity to be stored.
Gregorio & de hOra Standards Track [Page 24] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 24] RFC 5023 The Atom Publishing Protocol October 2007
9.6. Media Resources and Media Link Entries
9.6. Media Resources and Media Link Entries
A client can POST Media Resources as well as Entry Resources to a Collection. If a server accepts such a request, then it MUST create two new Resources -- one that corresponds to the entity sent in the request, called the Media Resource, and an associated Member Entry, called the Media Link Entry. Media Link Entries are represented as Atom Entries, and appear in the Collection.
A client can POST Media Resources as well as Entry Resources to a Collection. If a server accepts such a request, then it MUST create two new Resources -- one that corresponds to the entity sent in the request, called the Media Resource, and an associated Member Entry, called the Media Link Entry. Media Link Entries are represented as Atom Entries, and appear in the Collection.
The Media Link Entry contains the metadata and IRI of the (perhaps non-textual) Media Resource. The Media Link Entry thus makes the metadata about the Media Resource separately available for retrieval and alteration.
The Media Link Entry contains the metadata and IRI of the (perhaps non-textual) Media Resource. The Media Link Entry thus makes the metadata about the Media Resource separately available for retrieval and alteration.
The server can signal the media types it will accept using the app: accept element in the Service Document, as specified in Section 8.3.4.
The server can signal the media types it will accept using the app: accept element in the Service Document, as specified in Section 8.3.4.
Successful responses to creation requests MUST include the URI of the Media Link Entry in the Location header. The Media Link Entry SHOULD contain an atom:link element with a link relation of "edit-media" that contains the Media Resource IRI. The Media Link Entry MUST have an atom:content element with a "src" attribute. The value of the "src" attribute is an IRI for the newly created Media Resource. It is OPTIONAL that the IRI of the "src" attribute on the atom:content element be the same as the Media Resource IRI. For example, the "src" attribute value might instead be a link into a static cache or content distribution network and not the Media Resource IRI.
Successful responses to creation requests MUST include the URI of the Media Link Entry in the Location header. The Media Link Entry SHOULD contain an atom:link element with a link relation of "edit-media" that contains the Media Resource IRI. The Media Link Entry MUST have an atom:content element with a "src" attribute. The value of the "src" attribute is an IRI for the newly created Media Resource. It is OPTIONAL that the IRI of the "src" attribute on the atom:content element be the same as the Media Resource IRI. For example, the "src" attribute value might instead be a link into a static cache or content distribution network and not the Media Resource IRI.
Implementers are asked to note that [RFC4287] specifies that Atom Entries MUST contain an atom:summary element. Thus, upon successful creation of a Media Link Entry, a server MAY choose to populate the atom:summary element (as well as any other mandatory elements such as atom:id, atom:author, and atom:title) with content derived from the POSTed entity or from any other source. A server might not allow a client to modify the server-selected values for these elements.
Implementers are asked to note that [RFC4287] specifies that Atom Entries MUST contain an atom:summary element. Thus, upon successful creation of a Media Link Entry, a server MAY choose to populate the atom:summary element (as well as any other mandatory elements such as atom:id, atom:author, and atom:title) with content derived from the POSTed entity or from any other source. A server might not allow a client to modify the server-selected values for these elements.
For Resource creation, this specification only defines cases where
the POST body has an Atom Entry entity declared as an Atom media type
("application/atom+xml"), or a non-Atom entity declared as a non-Atom
media type. When a client is POSTing an Atom Entry to a Collection,
it may use a media type of either "application/atom+xml" or
"application/atom +xml;type=entry". This specification does not
specify any request semantics or server behavior in the case where
the POSTed media type is "application/atom+xml" but the body is
something other than an Atom Entry. In particular, what happens on
POSTing an Atom Feed Document to a Collection using the "application/
atom+xml" media type is undefined.
For Resource creation, this specification only defines cases where the POST body has an Atom Entry entity declared as an Atom media type ("application/atom+xml"), or a non-Atom entity declared as a non-Atom media type. When a client is POSTing an Atom Entry to a Collection, it may use a media type of either "application/atom+xml" or "application/atom +xml;type=entry". This specification does not specify any request semantics or server behavior in the case where the POSTed media type is "application/atom+xml" but the body is something other than an Atom Entry. In particular, what happens on POSTing an Atom Feed Document to a Collection using the "application/ atom+xml" media type is undefined.
Gregorio & de hOra Standards Track [Page 25] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 25] RFC 5023 The Atom Publishing Protocol October 2007
The Atom Protocol does not specify a means to create multiple representations of the same Resource (for example, a PNG and a JPG of the same image) either on creation or editing.
The Atom Protocol does not specify a means to create multiple representations of the same Resource (for example, a PNG and a JPG of the same image) either on creation or editing.
9.6.1. Examples
9.6.1. Examples
Below, the client sends a POST request containing a PNG image to the URI of a Collection that accepts PNG images:
Below, the client sends a POST request containing a PNG image to the URI of a Collection that accepts PNG images:
POST /edit/ HTTP/1.1
Host: media.example.org
Content-Type: image/png
Slug: The Beach
Authorization: Basic ZGFmZnk6c2VjZXJldA==
Content-Length: nnn
POST /edit/ HTTP/1.1 Host: media.example.org Content-Type: image/png Slug: The Beach Authorization: Basic ZGFmZnk6c2VjZXJldA== Content-Length: nnn
...binary data...
...binary data...
The server signals a successful creation with a status code of 201. The response includes a Location header indicating the Member URI of the Media Link Entry and a representation of that entry in the body of the response. The Media Link Entry includes a content element with a "src" attribute. It also contains a link with a link relation of "edit-media", specifying the IRI to be used for modifying the Media Resource.
The server signals a successful creation with a status code of 201. The response includes a Location header indicating the Member URI of the Media Link Entry and a representation of that entry in the body of the response. The Media Link Entry includes a content element with a "src" attribute. It also contains a link with a link relation of "edit-media", specifying the IRI to be used for modifying the Media Resource.
HTTP/1.1 201 Created
Date: Fri, 7 Oct 2005 17:17:11 GMT
Content-Length: nnn
Content-Type: application/atom+xml;type=entry;charset="utf-8"
Location: http://example.org/media/edit/the_beach.atom
HTTP/1.1 201 Created Date: Fri, 7 Oct 2005 17:17:11 GMT Content-Length: nnn Content-Type: application/atom+xml;type=entry;charset="utf-8" Location: http://example.org/media/edit/the_beach.atom
<?xml version="1.0"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<title>The Beach</title>
<id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
<updated>2005-10-07T17:17:08Z</updated>
<author><name>Daffy</name></author>
<summary type="text" />
<content type="image/png"
src="http://media.example.org/the_beach.png"/>
<link rel="edit-media"
href="http://media.example.org/edit/the_beach.png" />
<link rel="edit"
href="http://example.org/media/edit/the_beach.atom" />
</entry>
<?xml version="1.0"?> <entry xmlns="http://www.w3.org/2005/Atom"> <title>The Beach</title> <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id> <updated>2005-10-07T17:17:08Z</updated> <author><name>Daffy</name></author> <summary type="text" /> <content type="image/png" src="http://media.example.org/the_beach.png"/> <link rel="edit-media" href="http://media.example.org/edit/the_beach.png" /> <link rel="edit" href="http://example.org/media/edit/the_beach.atom" /> </entry>
Gregorio & de hOra Standards Track [Page 26] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 26] RFC 5023 The Atom Publishing Protocol October 2007
Later, the client sends a PUT request containing the new PNG using the URI indicated in the Media Link Entry's "edit-media" link:
Later, the client sends a PUT request containing the new PNG using the URI indicated in the Media Link Entry's "edit-media" link:
PUT /edit/the_beach.png HTTP/1.1
Host: media.example.org
Content-Type: image/png
Authorization: Basic ZGFmZnk6c2VjZXJldA==
Content-Length: nnn
PUT /edit/the_beach.png HTTP/1.1 Host: media.example.org Content-Type: image/png Authorization: Basic ZGFmZnk6c2VjZXJldA== Content-Length: nnn
...binary data...
...binary data...
The server signals a successful edit with a status code of 200.
The server signals a successful edit with a status code of 200.
HTTP/1.1 200 Ok
Date: Fri, 8 Oct 2006 17:17:11 GMT
HTTP/1.1 200 Ok Date: Fri, 8 Oct 2006 17:17:11 GMT
The client can edit the metadata for the picture. First GET the Media Link Entry:
The client can edit the metadata for the picture. First GET the Media Link Entry:
GET /media/edit/the_beach.atom HTTP/1.1
Host: example.org
Authorization: Basic ZGFmZnk6c2VjZXJldA==
GET /media/edit/the_beach.atom HTTP/1.1 Host: example.org Authorization: Basic ZGFmZnk6c2VjZXJldA==
The Media Link Entry is returned.
The Media Link Entry is returned.
HTTP/1.1 200 Ok
Date: Fri, 7 Oct 2005 17:18:11 GMT
Content-Length: nnn
Content-Type: application/atom+xml;type=entry;charset="utf-8"
ETag: "c181bb840673b5"
HTTP/1.1 200 Ok Date: Fri, 7 Oct 2005 17:18:11 GMT Content-Length: nnn Content-Type: application/atom+xml;type=entry;charset="utf-8" ETag: "c181bb840673b5"
<?xml version="1.0"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<title>The Beach</title>
<id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
<updated>2005-10-07T17:17:08Z</updated>
<author><name>Daffy</name></author>
<summary type="text" />
<content type="image/png"
src="http://media.example.org/the_beach.png"/>
<link rel="edit-media"
href="http://media.example.org/edit/the_beach.png" />
<link rel="edit"
href="http://example.org/media/edit/the_beach.atom" />
</entry>
<?xml version="1.0"?> <entry xmlns="http://www.w3.org/2005/Atom"> <title>The Beach</title> <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id> <updated>2005-10-07T17:17:08Z</updated> <author><name>Daffy</name></author> <summary type="text" /> <content type="image/png" src="http://media.example.org/the_beach.png"/> <link rel="edit-media" href="http://media.example.org/edit/the_beach.png" /> <link rel="edit" href="http://example.org/media/edit/the_beach.atom" /> </entry>
The metadata can be updated, in this case to add a summary, and then PUT back to the server.
The metadata can be updated, in this case to add a summary, and then PUT back to the server.
Gregorio & de hOra Standards Track [Page 27] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 27] RFC 5023 The Atom Publishing Protocol October 2007
PUT /media/edit/the_beach.atom HTTP/1.1
Host: example.org
Authorization: Basic ZGFmZnk6c2VjZXJldA==
Content-Type: application/atom+xml;type=entry
Content-Length: nnn
If-Match: "c181bb840673b5"
PUT /media/edit/the_beach.atom HTTP/1.1 Host: example.org Authorization: Basic ZGFmZnk6c2VjZXJldA== Content-Type: application/atom+xml;type=entry Content-Length: nnn If-Match: "c181bb840673b5"
<?xml version="1.0"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<title>The Beach</title>
<id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
<updated>2005-10-07T17:17:08Z</updated>
<author><name>Daffy</name></author>
<summary type="text">
A nice sunset picture over the water.
</summary>
<content type="image/png"
src="http://media.example.org/the_beach.png"/>
<link rel="edit-media"
href="http://media.example.org/edit/the_beach.png" />
<link rel="edit"
href="http://example.org/media/edit/the_beach.atom" />
</entry>
<?xml version="1.0"?> <entry xmlns="http://www.w3.org/2005/Atom"> <title>The Beach</title> <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id> <updated>2005-10-07T17:17:08Z</updated> <author><name>Daffy</name></author> <summary type="text"> A nice sunset picture over the water. </summary> <content type="image/png" src="http://media.example.org/the_beach.png"/> <link rel="edit-media" href="http://media.example.org/edit/the_beach.png" /> <link rel="edit" href="http://example.org/media/edit/the_beach.atom" /> </entry>
The update was successful.
The update was successful.
HTTP/1.1 200 Ok
Date: Fri, 7 Oct 2005 17:19:11 GMT
Content-Length: 0
HTTP/1.1 200 Ok Date: Fri, 7 Oct 2005 17:19:11 GMT Content-Length: 0
Multiple Media Resources can be added to the Collection.
Multiple Media Resources can be added to the Collection.
POST /edit/ HTTP/1.1
Host: media.example.org
Content-Type: image/png
Slug: The Pier
Authorization: Basic ZGFmZnk6c2VjZXJldA==
Content-Length: nnn
POST /edit/ HTTP/1.1 Host: media.example.org Content-Type: image/png Slug: The Pier Authorization: Basic ZGFmZnk6c2VjZXJldA== Content-Length: nnn
...binary data...
...binary data...
The Resource is created successfully.
The Resource is created successfully.
HTTP/1.1 201 Created
Date: Fri, 7 Oct 2005 17:17:11 GMT
Content-Length: nnn
Content-Type: application/atom+xml;type=entry;charset="utf-8"
Location: http://example.org/media/edit/the_pier.atom
HTTP/1.1 201 Created Date: Fri, 7 Oct 2005 17:17:11 GMT Content-Length: nnn Content-Type: application/atom+xml;type=entry;charset="utf-8" Location: http://example.org/media/edit/the_pier.atom
Gregorio & de hOra Standards Track [Page 28] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 28] RFC 5023 The Atom Publishing Protocol October 2007
<?xml version="1.0"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<title>The Pier</title>
<id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efe6b</id>
<updated>2005-10-07T17:26:43Z</updated>
<author><name>Daffy</name></author>
<summary type="text" />
<content type="image/png"
src="http://media.example.org/the_pier.png"/>
<link rel="edit-media"
href="http://media.example.org/edit/the_pier.png" />
<link rel="edit"
href="http://example.org/media/edit/the_pier.atom" />
</entry>
<?xml version="1.0"?> <entry xmlns="http://www.w3.org/2005/Atom"> <title>The Pier</title> <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efe6b</id> <updated>2005-10-07T17:26:43Z</updated> <author><name>Daffy</name></author> <summary type="text" /> <content type="image/png" src="http://media.example.org/the_pier.png"/> <link rel="edit-media" href="http://media.example.org/edit/the_pier.png" /> <link rel="edit" href="http://example.org/media/edit/the_pier.atom" /> </entry>
The client can now create a new Atom Entry in the blog Entry Collection that references the two newly created Media Resources.
The client can now create a new Atom Entry in the blog Entry Collection that references the two newly created Media Resources.
POST /blog/ HTTP/1.1
Host: example.org
Content-Type: application/atom+xml;type=entry
Slug: A day at the beach
Authorization: Basic ZGFmZnk6c2VjZXJldA==
Content-Length: nnn
POST /blog/ HTTP/1.1 Host: example.org Content-Type: application/atom+xml;type=entry Slug: A day at the beach Authorization: Basic ZGFmZnk6c2VjZXJldA== Content-Length: nnn
<?xml version="1.0"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<title>A fun day at the beach</title>
<id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6b</id>
<updated>2005-10-07T17:40:02Z</updated>
<author><name>Daffy</name></author>
<content type="xhtml">
<xhtml:div xmlns:xhtml="http://www.w3.org/1999/xhtml">
<xhtml:p>We had a good day at the beach.
<xhtml:img alt="the beach"
src="http://media.example.org/the_beach.png"/>
</xhtml:p>
<xhtml:p>Later we walked down to the pier.
<xhtml:img alt="the pier"
src="http://media.example.org/the_pier.png"/>
</xhtml:p>
</xhtml:div>
</content>
</entry>
<?xml version="1.0"?> <entry xmlns="http://www.w3.org/2005/Atom"> <title>A fun day at the beach</title> <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6b</id> <updated>2005-10-07T17:40:02Z</updated> <author><name>Daffy</name></author> <content type="xhtml"> <xhtml:div xmlns:xhtml="http://www.w3.org/1999/xhtml"> <xhtml:p>We had a good day at the beach. <xhtml:img alt="the beach" src="http://media.example.org/the_beach.png"/> </xhtml:p> <xhtml:p>Later we walked down to the pier. <xhtml:img alt="the pier" src="http://media.example.org/the_pier.png"/> </xhtml:p> </xhtml:div> </content> </entry>
The Resource is created successfully.
The Resource is created successfully.
Gregorio & de hOra Standards Track [Page 29] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 29] RFC 5023 The Atom Publishing Protocol October 2007
HTTP/1.1 200 Ok
Date: Fri, 7 Oct 2005 17:20:11 GMT
Content-Length: nnn
Content-Type: application/atom+xml;type=entry;charset="utf-8"
Location: http://example.org/blog/atom/a-day-at-the-beach.atom
HTTP/1.1 200 Ok Date: Fri, 7 Oct 2005 17:20:11 GMT Content-Length: nnn Content-Type: application/atom+xml;type=entry;charset="utf-8" Location: http://example.org/blog/atom/a-day-at-the-beach.atom
<?xml version="1.0"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<title>A fun day at the beach</title>
<id>http://example.org/blog/a-day-at-the-beach.xhtml</id>
<updated>2005-10-07T17:43:07Z</updated>
<author><name>Daffy</name></author>
<content type="xhtml">
<xhtml:div xmlns:xhtml="http://www.w3.org/1999/xhtml">
<xhtml:p>We had a good day at the beach.
<xhtml:img alt="the beach"
src="http://media.example.org/the_beach.png"/>
</xhtml:p>
<xhtml:p>Later we walked down to the pier.
<xhtml:img alt="the pier"
src="http://media.example.org/the_pier.png"/>
</xhtml:p>
</xhtml:div>
</content>
<link rel="edit"
href="http://example.org/blog/edit/a-day-at-the-beach.atom"/>
<link rel="alternate" type="text/html"
href="http://example.org/blog/a-day-at-the-beach.html"/>
</entry>
<?xml version="1.0"?> <entry xmlns="http://www.w3.org/2005/Atom"> <title>A fun day at the beach</title> <id>http://example.org/blog/a-day-at-the-beach.xhtml</id> <updated>2005-10-07T17:43:07Z</updated> <author><name>Daffy</name></author> <content type="xhtml"> <xhtml:div xmlns:xhtml="http://www.w3.org/1999/xhtml"> <xhtml:p>We had a good day at the beach. <xhtml:img alt="the beach" src="http://media.example.org/the_beach.png"/> </xhtml:p> <xhtml:p>Later we walked down to the pier. <xhtml:img alt="the pier" src="http://media.example.org/the_pier.png"/> </xhtml:p> </xhtml:div> </content> <link rel="edit" href="http://example.org/blog/edit/a-day-at-the-beach.atom"/> <link rel="alternate" type="text/html" href="http://example.org/blog/a-day-at-the-beach.html"/> </entry>
Note that the returned Entry contains a link with a relation of "alternate" that points to the associated HTML page that was created -- this is not required by this specification, but is included to show the kinds of changes a server can make to an Entry.
Note that the returned Entry contains a link with a relation of "alternate" that points to the associated HTML page that was created -- this is not required by this specification, but is included to show the kinds of changes a server can make to an Entry.
9.7. The Slug Header
9.7. The Slug Header
Slug is an HTTP entity-header whose presence in a POST to a Collection constitutes a request by the client to use the header's value as part of any URIs that would normally be used to retrieve the to-be-created Entry or Media Resources.
Slug is an HTTP entity-header whose presence in a POST to a Collection constitutes a request by the client to use the header's value as part of any URIs that would normally be used to retrieve the to-be-created Entry or Media Resources.
Servers MAY use the value of the Slug header when creating the Member URI of the newly created Resource, for instance, by using some or all of the words in the value for the last URI segment. Servers MAY also use the value when creating the atom:id, or as the title of a Media Link Entry (see Section 9.6).
Servers MAY use the value of the Slug header when creating the Member URI of the newly created Resource, for instance, by using some or all of the words in the value for the last URI segment. Servers MAY also use the value when creating the atom:id, or as the title of a Media Link Entry (see Section 9.6).
Gregorio & de hOra Standards Track [Page 30] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 30] RFC 5023 The Atom Publishing Protocol October 2007
Servers MAY choose to ignore the Slug entity-header. Servers MAY alter the header value before using it. For instance, a server might filter out some characters or replace accented letters with non- accented ones, replace spaces with underscores, change case, and so on.
Servers MAY choose to ignore the Slug entity-header. Servers MAY alter the header value before using it. For instance, a server might filter out some characters or replace accented letters with non- accented ones, replace spaces with underscores, change case, and so on.
9.7.1. Slug Header Syntax
9.7.1. Slug Header Syntax
The syntax of the Slug header is defined using the augmented BNF syntax defined in Section 2.1 of [RFC2616]:
The syntax of the Slug header is defined using the augmented BNF syntax defined in Section 2.1 of [RFC2616]:
LWS = <defined in Section 2.2 of [RFC2616]>
slugtext = %x20-7E | LWS
Slug = "Slug" ":" *slugtext
LWS = <defined in Section 2.2 of [RFC2616]> slugtext = %x20-7E | LWS Slug = "Slug" ":" *slugtext
The field value is the percent-encoded value of the UTF-8 encoding of the character sequence to be included (see Section 2.1 of [RFC3986] for the definition of percent encoding, and [RFC3629] for the definition of the UTF-8 encoding).
The field value is the percent-encoded value of the UTF-8 encoding of the character sequence to be included (see Section 2.1 of [RFC3986] for the definition of percent encoding, and [RFC3629] for the definition of the UTF-8 encoding).
Implementation note: to produce the field value from a character sequence, first encode it using the UTF-8 encoding, then encode all octets outside the ranges %20-24 and %26-7E using percent encoding (%25 is the ASCII encoding of "%", thus it needs to be escaped). To consume the field value, first reverse the percent encoding, then run the resulting octet sequence through a UTF-8 decoding process.
Implementation note: to produce the field value from a character sequence, first encode it using the UTF-8 encoding, then encode all octets outside the ranges %20-24 and %26-7E using percent encoding (%25 is the ASCII encoding of "%", thus it needs to be escaped). To consume the field value, first reverse the percent encoding, then run the resulting octet sequence through a UTF-8 decoding process.
9.7.2. Example
9.7.2. Example
Here is an example of the Slug header that uses percent-encoding to represent the Unicode character U+00E8 (LATIN SMALL LETTER E WITH GRAVE):
Here is an example of the Slug header that uses percent-encoding to represent the Unicode character U+00E8 (LATIN SMALL LETTER E WITH GRAVE):
POST /myblog/entries HTTP/1.1
Host: example.org
Content-Type: image/png
Slug: The Beach at S%C3%A8te
Authorization: Basic ZGFmZnk6c2VjZXJldA==
Content-Length: nnn
POST /myblog/entries HTTP/1.1 Host: example.org Content-Type: image/png Slug: The Beach at S%C3%A8te Authorization: Basic ZGFmZnk6c2VjZXJldA== Content-Length: nnn
...binary data...
...binary data...
See Section 9.2.1 for an example of the Slug header applied to the creation of an Entry Resource.
See Section 9.2.1 for an example of the Slug header applied to the creation of an Entry Resource.
Gregorio & de hOra Standards Track [Page 31] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 31] RFC 5023 The Atom Publishing Protocol October 2007
10. Listing Collections
10. Listing Collections
Collection Resources MUST provide representations in the form of Atom Feed Documents whose Entries contain the IRIs of the Members in the Collection. No distinction is made between Collection Feeds and other kinds of Feeds -- a Feed might act both as a 'public' feed for subscription purposes and as a Collection Feed.
Collection Resources MUST provide representations in the form of Atom Feed Documents whose Entries contain the IRIs of the Members in the Collection. No distinction is made between Collection Feeds and other kinds of Feeds -- a Feed might act both as a 'public' feed for subscription purposes and as a Collection Feed.
Each Entry in the Feed Document SHOULD have an atom:link element with a relation of "edit" (see Section 11.1).
Each Entry in the Feed Document SHOULD have an atom:link element with a relation of "edit" (see Section 11.1).
The Entries in the returned Atom Feed SHOULD be ordered by their "app:edited" property, with the most recently edited Entries coming first in the document order. The app:edited value is not equivalent to the HTTP Last-Modified header and cannot be used to determine the freshness of cached responses.
The Entries in the returned Atom Feed SHOULD be ordered by their "app:edited" property, with the most recently edited Entries coming first in the document order. The app:edited value is not equivalent to the HTTP Last-Modified header and cannot be used to determine the freshness of cached responses.
Clients MUST NOT assume that an Atom Entry returned in the Feed is a full representation of an Entry Resource and SHOULD perform a GET on the URI of the Member Entry before editing it. See Section 9.5 for a discussion on the implications of cache control directives when obtaining entries.
Clients MUST NOT assume that an Atom Entry returned in the Feed is a full representation of an Entry Resource and SHOULD perform a GET on the URI of the Member Entry before editing it. See Section 9.5 for a discussion on the implications of cache control directives when obtaining entries.
10.1. Collection Partial Lists
10.1. Collection Partial Lists
Collections can contain large numbers of Resources. A client such as a web spider or web browser might be overwhelmed if the response to a GET contained every Entry in a Collection -- in turn the server might also waste bandwidth and processing time on generating a response that cannot be handled. For this reason, servers MAY respond to Collection GET requests with a Feed Document containing a partial list of the Collection's members, and a link to the next partial list feed, if it exists. The first such partial list returned MUST contain the most recently edited member Resources and MUST have an atom:link with a "next" relation whose "href" value is the URI of the next partial list of the Collection. This next partial list will contain the next most recently edited set of Member Resources (and an atom:link to the following partial list if it exists).
Collections can contain large numbers of Resources. A client such as a web spider or web browser might be overwhelmed if the response to a GET contained every Entry in a Collection -- in turn the server might also waste bandwidth and processing time on generating a response that cannot be handled. For this reason, servers MAY respond to Collection GET requests with a Feed Document containing a partial list of the Collection's members, and a link to the next partial list feed, if it exists. The first such partial list returned MUST contain the most recently edited member Resources and MUST have an atom:link with a "next" relation whose "href" value is the URI of the next partial list of the Collection. This next partial list will contain the next most recently edited set of Member Resources (and an atom:link to the following partial list if it exists).
In addition to the "next" relation, partial list feeds MAY contain link elements with "rel" attribute values of "previous", "first", and "last", that can be used to navigate through the complete set of entries in the Collection.
In addition to the "next" relation, partial list feeds MAY contain link elements with "rel" attribute values of "previous", "first", and "last", that can be used to navigate through the complete set of entries in the Collection.
For instance, suppose a client is supplied the URI "http://example.org/entries/go" of a Collection of Member Entries, where the server as a matter of policy avoids generating Feed Documents containing more than 10 Entries. The Atom Feed Document
For instance, suppose a client is supplied the URI "http://example.org/entries/go" of a Collection of Member Entries, where the server as a matter of policy avoids generating Feed Documents containing more than 10 Entries. The Atom Feed Document
Gregorio & de hOra Standards Track [Page 32] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 32] RFC 5023 The Atom Publishing Protocol October 2007
for the Collection will then represent the first partial list of a set of 10 linked Feed Documents. The "first" relation references the initial Feed Document in the set and the "last" relation references the final Feed Document in the set. Within each document, the "previous" and "next" link relations reference the preceding and subsequent documents.
for the Collection will then represent the first partial list of a set of 10 linked Feed Documents. The "first" relation references the initial Feed Document in the set and the "last" relation references the final Feed Document in the set. Within each document, the "previous" and "next" link relations reference the preceding and subsequent documents.
<feed xmlns="http://www.w3.org/2005/Atom">
<link rel="first"
href="http://example.org/entries/go" />
<link rel="next"
href="http://example.org/entries/2" />
<link rel="last"
href="http://example.org/entries/10" />
...
</feed>
<feed xmlns="http://www.w3.org/2005/Atom"> <link rel="first" href="http://example.org/entries/go" /> <link rel="next" href="http://example.org/entries/2" /> <link rel="last" href="http://example.org/entries/10" /> ... </feed>
The "previous" and "next" link elements for the partial list feed located at "http://example.org/entries/2" would look like this:
The "previous" and "next" link elements for the partial list feed located at "http://example.org/entries/2" would look like this:
<feed xmlns="http://www.w3.org/2005/Atom">
<link rel="first"
href="http://example.org/entries/go" />
<link rel="previous"
href="http://example.org/entries/go" />
<link rel="next"
href="http://example.org/entries/3" />
<link rel="last"
href="http://example.org/entries/10" />
...
</feed>
<feed xmlns="http://www.w3.org/2005/Atom"> <link rel="first" href="http://example.org/entries/go" /> <link rel="previous" href="http://example.org/entries/go" /> <link rel="next" href="http://example.org/entries/3" /> <link rel="last" href="http://example.org/entries/10" /> ... </feed>
10.2. The "app:edited" Element
10.2. The "app:edited" Element
The "app:edited" element is a Date construct (as defined by [RFC4287]), whose content indicates the last time an Entry was edited. If the entry has not been edited yet, the content indicates the time it was created. Atom Entry elements in Collection Documents SHOULD contain one app:edited element, and MUST NOT contain more than one.
The "app:edited" element is a Date construct (as defined by [RFC4287]), whose content indicates the last time an Entry was edited. If the entry has not been edited yet, the content indicates the time it was created. Atom Entry elements in Collection Documents SHOULD contain one app:edited element, and MUST NOT contain more than one.
appEdited = element app:edited ( atomDateConstruct )
appEdited = element app:edited ( atomDateConstruct )
The server SHOULD change the value of this element every time an Entry Resource or an associated Media Resource has been edited.
The server SHOULD change the value of this element every time an Entry Resource or an associated Media Resource has been edited.
Gregorio & de hOra Standards Track [Page 33] RFC 5023 The Atom Publishing Protocol October 2007
Gregorio & de hOra Standards Track [Page 33] RFC 5023 The Atom Publishing Protocol October 2007
11. Atom Format Link Relation Extensions
11. Atom Format Link Relation Extensions
11.1. The "edit" Link Relation
11.1. The "edit" Link Relation
This specification adds the value "edit" to the Atom Registry of Link Relations (see Section 7.1 of [RFC4287]). The value of "edit" specifies that the value of the href attribute is the IRI of an editable Member Entry. When appearing within an atom:entry, the href IRI can be used to retrieve, update, and delete the Resource represented by that Entry. An atom:entry MUST NOT contain more than one "edit" link relation.
This specification adds the value "edit" to the Atom Registry of Link Relations (see Section 7.1 of [RFC4287]). The value of "edit" specifies that the value of the href attribute is the IRI of an editable Member Entry. When appearing within an atom:entry, the href IRI can be used to retrieve, update, and delete the Resource represented by that Entry. An atom:entry MUST NOT contain more than one "edit" link relation.
11.2. The "edit-media" Link Relation
11.2. The "edit-media" Link Relation
This specification adds the value "edit-media" to the Atom Registry of Link Relations (see Section 7.1 of [RFC4287]). When appearing within an atom:entry, the value of the href attribute is an IRI that can be used to modify a Media Resource associated with that Entry.
この仕様は値の「編集メディア」をLink RelationsのAtom Registryに加えます([RFC4287]のセクション7.1を見てください)。 原子: エントリーの中に現れるとき、href属性の値はそのEntryに関連しているメディアResourceを変更するのに使用できるIRIです。
An atom:entry element MAY contain zero or more "edit-media" link relations. An atom:entry MUST NOT contain more than one atom:link element with a "rel" attribute value of "edit-media" that has the same "type" and "hreflang" attribute values. All "edit-media" link relations in the same Entry reference the same Resource. If a client encounters multiple "edit-media" link relations in an Entry then it SHOULD choose a link based on the client preferences for "type" and "hreflang". If a client encounters multiple "edit-media" link relations in an Entry and has no preference based on the "type" and "hreflang" attributes then the client SHOULD pick the first "edit- media" link relation in document order.
原子: エントリー要素はゼロか、より多くの「編集メディア」リンク関係を含むかもしれません。 原子: エントリーは1つ以上の原子を含んではいけません: 同じ「タイプ」と"hreflang"属性値を持っている「編集メディア」の"rel"属性値に要素をリンクしてください。 すべての「編集メディア」が同じ同じEntry参照Resourceにおける関係をリンクします。 クライアントがEntryで複数の「編集メディア」リンク関係に遭遇するなら、それは「タイプ」と"hreflang"のためのクライアント好みを基礎づけましたSHOULDが、リンクを選ぶ。 クライアントがEntryで複数の「編集メディア」リンク関係に遭遇して、「タイプ」と"hreflang"属性に基づいてどちらでもよいなら、クライアントSHOULDはドキュメントオーダーにおける最初の「編集メディア」リンク関係を選びます。
12. The Atom Format Type Parameter
12. 原子形式型引数
The Atom Syndication Format [RFC4287] defines the "application/ atom+xml" media type to identify both Atom Feed and Atom Entry Documents. Implementation experience has demonstrated that Atom Feed and Entry Documents can have different processing models and that there are situations where they need to be differentiated. This specification defines a "type" parameter used to differentiate the two types of Atom documents.
Atom Syndication Format[RFC4287]は、Atom FeedとAtom Entry Documentsの両方を特定するために「アプリケーション/原子+xml」メディアタイプを定義します。 実装経験はAtom FeedとEntry Documentsが異なった処理モデルを持つことができて、状況がそれらが差別化される必要があるところにあるのを示しました。 この仕様は2つのタイプのAtomドキュメントを差別化するのに使用される「タイプ」パラメタを定義します。
12.1. The "type" parameter
12.1. 「タイプ」パラメタ
This specification defines a new "type" parameter for use with the "application/atom+xml" media type. The "type" parameter has a value of "entry" or "feed".
この仕様は「アプリケーション/原子+xml」メディアタイプで使用のための新しい「タイプ」パラメタを定義します。 「タイプ」パラメタには、「エントリー」か「給送」の値があります。
Neither the parameter name nor its value are case sensitive.
パラメタ名もその値も大文字と小文字を区別していません。
Gregorio & de hOra Standards Track [Page 34] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[34ページ]RFC5023Atom出版プロトコル2007年10月
The value "entry" indicates that the media type identifies an Atom Entry Document. The root element of the document MUST be atom:entry.
値の「エントリー」は、メディアタイプがAtom Entry Documentを特定するのを示します。 ドキュメントの根の要素は原子であるに違いありません: エントリー。
The value "feed" indicates that the media type identifies an Atom Feed Document. The root element of the document MUST be atom:feed.
値の「給送」は、メディアタイプがAtom Feed Documentを特定するのを示します。 ドキュメントの根の要素は原子であるに違いありません: 食べてください。
If not specified, the type is assumed to be unspecified, requiring Atom processors to examine the root element to determine the type of Atom document.
指定されないなら、タイプが不特定であると思われます、Atomドキュメントのタイプを決定するために根の要素を調べるためにAtomプロセッサを必要として。
12.1.1. Conformance
12.1.1. 順応
New specifications MAY require that the "type" parameter be used to identify the Atom Document type. Producers of Atom Entry Documents SHOULD use the "type" parameter regardless of whether or not it is mandatory. Producers of Atom Feed Documents MAY use the parameter.
新しい仕様は、「タイプ」パラメタがAtom Documentタイプを特定するのに使用されるのを必要とするかもしれません。 それが義務的であるかどうかにかかわらずAtom Entry Documents SHOULDのプロデューサーは「タイプ」パラメタを使用します。 Atom Feed Documentsのプロデューサーはパラメタを使用するかもしれません。
Atom processors that do not recognize the "type" parameter MUST ignore its value and examine the root element to determine the document type.
「タイプ」パラメタを認識しない原子プロセッサは、ドキュメントタイプを決定するために値を無視して、根の要素を調べなければなりません。
Atom processors that do recognize the "type" parameter SHOULD detect and report inconsistencies between the parameter's value and the actual type of the document's root element.
「タイプ」パラメタSHOULDを認識する原子プロセッサが、ドキュメントの根の要素のパラメタの値と実際のタイプの間の矛盾を検出して、報告します。
13. Atom Publishing Controls
13. 原子出版コントロール
This specification defines an Atom Format Structured Extension, as defined in Section 6 of [RFC4287], for publishing control within the "http://www.w3.org/2007/app" namespace.
この仕様はAtom Format Structured Extensionを定義します、[RFC4287]のセクション6で定義されるように、" http://www.w3.org/2007/app "名前空間の中でコントロールを発行するために。
13.1. The "app:control" Element
13.1. 「装置: 制御してください」という要素
namespace app = "http://www.w3.org/2007/app"
名前空間装置は" http://www.w3.org/2007/app "と等しいです。
pubControl =
element app:control {
atomCommonAttributes,
pubDraft?
& extensionElement
}
要素pubControl=装置: コントロール{ atomCommonAttributes、pubDraft? extensionElement}
pubDraft =
element app:draft { "yes" | "no" }
要素pubDraft=装置: 草稿「はい」| 「いいえ」
Gregorio & de hOra Standards Track [Page 35] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[35ページ]RFC5023Atom出版プロトコル2007年10月
The "app:control" element MAY appear as a child of an atom:entry that is being created or updated via the Atom Publishing Protocol. The app:control element MUST appear only once in an Entry. The app: control element is considered foreign markup as defined in Section 6 of [RFC4287].
「装置: 制御してください」という要素は原子の子供として現れるかもしれません: Atom出版プロトコルで作成されるか、またはアップデートされているエントリー。 装置: 制御要素はEntryに一度だけ現れなければなりません。 装置: 制御要素は[RFC4287]のセクション6で定義される外国マーク付けであると考えられます。
The app:control element and its child elements MAY be included in Atom Feed or Entry Documents.
装置: 制御要素とその子供要素はAtom FeedかEntry Documentsに含まれるかもしれません。
The app:control element can contain an "app:draft" element as defined below, and it can contain extension elements as defined in Section 6 of [RFC4287].
装置: 制御要素は以下で定義されるとしての要素、およびそれがそうすることができる「装置: 草稿」を含むことができます。[RFC4287]のセクション6で定義されるように拡大要素を含んでください。
13.1.1. The "app:draft" Element
13.1.1. 「装置: 」 要素を作成してください。
The inclusion of the "app:draft" element represents a request by the client to control the visibility of a Member Resource. The app:draft element MAY be ignored by the server.
要素がクライアントによる要求を表す「装置: 草稿」の包含はメンバーResourceの目に見えることを制御します。 装置: 草稿要素はサーバによって無視されるかもしれません。
The number of app:draft elements in app:control MUST be zero or one. The content of an app:draft element MUST be one of "yes" or "no". If the element contains "no", this indicates a client request that the Member Resource be made publicly visible. If the app:draft element is not present, then servers that support the extension MUST behave as though an app:draft element containing "no" was sent.
装置の数: 装置の草稿要素: コントロールは、ゼロか1であるに違いありません。 装置の内容: 草稿要素は1であるに違いありません。「はい」か「いいえ」について。 要素が「いいえ」を含んでいるなら、これは公的にメンバーResourceを目に見えるようにするというクライアント要求を示します。 装置: 草稿要素が存在していないなら、拡大をサポートするサーバはまるで装置: 「いいえ」を含む草稿要素を送るかのように振る舞わなければなりません。
14. Securing the Atom Publishing Protocol
14. 原子出版プロトコルを保証します。
The Atom Publishing Protocol is based on HTTP. Authentication requirements for HTTP are covered in Section 11 of [RFC2616].
Atom出版プロトコルはHTTPに基づいています。 HTTPのための認証要件は[RFC2616]のセクション11でカバーされています。
The use of authentication mechanisms to prevent POSTing or editing by unknown or unauthorized clients is RECOMMENDED but not required. When authentication is not used, clients and servers are vulnerable to trivial spoofing, denial-of-service, and defacement attacks. However, in some contexts, this is an acceptable risk.
未知の、または、権限のないクライアントによるPOSTingか編集を防ぐ認証機構の使用は、RECOMMENDEDにもかかわらず、必要ではありません。 認証が使用されていないとき、クライアントとサーバは些細なスプーフィング、サービスの否定、および変造攻撃に被害を受け易いです。 しかしながら、いくつかの文脈では、これは許容リスクです。
The type of authentication deployed is a local decision made by the server operator. Clients are likely to face authentication schemes that vary across server deployments. At a minimum, client and server implementations MUST be capable of being configured to use HTTP Basic Authentication [RFC2617] in conjunction with a connection made with TLS 1.0 [RFC2246] or a subsequent standards-track version of TLS (such as [RFC4346]), supporting the conventions for using HTTP over TLS described in [RFC2818].
配布された認証のタイプはサーバオペレータによってされたローカルの決定です。 クライアントはサーバ展開の向こう側に異なる認証体系に直面していそうです。 最小限、クライアント、およびサーバでは、実装はTLS1.0と共に作られた接続[RFC2246]かTLSのその後の標準化過程バージョン([RFC4346]などの)に関連してHTTP Basic Authentication[RFC2617]を使用するために構成できなければなりません、[RFC2818]で説明されたTLSの上でHTTPを使用するためにコンベンションをサポートして。
Gregorio & de hOra Standards Track [Page 36] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[36ページ]RFC5023Atom出版プロトコル2007年10月
The choice of authentication mechanism will impact interoperability. The minimum level of security referenced above (Basic Authentication with TLS) is considered good practice for Internet applications at the time of publication of this specification and sufficient for establishing a baseline for interoperability. Implementers are encouraged to investigate and use alternative mechanisms regarded as equivalently good or better at the time of deployment. It is RECOMMENDED that clients be implemented in such a way that new authentication schemes can be deployed.
認証機構の選択は相互運用性に影響を与えるでしょう。 (TLSと基本的なAuthentication)の上で参照をつけられるセキュリティの最低水準は、この仕様の公表時点のインターネットアプリケーションのための良い習慣であると考えられて、相互運用性のために基線を確立するのに十分です。 Implementersは展開時点同等に良いか、より良いと見なされた代替のメカニズムを調査して、使用するよう奨励されます。 クライアントが新しい認証体系を配布することができるような方法で実装されるのは、RECOMMENDEDです。
Because this protocol uses HTTP response status codes as the primary means of reporting the result of a request, servers are advised to respond to unauthorized or unauthenticated requests using an appropriate 4xx HTTP response code (e.g., 401 "Unauthorized" or 403 "Forbidden") in accordance with [RFC2617].
このプロトコルが予備選挙が意味するように状態がコード化する要求の結果を報告するHTTP応答を使用するので、サーバが[RFC2617]に従って適切な4xx HTTP応答コード(401「権限のない」か403「禁じる」例えば、)を使用することで権限のないか非認証された要求に応じるように教えられます。
15. Security Considerations
15. セキュリティ問題
The Atom Publishing Protocol is based on HTTP and thus subject to the security considerations found in Section 15 of [RFC2616].
Atom出版プロトコルはHTTPとその結果、[RFC2616]のセクション15で見つけられたセキュリティ問題を条件として基づいています。
The threats listed in this section apply to many protocols that run under HTTP. The Atompub Working Group decided that the protection afforded by running authenticated HTTP under TLS (as described in Section 14) was sufficient to mitigate many of the problems presented by the attacks listed in this section.
このセクションで記載された脅威はHTTPで実行される多くのプロトコルに適用されます。 Atompub作業部会は、TLS(セクション14で説明されるように)の下で実行の認証されたHTTPによって提供された保護がこのセクションで記載された攻撃で提示された問題の多くを緩和するために十分であると決めました。
15.1. Denial of Service
15.1. サービス妨害
Atom Publishing Protocol server implementations need to take adequate precautions to ensure malicious clients cannot consume excessive server resources (CPU, memory, disk, etc.).
原子出版プロトコルサーバ実装は、悪意があるクライアントが過度のサーバリソース(CPU、メモリ、ディスクなど)を消費できないのを保証するために適切な注意を払う必要があります。
15.2. Replay Attacks
15.2. 反射攻撃
Atom Publishing Protocol server implementations are susceptible to replay attacks. Specifically, this specification does not define a means of detecting duplicate requests. Accidentally sent duplicate requests are indistinguishable from intentional and malicious replay attacks.
原子出版プロトコルサーバ実装は反射攻撃に影響されやすいです。 明確に、この仕様は写し要求を検出する手段を定義しません。 偶然送られた写し要求は意図的で悪意がある反射攻撃から区別がつきません。
15.3. Spoofing Attacks
15.3. スプーフィング攻撃
Atom Publishing Protocol implementations are susceptible to a variety of spoofing attacks. Malicious clients might send Atom Entries containing inaccurate information anywhere in the document.
原子出版プロトコル実装はさまざまなスプーフィング攻撃に影響されやすいです。 悪意があるクライアントはドキュメントでどこでも不正確な情報を含むAtom Entriesを送るかもしれません。
Gregorio & de hOra Standards Track [Page 37] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[37ページ]RFC5023Atom出版プロトコル2007年10月
15.4. Linked Resources
15.4. 繋がっているリソース
Atom Feed and Entry Documents can contain XML External Entities as defined in Section 4.2.2 of [REC-xml]. Atom implementations are not required to load external entities. External entities are subject to the same security concerns as any network operation and can alter the semantics of an Atom document. The same issues exist for Resources linked to by Atom elements such as atom:link and atom:content.
原子FeedとEntry Documentsは.2セクション4.2[REC-xml]で定義されるようにXML External Entitiesを含むことができます。 原子実装は、外部実体をロードするのに必要ではありません。 外部実体は、どんなネットワーク操作とも同じ安全上の配慮を受けることがあって、Atomドキュメントの意味論を変更できます。 同じ問題は原子などのAtom要素によってリンクされたResourcesのために存在しています: リンクと原子: 内容。
15.5. Digital Signatures and Encryption
15.5. デジタル署名と暗号化
Atom Entry and Feed Documents can contain XML Digital Signatures [REC-xmldsig-core] and can be encrypted using XML Encryption [REC-xmlenc-core] as specified in Section 5 of [RFC4287]. Handling of signatures and encrypted elements in Atom documents is discussed in Sections 5 and 6.3 of [RFC4287].
原子EntryとFeed DocumentsはXML Digital Signatures[REC-xmldsig-コア]を含むことができて、[RFC4287]のセクション5における指定されるとしてのXML Encryption[REC-xmlenc-コア]を使用することで暗号化できます。 [RFC4287]のセクション5と6.3でAtomドキュメントの署名と暗号化された要素の取り扱いについて議論します。
Neither servers nor clients are under any obligation to support encryption and digital signature of Entries or Feeds, although it is certainly possible that in some installations, clients or servers might require signing or encrypting of the documents exchanged in the Atom Protocol.
サーバもクライアントもEntriesかFeedsの暗号化とデジタル署名をサポートするどんな義務の下にもいません、いくつかのインストールでは、クライアントかサーバがAtomプロトコルで交換されたドキュメントの署名か暗号化を必要とするのが、確かに可能ですが。
Because servers are allowed (and in some cases, expected) to modify the contents of an Entry Document before publishing it, signatures within an entry are only likely to be useful to the server to which the entry is being sent. Clients cannot assume that the signature will be valid when viewed by a third party, or even that the server will publish the client's signature.
それを発行する前にサーバがEntry Documentのコンテンツを変更できるので(そして、予想されて、或るものがケースに入れるコネ)、エントリーの中の署名は単にエントリーが送られるサーバの役に立つ傾向があります。 クライアントは、第三者によって見られると署名が有効になるか、またはサーバがクライアントの署名を発行さえすると仮定できません。
A server is allowed to strip client-applied signatures, to strip client-applied signatures and then re-sign with its own public key, and to oversign an entry with its own public key. The meaning to a third party of a signature applied by a server is the same as a signature from anyone, as described in [RFC4287]. It is RECOMMENDED that a server that is aware that it has changed any part of an Entry Document that was signed by the client should strip that signature before publishing the entry in order to prevent third parties from trying to interpret a signature that cannot be validated.
サーバは、クライアントによって適用された署名を剥取るためにクライアントによって適用された署名を剥取って、次に、それ自身の公開鍵でそれ自身の公開鍵と、「過剰-サイン」にエントリーを再契約できます。 サーバによって適用された署名の第三者への意味はだれからのも署名と同じです、[RFC4287]で説明されるように。 第三者が有効にすることができない署名を解釈しようとするのを防ぐためにエントリーを発行する前にクライアントによって署名されるEntry Documentのどんな部分も変えたのを意識しているサーバがその署名を剥取るべきであるのは、RECOMMENDEDです。
15.6. URIs and IRIs
15.6. URIと虹彩
Atom Publishing Protocol implementations handle URIs and IRIs. See Section 7 of [RFC3986] and Section 8 of [RFC3987] for security considerations related to their handling and use.
原子出版プロトコル実装はURIとIRIsを扱います。 [RFC3986]のセクション7とセキュリティ問題のための[RFC3987]のセクション8が彼らの取り扱いと使用に関連するのを見てください。
Gregorio & de hOra Standards Track [Page 38] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[38ページ]RFC5023Atom出版プロトコル2007年10月
The Atom Publishing Protocol leaves the server in control of minting URIs. The use of any client-supplied data for creating new URIs is subject to the same concerns as described in the next section.
Atom出版プロトコルはハッカURIのコントロールにおけるサーバを残します。 どんなクライアントによって供給されたデータの新しいURIを作成する使用も次のセクションで説明されるのと同じ関心を必要としています。
15.7. Code Injection and Cross Site Scripting
15.7. コード注射とクロスサイトスクリプティング
Atom Feed and Entry Documents can contain a broad range of content types including code that might be executable in some contexts. Malicious clients could attempt to attack servers or other clients by injecting code into a Collection Document's Entry or Media Resources.
原子FeedとEntry Documentsはいくつかの文脈で実行可能であるかもしれないコードを含む広範囲なcontent typeを含むことができます。 悪意があるクライアントは、Collection DocumentのEntryかメディアResourcesにコードを注ぐことによってサーバか他のクライアントを攻撃するのを試みることができました。
Server implementations are strongly encouraged to verify that client- supplied content is safe prior to accepting, processing, or publishing it. In the case of HTML, experience indicates that verification based on a white list of acceptable content is more effective than a black list of forbidden content.
サーバ実装が、受諾、処理、またはそれを発行する前にクライアントの供給された内容が安全であることを確かめるよう強く奨励されます。 HTMLの場合では、経験は、許容できる内容に関するホワイトリストに基づく検証が禁制の内容のブラックリストより効果的であることを示します。
Additional information about XHTML and HTML content safety can be found in Section 8.1 of [RFC4287].
[RFC4287]のセクション8.1でXHTMLに関する追加情報とHTML内容安全を見つけることができます。
16. IANA Considerations
16. IANA問題
This specification uses two new media types that conform to the registry mechanism described in [RFC4288], a new message header that conforms to the registry mechanism described in [RFC3864], and two new link relations that conform to the registry mechanism described in [RFC4287].
この仕様は[RFC4288]で説明された登録メカニズムに従う2つのニューメディアタイプ、[RFC3864]で説明された登録メカニズムに従う新しいメッセージヘッダー、および[RFC4287]で説明された登録メカニズムに一致している2つの新しいリンク関係を使用します。
16.1. Content-Type Registration for 'application/atomcat+xml'
16.1. 'アプリケーション/atomcat+xml'のためのコンテントタイプ登録
An Atom Publishing Protocol Category Document, when serialized as XML 1.0, can be identified with the following media type:
XML1.0として連載されると、Atom出版プロトコルCategory Documentを以下のメディアタイプと同一視できます:
MIME media type name: application
MIMEメディア型名: アプリケーション
MIME subtype name: atomcat+xml
MIME「副-タイプ」は以下を命名します。 atomcat+xml
Required parameters: None.
必要なパラメタ: なし。
Optional parameters:
任意のパラメタ:
"charset": This parameter has identical semantics to the charset
parameter of the "application/xml" media type as specified in
[RFC3023].
"charset": このパラメタは[RFC3023]の指定されるとしての「アプリケーション/xml」メディアタイプのcharsetパラメタに同じ意味論を持っています。
Encoding considerations: Identical to those of "application/xml" as
described in [RFC3023], Section 3.2.
問題をコード化します: [RFC3023]、セクション3.2で説明される「アプリケーション/xml」のものと同じです。
Gregorio & de hOra Standards Track [Page 39] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[39ページ]RFC5023Atom出版プロトコル2007年10月
Security considerations: As defined in RFC 5023.
セキュリティ問題: RFC5023で定義されるように。
In addition, as this media type uses the "+xml" convention, it
shares the same security considerations as described in [RFC3023],
Section 10.
「このメディアとして、さらに、用途をタイプしてください、」 +は」 コンベンションをxmlして、[RFC3023]で説明されるのと同じセキュリティ問題を共有します、セクション10。
Interoperability considerations: There are no known interoperability
issues.
相互運用性問題: 相互運用性問題は知られていません。
Published specification: RFC 5023.
広められた仕様: RFC5023。
Applications that use this media type: No known applications
currently use this media type.
このメディアタイプを使用するアプリケーション: どんな知られているアプリケーションも現在、このメディアタイプを使用しません。
Additional information:
追加情報:
Magic number(s): As specified for "application/xml" in [RFC3023],
Section 3.2.
マジックナンバー(s): [RFC3023]の「アプリケーション/xml」に指定されるように、セクション3.2です。
File extension: .atomcat
ファイル拡張子: .atomcat
Fragment identifiers: As specified for "application/xml" in
[RFC3023], Section 5.
部分識別子: [RFC3023]の「アプリケーション/xml」に指定されるように、セクション5です。
Base URI: As specified in [RFC3023], Section 6.
URIを基礎づけてください: [RFC3023]で指定されるように、セクション6です。
Macintosh file type code: TEXT
マッキントッシュファイルの種類コード: テキスト
Person & email address to contact for further information:
Joe Gregorio <joe@bitworking.org>
詳細のために連絡する人とEメールアドレス: ジョー Gregorio <joe@bitworking.org 、gt。
Intended usage: COMMON
意図している用法: 一般的
Author/Change controller: IETF (iesg@ietf.org) Internet Engineering
Task Force
コントローラを書くか、または変えてください: IETF( iesg@ietf.org )インターネット・エンジニアリング・タスク・フォース
16.2. Content-Type Registration for 'application/atomsvc+xml'
16.2. 'アプリケーション/atomsvc+xml'のためのコンテントタイプ登録
An Atom Publishing Protocol Service Document, when serialized as XML 1.0, can be identified with the following media type:
XML1.0として連載されると、Atom出版プロトコルService Documentを以下のメディアタイプと同一視できます:
MIME media type name: application
MIMEメディア型名: アプリケーション
MIME subtype name: atomsvc+xml
MIME「副-タイプ」は以下を命名します。 atomsvc+xml
Required parameters: None.
必要なパラメタ: なし。
Gregorio & de hOra Standards Track [Page 40] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[40ページ]RFC5023Atom出版プロトコル2007年10月
Optional parameters:
任意のパラメタ:
"charset": This parameter has identical semantics to the charset
parameter of the "application/xml" media type as specified in
[RFC3023].
"charset": このパラメタは[RFC3023]の指定されるとしての「アプリケーション/xml」メディアタイプのcharsetパラメタに同じ意味論を持っています。
Encoding considerations: Identical to those of "application/xml" as
described in [RFC3023], Section 3.2.
問題をコード化します: [RFC3023]、セクション3.2で説明される「アプリケーション/xml」のものと同じです。
Security considerations: As defined in RFC 5023.
セキュリティ問題: RFC5023で定義されるように。
In addition, as this media type uses the "+xml" convention, it
shares the same security considerations as described in [RFC3023],
Section 10.
「このメディアとして、さらに、用途をタイプしてください、」 +は」 コンベンションをxmlして、[RFC3023]で説明されるのと同じセキュリティ問題を共有します、セクション10。
Interoperability considerations: There are no known interoperability
issues.
相互運用性問題: 相互運用性問題は知られていません。
Published specification: RFC 5023.
広められた仕様: RFC5023。
Applications that use this media type: No known applications
currently use this media type.
このメディアタイプを使用するアプリケーション: どんな知られているアプリケーションも現在、このメディアタイプを使用しません。
Additional information:
追加情報:
Magic number(s): As specified for "application/xml" in [RFC3023],
Section 3.2.
マジックナンバー(s): [RFC3023]の「アプリケーション/xml」に指定されるように、セクション3.2です。
File extension: .atomsvc
ファイル拡張子: .atomsvc
Fragment identifiers: As specified for "application/xml" in
[RFC3023], Section 5.
部分識別子: [RFC3023]の「アプリケーション/xml」に指定されるように、セクション5です。
Base URI: As specified in [RFC3023], Section 6.
URIを基礎づけてください: [RFC3023]で指定されるように、セクション6です。
Macintosh file type code: TEXT
マッキントッシュファイルの種類コード: テキスト
Person and email address to contact for further information: Joe
Gregorio <joe@bitworking.org>
詳細のために連絡する人とEメールアドレス: ジョー Gregorio <joe@bitworking.org 、gt。
Intended usage: COMMON
意図している用法: 一般的
Author/Change controller: IETF (iesg@ietf.org) Internet Engineering
Task Force
コントローラを書くか、または変えてください: IETF( iesg@ietf.org )インターネット・エンジニアリング・タスク・フォース
Gregorio & de hOra Standards Track [Page 41] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[41ページ]RFC5023Atom出版プロトコル2007年10月
16.3. Header Field Registration for 'SLUG'
16.3. 'スラグ'のためのヘッダーフィールド登録
Header field name: SLUG
ヘッダーフィールド名: スラグ
Applicable protocol: http [RFC2616]
適切なプロトコル: http[RFC2616]
Status: standard.
状態: 標準。
Author/Change controller: IETF (iesg@ietf.org) Internet Engineering
Task Force
コントローラを書くか、または変えてください: IETF( iesg@ietf.org )インターネット・エンジニアリング・タスク・フォース
Specification document(s): RFC 5023.
仕様ドキュメント: RFC5023。
Related information: None.
関連情報: なし。
16.4. The Link Relation Registration "edit"
16.4. リンク関係登録「編集」
Attribute Value: edit
値を結果と考えてください: 編集
Description: An IRI of an editable Member Entry. When appearing
within an atom:entry, the href IRI can be used to retrieve,
update, and delete the Resource represented by that Entry.
記述: 編集可能なメンバーEntryのIRI。 原子: エントリーの中に現れるとき、そのEntryによって表されたResourceを検索して、アップデートして、削除するのにhref IRIを使用できます。
Expected display characteristics: Undefined; this relation can be
used for background processing or to provide extended
functionality without displaying its value.
予想されたディスプレイの特性: 未定義。 バックグラウンド処理か値を表示しないで拡張機能性を提供するのにこの関係を使用できます。
Security considerations: Automated agents should take care when this
relation crosses administrative domains (e.g., the URI has a
different authority than the current document).
セキュリティ問題: この関係が管理ドメインに交差するとき(例えば、URIには、現在のドキュメントと異なった権威があります)、自動化されたエージェントは注意するべきです。
16.5. The Link Relation Registration "edit-media"
16.5. リンク関係登録「編集メディア」
Attribute Value: edit-media
値を結果と考えてください: 編集メディア
Description: An IRI of an editable Media Resource. When appearing
within an atom:entry, the href IRI can be used to retrieve,
update, and delete the Media Resource associated with that Entry.
記述: 編集可能なメディアResourceのIRI。 原子: エントリーの中に現れるとき、ResourceがそのEntryに関連づけたメディアを検索して、アップデートして、削除するのにhref IRIを使用できます。
Expected display characteristics: Undefined; this relation can be
used for background processing or to provide extended
functionality without displaying its value.
予想されたディスプレイの特性: 未定義。 バックグラウンド処理か値を表示しないで拡張機能性を提供するのにこの関係を使用できます。
Security considerations: Automated agents should take care when this
relation crosses administrative domains (e.g., the URI has a
different authority than the current document).
セキュリティ問題: この関係が管理ドメインに交差するとき(例えば、URIには、現在のドキュメントと異なった権威があります)、自動化されたエージェントは注意するべきです。
Gregorio & de hOra Standards Track [Page 42] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[42ページ]RFC5023Atom出版プロトコル2007年10月
16.6. The Atom Format Media Type Parameter
16.6. 原子形式メディア型引数
IANA has added a reference to this specification in the 'application/atom+xml' media type registration.
IANAは、'アプリケーション/原子+xml'メディアによるこの仕様の参照が登録をタイプすると言い足しました。
17. References
17. 参照
17.1. Normative References
17.1. 引用規格
[REC-xml] Yergeau, F., Paoli, J., Bray, T., Sperberg-McQueen, C.,
and E. Maler, "Extensible Markup Language (XML) 1.0
(Fourth Edition)", World Wide Web Consortium
Recommendation REC-xml-20060816, August 2006,
<http://www.w3.org/TR/2006/REC-xml-20060816>.
[REC-xml]Yergeau、F.、T.、Sperberg-マックィーン、C.、およびE.Maler、「拡張マークアップ言語(XML)1.0(第4版)」をパオリ、J.はいななかせます、ワールドワイドウェブコンソーシアム推薦REC-xml-20060816、2006年8月、<http://www.w3.org/TR/2006/REC-xml-20060816>。
[REC-xml-infoset]
Cowan, J. and R. Tobin, "XML Information Set (Second
Edition)", World Wide Web Consortium Recommendation REC-
xml-infoset-20040204, February 2004,
<http://www.w3.org/TR/2004/REC-xml-infoset-20040204>.
[REC-xml-infoset] カウァン、J.、およびR.トビン、「XML情報はセット(第2版)でした」、ワールドワイドウェブコンソーシアムRecommendation REC- xml-infoset-20040204、2004年2月、<http://www.w3.org/TR/2004/REC-xml-infoset-20040204>。
[REC-xml-names]
Hollander, D., Bray, T., Tobin, R., and A. Layman,
"Namespaces in XML 1.0 (Second Edition)", World Wide Web
Consortium Recommendation REC-xml-names-20060816, August
2006, <http://www.w3.org/TR/2006/REC-xml-names-20060816>.
[REC-xml-名前] オランダ人、D.は、T.、トビン、R.、およびA.俗人、「XML1.0(第2版)の名前空間」をいななかせます、ワールドワイドウェブコンソーシアム推薦REC-xml名20060816、2006年8月、<http://www.w3.org/TR/2006/REC-xml名前-20060816>。
[REC-xmlbase]
Marsh, J., "XML Base", W3C REC W3C.REC-xmlbase-20010627,
June 2001,
<http://www.w3.org/TR/2001/REC-xmlbase-20010627>.
[REC-xmlbase] 沼地、J.、「XML基地」、W3C REC W3C. REC-xmlbase-20010627、<http://www.w3.org/TR/2001/REC-xmlbase-20010627 2001年6月の>。
[REC-xmldsig-core]
Solo, D., Reagle, J., and D. Eastlake, "XML-Signature
Syntax and Processing", World Wide Web Consortium
Recommendation REC-xmldsig-core-20020212, February 2002,
<http://www.w3.org/TR/2002/REC-xmldsig-core-20020212>.
ワールドワイドウェブコンソーシアム推薦REC-xmldsigコア20020212、<http://www.w3.org/TR/2002/REC-xmldsig2002年2月の[REC-xmldsig-コア]の独奏、D.、Reagle、J.、D.イーストレーク、および「XML-署名構文と処理」、--20020212>の芯を取ってください。
[REC-xmlenc-core]
Eastlake, D. and J. Reagle, "XML Encryption Syntax and
Processing", World Wide Web Consortium Recommendation REC-
xmlenc-core-20021210, December 2002,
<http://www.w3.org/TR/2002/REC-xmlenc-core-20021210>.
ワールドワイドウェブコンソーシアムRecommendation REC- xmlencコア20021210、<http://www.w3.org/TR/2002/REC-xmlenc2002年12月の[REC-xmlenc-コア]のイーストレーク、D.、J.Reagle、および「XML暗号化構文と処理」、--20021210>の芯を取ってください。
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC2119] ブラドナー、S.、「Indicate Requirement LevelsへのRFCsにおける使用のためのキーワード」、BCP14、RFC2119、1997年3月。
Gregorio & de hOra Standards Track [Page 43] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[43ページ]RFC5023Atom出版プロトコル2007年10月
[RFC2246] Dierks, T. and C. Allen, "The TLS Protocol Version 1.0",
RFC 2246, January 1999.
[RFC2246] Dierks、T.、およびC.アレン、「TLSは1999年1月にバージョン1インチ、RFC2246について議定書の中で述べます」。
[RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999.
[RFC2616] フィールディング、R.、Gettys、J.、ムガール人、J.、Frystyk、H.、Masinter、L.、リーチ、P.、およびT.バーナーズ・リー、「HTTP/1.1インチ、RFC2616、1999年ハイパーテキスト転送プロトコル--6月。」
[RFC2617] Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence, S.,
Leach, P., Luotonen, A., and L. Stewart, "HTTP
Authentication: Basic and Digest Access Authentication",
RFC 2617, June 1999.
[RFC2617] フランクス、J.、ハラム-ベイカー、P.、Hostetler、J.、ローレンス、S.、リーチ、P.、Luotonen、A.、およびL.スチュワート、「HTTP認証:」 「基本的、そして、ダイジェストアクセス認証」、RFC2617、1999年6月。
[RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000.
[RFC2818]レスコラ(E.、「TLSの上のHTTP」、RFC2818)は2000がそうするかもしれません。
[RFC3023] Murata, M., St. Laurent, S., and D. Kohn, "XML Media
Types", RFC 3023, January 2001.
[RFC3023] ムラタとM.と聖ローラン、S.とD.コーン、「XMLメディアタイプ」、RFC3023、2001年1月。
[RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, RFC 3629, November 2003.
[RFC3629]Yergeau、F.、「UTF-8、ISO10646の変換形式」STD63、RFC3629、11月2003日
[RFC3864] Klyne, G., Nottingham, M., and J. Mogul, "Registration
Procedures for Message Header Fields", BCP 90, RFC 3864,
September 2004.
[RFC3864]KlyneとG.とノッティンガム、M.とJ.ムガール人、「メッセージヘッダーフィールドのための登録手順」BCP90、2004年9月のRFC3864。
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66, RFC
3986, January 2005.
[RFC3986] バーナーズ・リー、T.、フィールディング、R.、およびL.Masinter、「Uniform Resource Identifier(URI):」 「ジェネリック構文」、STD66、RFC3986、2005年1月。
[RFC3987] Duerst, M. and M. Suignard, "Internationalized Resource
Identifiers (IRIs)", RFC 3987, January 2005.
[RFC3987] DuerstとM.とM.Suignard、「国際化しているリソース識別子(虹彩)」、RFC3987、2005年1月。
[RFC4287] Nottingham, M. and R. Sayre, "The Atom Syndication
Format", RFC 4287, December 2005.
[RFC4287] ノッティンガムとM.とR.セアー、「原子シンジケート組織化形式」、RFC4287、2005年12月。
[RFC4288] Freed, N. and J. Klensin, "Media Type Specifications and
Registration Procedures", BCP 13, RFC 4288, December 2005.
解放された[RFC4288]とN.とJ.Klensin、「メディアは仕様と登録手順をタイプする」BCP13、RFC4288、2005年12月。
[RFC4346] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.1", RFC 4346, April 2006.
[RFC4346] Dierks、T.、およびE.レスコラ、「トランスポート層セキュリティ(TLS)は2006年4月にバージョン1.1インチ、RFC4346について議定書の中で述べます」。
17.2. Informative References
17.2. 有益な参照
[NOTE-detect-lost-update]
Nielsen, H. and D. LaLiberte, "Editing the Web: Detecting
the Lost Update Problem Using Unreserved Checkout", World
Wide Web Consortium NOTE NOTE-detect-lost-update, May
1999, <http://www.w3.org/1999/04/Editing/>.
[無くなっているアップデートを検出するように注意してください] ニールセン、H.、およびD.LaLiberte、「ウェブを編集します:」 「無遠慮なチェックアウトを使用することにおける無くなっているアップデート問題を検出し」て、WWW共同体は、1999年5月に無くなっているアップデートを検出するように注意するように注意して、<http://www.w3.org/1999/04/Editing/は>です。
Gregorio & de hOra Standards Track [Page 44] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[44ページ]RFC5023Atom出版プロトコル2007年10月
[REC-webarch]
Walsh, N. and I. Jacobs, "Architecture of the World Wide
Web, Volume One", W3C REC REC-webarch-20041215, December
2004, <http://www.w3.org/TR/2004/REC-webarch-20041215>.
[REC-webarch]ウォルシュ、N.とI.ジェイコブズ、「World Wide Web、第1巻のアーキテクチャ」W3C REC REC-webarch-20041215、<http://www.w3.org/TR/2004/REC-webarch-20041215 2004年12月の>。
[RNC] Clark, J., "RELAX NG Compact Syntax", December 2001,
<http://www.oasis-open.org/committees/relax-ng/
compact-20021121.html>.
[RNC] クラーク、J.、「RELAX NGのコンパクトな構文」2001年12月のngを弛緩しているか、コンパクトな<http://www.oasis-open.org/委員会/20021121.htmlの>。
Gregorio & de hOra Standards Track [Page 45] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[45ページ]RFC5023Atom出版プロトコル2007年10月
Appendix A. Contributors
付録A.貢献者
The content and concepts within are a product of the Atom community and the Atompub Working Group.
内容と概念は中のAtom共同体とAtompub作業部会の製品です。
Appendix B. RELAX NG Compact Schema
付録B.はNGのコンパクトな図式を弛緩します。
This appendix is informative.
この付録は有益です。
The Relax NG schema explicitly excludes elements in the Atom Protocol namespace that are not defined in this revision of the specification. Requirements for Atom Protocol processors encountering such markup are given in Sections 6.2 and 6.3 of [RFC4287].
Relax NG図式は明らかにAtomプロトコル名前空間における仕様のこの改正で定義されない要素を除きます。 セクション6.2と6.3でそのようなマーク付けに遭遇するAtomプロトコルプロセッサのための要件に[RFC4287]を与えます。
The Schema for Service Documents:
サービスドキュメントのための図式:
# -*- rnc -*- # RELAX NG Compact Syntax Grammar for the Atom Protocol
# -*- Atomプロトコルのためのrnc-*#RELAX NG Compact Syntax Grammar
namespace app = "http://www.w3.org/2007/app" namespace atom = "http://www.w3.org/2005/Atom" namespace xsd = "http://www.w3.org/2001/XMLSchema" namespace xhtml = "http://www.w3.org/1999/xhtml" namespace local = ""
" http://www.w3.org/2007/app "名前空間名前空間装置=原子が" http://www.w3.org/2005/Atom "名前空間xsd=" http://www.w3.org/2001/XMLSchema "名前空間xhtml=" http://www.w3.org/1999/xhtml "名前空間地方の=と等しい、「」
start = appService
=appServiceを始動してください。
# common:attrs
# コモン: attrs
atomURI = text
atomURIはテキストと等しいです。
appCommonAttributes =
attribute xml:base { atomURI }?,
attribute xml:lang { atomLanguageTag }?,
attribute xml:space {"default"|"preserved"}?,
undefinedAttribute*
undefinedAttribute*、appCommonAttributesは属性xml: ベースatomURI(xmlを結果と考えてください: lang atomLanguageTag、xmlを結果と考えてください: 「デフォルト」| 「保存」を区切る)と等しいです。
atomCommonAttributes = appCommonAttributes
atomCommonAttributesはappCommonAttributesと等しいです。
undefinedAttribute = attribute * - (xml:base | xml:space | xml:lang
| local:*) { text }
undefinedAttributeは属性*と等しいです--(xml: ベース|xml:スペース|xml:lang|ローカル:*)テキスト
atomLanguageTag = xsd:string {
pattern = "([A-Za-z]{1,8}(-[A-Za-z0-9]{1,8})*)?"
}
atomLanguageTag=xsd: ストリング=を型に基づいて作ってください、「1、[A-Za-z]8、(-、[A-Za-z0-9] 1、8)*)、--、」
Gregorio & de hOra Standards Track [Page 46] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[46ページ]RFC5023Atom出版プロトコル2007年10月
atomDateConstruct =
appCommonAttributes,
xsd:dateTime
appCommonAttributes、atomDateConstruct=xsd: dateTime
# app:service
appService =
element app:service {
appCommonAttributes,
( appWorkspace+
& extensionElement* )
}
# 装置: サービスappServiceは要素装置: サービスと等しいです。appCommonAttributesと、(appWorkspace+とextensionElement*)
# app:workspace
# 装置: ワークスペース
appWorkspace =
element app:workspace {
appCommonAttributes,
( atomTitle
& appCollection*
& extensionSansTitleElement* )
}
要素appWorkspace=装置: ワークスペースappCommonAttributesと、(atomTitle&appCollection*とextensionSansTitleElement*)
atomTitle = element atom:title { atomTextConstruct }
要素atomTitle=原子: タイトルatomTextConstruct
# app:collection
# 装置: 収集
appCollection =
element app:collection {
appCommonAttributes,
attribute href { atomURI },
( atomTitle
& appAccept*
& appCategories*
& extensionSansTitleElement* )
}
要素appCollection=装置: 収集appCommonAttributesと、属性href atomURIと、(atomTitle&appAccept*、appCategories*、およびextensionSansTitleElement*)
# app:categories
# 装置: カテゴリ
atomCategory =
element atom:category {
atomCommonAttributes,
attribute term { text },
attribute scheme { atomURI }?,
attribute label { text }?,
undefinedContent
}
要素atomCategory=原子: カテゴリundefinedContent、atomCommonAttributes(属性用語テキスト)は体系atomURI(属性はテキストを分類する)を結果と考えます。
Gregorio & de hOra Standards Track [Page 47] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[47ページ]RFC5023Atom出版プロトコル2007年10月
appInlineCategories =
element app:categories {
attribute fixed { "yes" | "no" }?,
attribute scheme { atomURI }?,
(atomCategory*,
undefinedContent)
}
要素appInlineCategories=装置: カテゴリ「はい」| 「いいえ」(体系atomURIを結果と考える)、(atomCategory*、undefinedContent)が修理された属性
appOutOfLineCategories =
element app:categories {
attribute href { atomURI },
undefinedContent
}
要素appOutOfLineCategories=装置: カテゴリ属性href atomURI、undefinedContent
appCategories = appInlineCategories | appOutOfLineCategories
appCategoriesはappInlineCategoriesと等しいです。| appOutOfLineCategories
# app:accept
# 装置: 受け入れてください。
appAccept =
element app:accept {
appCommonAttributes,
( text? )
}
appAcceptは要素装置と等しいです: 受け入れてください。{ appCommonAttributes、(テキスト? ) }
# Simple Extension
# 単純拡大
simpleSansTitleExtensionElement =
element * - (app:*|atom:title) {
text
}
simpleSansTitleExtensionElement=要素*--(装置: *|原子:タイトル)テキスト
simpleExtensionElement =
element * - (app:*) {
text
}
simpleExtensionElementは要素*と等しいです--(装置: *)テキスト
# Structured Extension
# 構造化された拡大
structuredSansTitleExtensionElement =
element * - (app:*|atom:title) {
(attribute * { text }+,
(text|anyElement)*)
| (attribute * { text }*,
(text?, anyElement+, (text|anyElement)*))
}
structuredSansTitleExtensionElement=要素*--(装置: *|原子:タイトル)(*テキストを結果と考えてください、+、(テキスト| anyElement) *)|、(*テキストを結果と考えてください、*、(テキスト?、anyElement+、(テキスト| anyElement) *)
Gregorio & de hOra Standards Track [Page 48] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[48ページ]RFC5023Atom出版プロトコル2007年10月
structuredExtensionElement =
element * - (app:*) {
(attribute * { text }+,
(text|anyElement)*)
| (attribute * { text }*,
(text?, anyElement+, (text|anyElement)*))
}
structuredExtensionElementは要素*と等しいです--(装置: *)(*テキストを結果と考えてください、+、(テキスト| anyElement) *)|、(*テキストを結果と考えてください、*、(テキスト?、anyElement+、(テキスト| anyElement) *)
# Other Extensibility
# 他の伸展性
extensionSansTitleElement =
simpleSansTitleExtensionElement|structuredSansTitleExtensionElement
extensionSansTitleElementはsimpleSansTitleExtensionElementと等しいです。|structuredSansTitleExtensionElement
extensionElement = simpleExtensionElement |
structuredExtensionElement
extensionElementはsimpleExtensionElementと等しいです。| structuredExtensionElement
undefinedContent = (text|anyForeignElement)*
undefinedContentは*と等しいです(テキスト| anyForeignElement)。
# Extensions
# 拡大
anyElement =
element * {
(attribute * { text }
| text
| anyElement)*
}
anyElementは要素*と等しいです。(属性*テキスト| テキスト| anyElement)*
anyForeignElement =
element * - app:* {
(attribute * { text }
| text
| anyElement)*
}
anyForeignElementは要素*と等しいです--装置: *(属性*テキスト| テキスト| anyElement)*
atomPlainTextConstruct =
atomCommonAttributes,
attribute type { "text" | "html" }?,
text
「テキスト」| atomPlainTextConstruct=atomCommonAttributes、属性タイプ"html?"、テキスト
atomXHTMLTextConstruct =
atomCommonAttributes,
attribute type { "xhtml" },
xhtmlDiv
atomXHTMLTextConstructはatomCommonAttributes、属性タイプ"xhtml"xhtmlDivと等しいです。
atomTextConstruct = atomPlainTextConstruct | atomXHTMLTextConstruct
atomTextConstructはatomPlainTextConstructと等しいです。| atomXHTMLTextConstruct
Gregorio & de hOra Standards Track [Page 49] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[49ページ]RFC5023Atom出版プロトコル2007年10月
anyXHTML = element xhtml:* {
(attribute * { text }
| text
| anyXHTML)*
}
anyXHTMLは要素xhtmlと等しいです: *(属性*テキスト| テキスト| anyXHTML)*
xhtmlDiv = element xhtml:div {
(attribute * { text }
| text
| anyXHTML)*
}
xhtmlDiv=要素xhtml: div(属性*テキスト| テキスト| anyXHTML)*
# EOF
# EOF
The Schema for Category Documents:
カテゴリドキュメントのための図式:
# -*- rnc -*- # RELAX NG Compact Syntax Grammar for the Atom Protocol
# -*- Atomプロトコルのためのrnc-*#RELAX NG Compact Syntax Grammar
namespace app = "http://www.w3.org/2007/app" namespace atom = "http://www.w3.org/2005/Atom" namespace xsd = "http://www.w3.org/2001/XMLSchema" namespace local = ""
" http://www.w3.org/2007/app "名前空間名前空間装置=原子が" http://www.w3.org/2005/Atom "名前空間xsd=" http://www.w3.org/2001/XMLSchema "名前空間地方の=と等しい、「」
start = appCategories
=appCategoriesを始動してください。
atomCommonAttributes =
attribute xml:base { atomURI }?,
attribute xml:lang { atomLanguageTag }?,
undefinedAttribute*
undefinedAttribute*、atomCommonAttributes=はxml: ベースatomURIを結果と考えて、xml: lang atomLanguageTagを結果と考えます。
undefinedAttribute = attribute * - (xml:base | xml:lang | local:*) {
text }
undefinedAttributeは属性*と等しいです--(xml: ベース|xml:lang|ローカル:*)テキスト
atomURI = text
atomURIはテキストと等しいです。
atomLanguageTag = xsd:string {
pattern = "([A-Za-z]{1,8}(-[A-Za-z0-9]{1,8})*)?"
}
atomLanguageTag=xsd: ストリング=を型に基づいて作ってください、「1、[A-Za-z]8、(-、[A-Za-z0-9] 1、8)*)、--、」
atomCategory =
element atom:category {
atomCommonAttributes,
attribute term { text },
attribute scheme { atomURI }?,
attribute label { text }?,
undefinedContent
}
要素atomCategory=原子: カテゴリundefinedContent、atomCommonAttributes(属性用語テキスト)は体系atomURI(属性はテキストを分類する)を結果と考えます。
Gregorio & de hOra Standards Track [Page 50] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[50ページ]RFC5023Atom出版プロトコル2007年10月
appInlineCategories =
element app:categories {
attribute fixed { "yes" | "no" }?,
attribute scheme { atomURI }?,
(atomCategory*,
undefinedContent)
}
要素appInlineCategories=装置: カテゴリ「はい」| 「いいえ」(体系atomURIを結果と考える)、(atomCategory*、undefinedContent)が修理された属性
appOutOfLineCategories =
element app:categories {
attribute href { atomURI },
(empty)
}
要素appOutOfLineCategories=装置: カテゴリ属性href atomURIと、(空)です。
appCategories = appInlineCategories | appOutOfLineCategories
appCategoriesはappInlineCategoriesと等しいです。| appOutOfLineCategories
# Extensibility
# 伸展性
undefinedContent = (text|anyForeignElement)*
undefinedContentは*と等しいです(テキスト| anyForeignElement)。
anyElement =
element * {
(attribute * { text }
| text
| anyElement)*
}
anyElementは要素*と等しいです。(属性*テキスト| テキスト| anyElement)*
anyForeignElement =
element * - atom:* {
(attribute * { text }
| text
| anyElement)*
}
anyForeignElementは要素*と等しいです--原子: *(属性*テキスト| テキスト| anyElement)*
# EOF
# EOF
Gregorio & de hOra Standards Track [Page 51] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[51ページ]RFC5023Atom出版プロトコル2007年10月
Authors' Addresses
作者のアドレス
Joe Gregorio (editor) Google
ジョーグレゴリオ(エディタ)Google
EMail: joe@bitworking.org URI: http://bitworking.org/
メール: joe@bitworking.org ユリ: http://bitworking.org/
Bill de hOra (editor) NewBay Software
ビルde hOra(エディタ)NewBay Software
EMail: bill@dehora.net URI: http://dehora.net/
メール: bill@dehora.net ユリ: http://dehora.net/
Gregorio & de hOra Standards Track [Page 52] RFC 5023 The Atom Publishing Protocol October 2007
グレゴリオとde hOra Standards Track[52ページ]RFC5023Atom出版プロトコル2007年10月
Full Copyright Statement
完全な著作権宣言文
Copyright (C) The IETF Trust (2007).
IETFが信じる著作権(C)(2007)。
This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights.
このドキュメントはBCP78に含まれた権利、ライセンス、および制限を受けることがあります、そして、そこに詳しく説明されるのを除いて、作者は彼らのすべての権利を保有します。
This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
このドキュメントとここに含まれた情報はその人が代理をするか、または(もしあれば)後援される組織、インターネットの振興発展を目的とする組織、「そのままで」という基礎と貢献者の上で提供していて、IETFはそして、インターネット・エンジニアリング・タスク・フォースがすべての保証を放棄すると信じます、急行である、または暗示していて、他を含んでいて、情報の使用がここに侵害しないどんな保証も少しもまっすぐになるということであるかいずれが市場性か特定目的への適合性の黙示的な保証です。
Intellectual Property
知的所有権
The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79.
IETFはどんなIntellectual Property Rightsの正当性か範囲、実装に関係すると主張されるかもしれない他の権利、本書では説明された技術の使用またはそのような権利の下におけるどんなライセンスも利用可能であるかもしれない、または利用可能でないかもしれない範囲に関しても立場を全く取りません。 または、それはそれを表しません。どんなそのような権利も特定するどんな独立している取り組みも作りました。 BCP78とBCP79でRFCドキュメントの権利に関する手順に関する情報を見つけることができます。
Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr.
IPR公開のコピーが利用可能に作られるべきライセンスの保証、または一般的な免許を取得するのが作られた試みの結果をIETF事務局といずれにもしたか、または http://www.ietf.org/ipr のIETFのオンラインIPR倉庫からこの仕様のimplementersかユーザによるそのような所有権の使用のために許可を得ることができます。
The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org.
IETFはこの規格を実装するのに必要であるかもしれない技術をカバーするかもしれないどんな著作権もその注目していただくどんな利害関係者、特許、特許出願、または他の所有権も招待します。 ietf-ipr@ietf.org のIETFに情報を扱ってください。
Gregorio & de hOra Standards Track [Page 53]
グレゴリオとde hOra Standards Track[53ページ]
一覧
スポンサーリンク
