W2AP - Web2.0 DFHATOMPARMS container

      CONTROL BLOCK NAME = DFHW2APC
      DESCRIPTIVE NAME = CICS TS (W2) DFHATOMPARMS container
           Licensed Materials - Property of IBM
            Restricted Materials of IBM 
           5655-Y04
           (C) Copyright IBM Corp. 2008 
      FUNCTION = Mapping of DFHATOMPARMS container passed to
                 resource-dependent Atom service routines.
      NOTES :
       DEPENDENCIES = z/Arch
       RESTRICTIONS =
       MODULE TYPE = Control block definition
     ------------------------------------------------------------------
       DFHATOMPARMS container
       This copybook contains a mapping of fields in the DFHATOMPARMS
       container, which is intended to be used at the parameter list
       for the resource-dependent service routine called by the
       Atomservice feed manager.
       ATMP_OPTIONS
         Address of a double word containing 64 option bits.
         The first word is used to send options to the service routine,
         and the second word is used to receive options from the
         service routine.
       ATMP_RESPONSE
         Address of a double word in which the response and reason
         code can be returned. These are both initialized to zero,
         indicating successful completion.
       ATMP_RESNAME
         Address of a double word containing a pointer to the CICS
         resource name, followed by its length.
       ATMP_RESTYPE
         Address of a double word containing a pointer to the CICS
         resource type name in uppercase, followed by its length.
         The type can be PROGRAM, FILE, or TSQUEUE.
       ATMP_ATOMTYPE
         Address of a double word containing a pointer to the type of
         Atom document being processed, in lowercase, followed by its
         length. The value of the type string is either "entry" or
         "feed".
       ATMP_ATOMID
         Address of a triple word containing the address of a buffer
         containing Atom request identifier from the atom:id element,
         followed by its length, followed by the total length of the
         containing buffer. When handling a POST request, you can use
         this buffer to return a new atom id to represent the newly
         constructed resource.
       ATMP_HTTPMETH
         Address of a double word containing a pointer to the HTTP
         method padded with spaces, followed by its length.
         It is one of GET, POST, PUT or DELETE.
       ATMP_TAG_AUTHORITY
         Address of a double word containing a pointer to a URI
         authority name, followed by its length. The authority name
         is a host name or email address that can be can be used by
         the service routine to construct tag scheme URIs as described
         in RFC4151.
       ATMP_TAG_DATE
         Address of a double word containing a pointer to a date
         associated with ATMP_TAG_AUTHORITY, followed by its length.
         The date is in ISO8601 format (YYYY-MM-DD) and is a date at
         which this system is permitted to use the authority named
         in ATMP_TAG_AUTHORITY for minting tag scheme URIs.
       ATMP_XMLTRANSFORM
         Address of a double word containing a pointer to the name
         of an XMLTRANSFORM resource, followed by its length. The
         XMLTRANSFORM resource describes the layout of records within
         the CICS resource being externalized in the feed. If the
         length of this name is zero, it indicates that no bindfile
         was specified for the resource, and the service routine must
         perform its own mapping.
       ATMP_ROOT_ELEMENT
         Address of a double word containing a pointer to the name
         of the root element of the XML structure being mapped by the
         XMLTRANSFORM resource, followed by its length.
       ATMP_MTYPEIN
         Address of a double word containing a pointer to the
          mediatype of the incoming HTTP request body, if any,
         followed by its length. It is only meaningful if the HTTP
         method is POST or PUT, otherwise the pointer and length are
         both zero.
       ATMP_MTYPEOUT
         Address of a double word containing a pointer to an area in
         which the routine must return the mediatype of the data being
         returned in the DFHATOMCONTENT container, followed by the
         length of that area (56 bytes). On entry to the service
         routine, this area contains the requested content type:
         "text", "html", "xhtml", or a mediatype such as "text/xml",
         that can be used to control the format of document returned.
       ATMP_PUBLISHED
         Address of a double word containing a pointer to an area in
         which the routine must return the date and time at which the
         returned document was first published, followed by the length
         of that area (32 bytes). The value must be returned in
         xs:dateTime format, which is the same as RFC3339 format,
         (namely yyyy-mm-ddThh:mm:ss.fffZ) or as spaces.
         The .fff fractional seconds are optional, and may be omitted.
         If spaces are returned, the current time is assumed.
       ATMP_UPDATED
         Address of a double word containing a pointer to an area in
         which the routine must return the date and time at which the
         returned document was last updated, followed by the length of
         that area (32 bytes). The value must be returned in
         xs:dateTime format, which is the same as RFC3339 format,
         (namely yyyy-mm-ddThh:mm:ss.fffZ) or as spaces.
         The .fff fractional seconds are optional, and may be omitted.
         If spaces are returned, the current time is assumed.
       ATMP_EDITED
         Address of a double word containing a pointer to an area in
         which the routine must return the date and time at which the
         returned document was last edited, followed by the length of
         that area (32 bytes). The value must be returned in
         xs:dateTime format, which is the same as RFC3339 format,
         (namely yyyy-mm-ddThh:mm:ss.fffZ) or as spaces.
         The .fff fractional seconds are optional, and may be omitted.
         If spaces are returned, the current time is assumed.
       ATMP_ETAGVAL
         Address of a double word containing a pointer to the Etag
         value for the selected record, followed by its length.
         The Etag (or entity tag) is any string that can be used to
         identify the record instance uniquely.
       ATMP_WINSIZE
         Address of a double word containing a pointer to the feed
         window size, followed by its length. The value is a numeric
         string that contains the default number of entries to be
         returned in each feed.
       ATMP_SELECTOR
         Address of a double word containing a pointer to the selector
         value from the URL, followed by its length. This parameter is
         used to select the record in the CICS resource that is to be
         accessed.
       ATMP_NEXTSEL
         Address of a double word into which the service routine
         should set a pointer and length of a selector value for the
         next record in the resource, if any.
       ATMP_PREVSEL
         Address of a double word into which the service routine
         should set a pointer and length of a selector value for the
         previous record in the resource, if any.
       ATMP_FIRSTSEL
         Address of a double word into which the service routine
         should set a pointer and length of a selector value for the
         first (newest) record in the resource, if any.
       ATMP_LASTSEL
         Address of a double word into which the service routine
         should set a pointer and length of a selector value for the
         last (oldest) record in the resource, if any.
       ATMP_ID_FLD
         Address of a double word containing a pointer to the name of
         the field within the resource that contains the atom
         identifier from the atom:id element, if present, followed by
         its length. If it is present, the service routine should use
         this named field to store the contents of the atom:id element
  .
       ATMP_PUBLISHED_FLD
         Address of a double word containing a pointer to the name of
         the field within the resource that contains the time when the
         resource was first published, if present, followed by its
         length. If no such field exists, the pointer and length are
         both zero. If it is present, the service routine should use
         this named field to locate the value of the timestamp that
         can be used to construct the value returned in the
         ATMP_PUBLISHED parameter. This parameter may be all spaces
         if the resource does not contain such a field.
       ATMP_UPDATED_FLD
         Address of a double word containing a pointer to the name of
         the field within the resource that contains the time when the
         resource was last updated, if present, followed by its length.
         If no such field exists, the pointer and length are both zero.
         If it is present, the service routine should use this named
         field to locate the value of the timestamp that can be used
         to construct the value returned in the ATMP_UPDATED parameter.
         This parameter may be all spaces if the resource does not
         contain such a field.
       ATMP_EDITED_FLD
         Address of a double word containing a pointer to the name of
         the field within the resource that contains the time when the
         resource was last edited, if present, followed by its length.
         If no such field exists, the pointer and length are both zero.
         If it is present, the service routine should use this named
         field to locate the value of the timestamp that can be used
         to construct the value returned in the ATMP_EDITED parameter.
         This parameter may be all spaces if the resource does not
         contain such a field.
       ATMP_KEY_FLD
         Address of a double word containing a pointer to the name of
         the field within the resource that contains the key (RIDFLD)
         for File Control operations, if any, followed by its length.
         This is only relevant for key-sequenced VSAM files (KSDS).
       ATMP_TITLE_FLD
         Address of a double word containing a pointer to the name of
         the field within the resource that contains the Atom title of
         the represented entry, if present, followed by its length.
         If it is present, the service routine should use this named
         field to locate the entry title, and return it in the
         DFHATOMTITLE container.
       ATMP_SUBTITLE_FLD
         Address of a double word containing a pointer to the name of
         the field within the resource that contains the Atom subtitle
         of the represented entry, if present, followed by its length.
         If it is present, the service routine should use this named
         field to locate the entry subtitle, and return it in the
         DFHATOMSUBTITLE container.
       ATMP_SUMMARY_FLD
         Address of a double word containing a pointer to the name of
         the field within the resource that contains the Atom summary
         of the represented entry, if present, followed by its length.
         If it is present, the service routine should use this named
         field to locate the entry summary, and return it in the
         DFHATOMSUMMARY container.
       ATMP_CONTENT_FLD
         Address of a double word containing a pointer to the name of
         the field within the resource that contains the whole content
         of the represented entry, if present, followed by its length.
         If this field is not present, the entire contents of the
         record will be returned.
       ATMP_CONTENT_TYPE_FLD
         Address of a double word containing a pointer to the name of
         the field within the resource that contains the content type
         of the represented entry, if present, followed by its length.
         This field is used in combination with ATMP_CONTENT_FLD when
         you are returning data that is not structured XML, such as
         plain text or escaped HTML. If this field is not present,
         a content type of "application/xml" is assumed.
       ATMP_CATEGORY_FLD
         Address of a double word containing a pointer to the name of
         the field within the resource that contains the Atom
         categories of the represented entry, if present, followed by
         its length. If it is present, the service routine should
         use this named field to locate the entry summary, and return
         it in the DFHATOMCATEGORY container.
       ATMP_AUTHOR_FLD
         Address of a double word containing a pointer to the name of
         the field within the resource that contains the name of the
         principal author of the record, followed by its length.
       ATMP_AUTHORURI_FLD
         Address of a double word containing a pointer to the name of
         the field within the resource that contains a URI for the
         principal author of the record, followed by its length.
       ATMP_EMAIL_FLD
         Address of a double word containing a pointer to the name of
         the field within the resource that contains an email address
         for the principal author of the record, followed by its
         length.
Table 1.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 148 ATMP_PARAMETER_LIST
(0) ADDRESS 4 ATMP_OPTIONS Options bitstip
(4) ADDRESS 4 ATMP_RESPONSE Response/reason doubleword
(8) ADDRESS 4 ATMP_RESNAME CICS resource name
(C) ADDRESS 4 ATMP_RESTYPE CICS resource type
(10) ADDRESS 4 ATMP_ATOMTYPE Atom document type
(14) ADDRESS 4 ATMP_ATOMID Atom identifier
(18) ADDRESS 4 ATMP_HTTPMETH HTTP method
(1C) ADDRESS 4 ATMP_TAG_AUTHORITY Authority for tag URIs
(20) ADDRESS 4 ATMP_TAG_DATE Date for tag URIs
(24) ADDRESS 4 ATMP_XMLTRANSFORM XMLTRANSFORM resource name
(28) ADDRESS 4 ATMP_ROOT_ELEMENT Root element in bind file
(2C) ADDRESS 4 ATMP_MTYPEIN Mediatype of input
(30) ADDRESS 4 ATMP_MTYPEOUT Mediatype of output
(34) ADDRESS 4 ATMP_PUBLISHED Datestamp when first published
(38) ADDRESS 4 ATMP_UPDATED Datestamp when last updated
(3C) ADDRESS 4 ATMP_EDITED Datestamp when last edited
(40) ADDRESS 4 ATMP_ETAGVAL Entity tag value
(44) ADDRESS 4 ATMP_WINSIZE Feed window size
(48) ADDRESS 4 ATMP_SELECTOR Selector for current item
(4C) ADDRESS 4 ATMP_NEXTSEL Selector for next item
(50) ADDRESS 4 ATMP_PREVSEL Selector for previous item
(54) ADDRESS 4 ATMP_FIRSTSEL Selector for first item
(58) ADDRESS 4 ATMP_LASTSEL Selector for last item
(5C) ADDRESS 4 ATMP_ID_FLD Name of field for Atom id
(60) ADDRESS 4 ATMP_PUBLISHED_FLD Name of field for PUBLISHED
(64) ADDRESS 4 ATMP_UPDATED_FLD Name of field for UPDATED
(68) ADDRESS 4 ATMP_EDITED_FLD Name of field for EDITED
(6C) ADDRESS 4 ATMP_KEY_FLD Name of field for KEY
(70) ADDRESS 4 ATMP_TITLE_FLD Name of field for TITLE
(74) ADDRESS 4 ATMP_SUBTITLE_FLD Name of field for SUBTITLE
(78) ADDRESS 4 ATMP_SUMMARY_FLD Name of field for SUMMARY
(7C) ADDRESS 4 ATMP_CONTENT_FLD Name of field for CONTENT
(80) ADDRESS 4 ATMP_CONTENT_TYPE_FLD Name of field for CONTENT TYPE
(84) ADDRESS 4 ATMP_CATEGORY_FLD Name of field for CATEGORY
(88) ADDRESS 4 ATMP_AUTHOR_FLD Name of field for AUTHOR
(8C) ADDRESS 4 ATMP_AUTHORURI_FLD Name of field for AUTHORURI
(90) ADDRESS 4 ATMP_EMAIL_FLD Name of field for AUTHOREMAIL
Table 2.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 8 ATMP_RESPONSES Addressed by ATMP_RESPONSE
(0) UNSIGNED 4 ATMP_RESPONSE_CODE Response code
(4) UNSIGNED 4 ATMP_REASON_CODE Reason code
Table 3.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 8 ATMP_PARAMETER Parameter locator double word
(0) ADDRESS 4 ATMP_PARAMETER_PTR Parameter address
(4) FULLWORD 4 ATMP_PARAMETER_LEN Parameter length
Table 4.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 8 ATMP_OPTIONS_BITS Bits addressed by ATMP_OPTIONS
(0) BIT(32) 4 ATMP_OPTIONS_INBIT
(0) BIT(8) 1 ATMP_INOPT_BYTE0
(0) 1111 1...   * High five bits not usable in COBOL
(0) .... .1..   OPTFIRST First entry within a feed
(1) BIT(8) 1 ATMP_INOPT_BYTE1
(1) 1... ....   OPTSELHEX Selector encoded in hexadecimal
(1) .1.. ....   OPTSELDEC Selector encoded in decimal
(2) BIT(8) 1 ATMP_INOPT_BYTE2
(3) BIT(8) 1 ATMP_INOPT_BYTE3
(4) BIT(32) 4 ATMP_OPTIONS_OUTBIT
(4) BIT(8) 1 ATMP_OUTOPT_BYTE0
(4) 1111 1...   * High five bits not usable in COBOL
(4) .... .1..   OPTPRVFEED Prev link is for feed, not entry
(5) BIT(8) 1 ATMP_OUTOPT_BYTE1
(5) 1... ....   OPTTITLE DFHATOMTITLE container returned
(5) .1.. ....   OPTSUBTI DFHATOMSUBTITLE container retn'd
(5) ..1. ....   OPTSUMMA DFHATOMSUMMARY container returned
(5) ...1 ....   OPTCATEG DFHATOMCATEGORY container retn'd
(5) .... 1...   OPTAUTHOR DFHATOMAUTHOR container returned
(5) .... .1..   OPTAUTHEML DFHATOMEMAIL container returned
(5) .... ..1.   OPTAUTHURI DFHATOMAUTHORURI container retn'd
(5) .... ...1   * Reserved
(6) BIT(8) 1 ATMP_OUTOPT_BYTE2
(7) BIT(8) 1 ATMP_OUTOPT_BYTE3
Table 5.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 8 ATMP_OPTIONS_WORDS Words addressed by ATMP_OPTIONS
(0) UNSIGNED 4 ATMP_OPTIONS_IN Input request bits (not used)
(4) UNSIGNED 4 ATMP_OPTIONS_OUT Output response bits