<atom:feed> element

The <atom:feed> element in an Atom configuration file is a prototype for the Atom feed document that CICS® returns. It provides the metadata for the Atom feed, and contains a single prototype <atom:entry> element.

Contained by:

Child elements

The child elements of the <atom:feed> element are as defined by the Atom format specification in RFC 4287. Some of the child elements are required and some of them are optional.

RFC 4287 permits plain text, HTML, or XHTML content for child elements that are defined as "text constructs", such as the <atom:title> element. CICS only supports plain text content for these elements, so you cannot use a "type" attribute to specify an alternative content type. You must supply plain text content with no child elements. CICS does permit HTML, XHTML, and other text media types (such as XML) in the <atom:content> element as content for Atom entries, which you specify in the CICS resource that provides data for the Atom entries.

The child elements for the <atom:feed> element are as follows:
<atom:author>
The personal details of the principal author of the Atom feed, which might be an individual person or an organization. You can have more than one <atom:author>element in the configuration file. The data is provided in child elements as follows:
<atom:name>
The name of the person. This child element is required if you are specifying the <atom:author> element, and CICS checks that you include it.
<atom:uri>
An URL associated with the person, such as a blog site or a company website. This child element is optional. CICS checks that you do not specify more than one <atom:uri> element in an <atom:author> element. CICS does not attempt to verify that the URL is valid, so you must ensure that it is correct.
<atom:email>
The e-mail address of the person. This child element is optional. CICS checks that you do not specify more than one <atom:email> element in an <atom:author> element.
The <atom:author> element is optional. If you choose not to specify the <atom:author> element anywhere in your configuration file, you must ensure that all the Atom entries in your resource include this data, in order to be compliant with RFC 4287.
<atom:category term=" ">
The name of a category that classifies the Atom feed. This element is optional. CICS only supports a single instance of this element. The term attribute specifies the name of the category.
<atom:contributor>
The personal details of a subsidiary author of the Atom feed. This element is optional. You can have more than one of this element in the configuration file. The data is provided in child elements as follows:
<atom:name>
The name of the person. This child element is required when you use the <atom:contributor> element.
<atom:uri>
An URL associated with the person, such as a blog site or a company website. This child element is optional.
<atom:email>
The e-mail address of the person. This child element is optional.
<atom:entry>
In an Atom configuration file, you need a single prototype <atom:entry> element. The description of this element is in <atom:entry> Atom configuration file element.
<atom:generator>
The name of the agent that generates the Atom feed. Do not specify this element in the Atom configuration file; CICS provides it when composing the Atom feed document. CICS provides an identification of itself as the generator of the Atom feed.
<atom:icon>
An URL that points to a small icon representing the Atom feed. This element is optional. CICS checks that you do not specify more than one <atom:icon> element for the Atom feed, but does not check the aspect ratio of the image, which should be 1 (horizontal) to 1 (vertical).
<atom:id>
The unique identifier for the Atom feed. The Atom format specification requires one <atom:id> element for the Atom feed. If you specified the <cics:authority> element in the Atom configuration file to make CICS generate tag URIs as Atom IDs, you can omit the <atom:id> element for the Atom feed, and CICS generates an Atom ID for the Atom feed in the same format as for the Atom entries, but without the selector value or unique identifier that is appended for the Atom entries. For example:
tag:example.com,2009-01-08:tsqueue:WB20TSQ
If you prefer an alternative Atom ID format, or if you are using the <atom:id> element in the prototype Atom entry to specify an Atom ID format and you want to copy this, include the <atom:id> element for the Atom feed and specify a complete Atom ID for the Atom feed. Make sure that the Atom ID is unique and meets the requirements of the Atom format specification in RFC 4287.
<atom:link>
A URL that identifies the Atom feed document and enables web clients to retrieve it. URLs for Atom feeds from CICS explains how to construct this URL.

An Atom feed document must have a single <atom:link rel="self"> element as a child element of the <atom:feed> element. The href attribute contains a URL that web clients can use to retrieve the Atom feed document. CICS does not provide support for other types of <atom:link> element for Atom feed documents.

In your Atom configuration file, the <atom:link rel="self"> element must state the complete path that web clients can use to retrieve the Atom feed document, with the beginning of the path matching the partial path that you stated in the URIMAP resource definition for the Atom feed or collection. For example, if you specified /myatomfeed/* as the path component in the URIMAP resource definition, you could specify <atom:link rel="self" href="/myatomfeed/feed.atom"> in the Atom configuration file. The limits on URL length listed in URLs for CICS Web support apply also to URLs for Atom feeds.

In the Atom configuration file, you may omit the scheme and host components of the URL, and specify only the path component. CICS adds the scheme and host components to the URL when it returns the Atom feed or Atom entry document to the client, to comply with the Atom format specification.

<atom:logo>
An URL that points to a larger logo representing the Atom feed. This element is optional. CICS checks that you do not specify more than one <atom:logo> element for the Atom feed, but does not check the aspect ratio of the image, which should be 2 (horizontal) to 1 (vertical).
<atom:rights>
A text string that contains the claimed intellectual property rights, such as copyright. CICS only supports plain text for this element. This element is optional.
<atom:subtitle>
The subtitle for the Atom feed. CICS only supports plain text for subtitles. This element is optional. CICS checks that you do not specify more than one <atom:subtitle> element for the Atom feed.
<atom:title>
The title for the Atom feed. CICS only supports plain text for titles. You must specify a <atom:title> element to comply with RFC 4287. CICS checks that you do not specify more than one <atom:title> element.
<atom:updated>
The time at which the Atom feed was last updated. Do not specify this element in the Atom configuration file; CICS provides it when composing the Atom feed document. CICS supplies this timestamp as the most recent of all the <atom:updated> elements of the enclosed <atom:entry> elements that make up the Atom feed. If the CICS resource containing the Atom entries does not provide this data, CICS defaults to the current date and time.

Contains:

Example

   <atom:feed>
       <atom:title>CICS Atom feed</atom:title>
       <atom:subtitle>My first Atom feed from CICS</atom:subtitle>
       <atom:link rel="self" href="/web20/sample_atom_feed" />
       <atom:rights>Copyright (c) 2009, Joe Bloggs</atom:rights>
       <atom:author>
            <atom:name>Joe Bloggs</atom:name>
            <atom:uri>http://www.ibm.com/JBloggs/</atom:uri>
            <atom:email>JBloggs@uk.ibm.com</atom:email>
        </atom:author>
        <atom:contributor>
            <atom:name>John Doe</atom:name>
        </atom:contributor>
 </atom:feed>