WS_XML_READER_MTOM_ENCODING structure

Used to indicate that the reader should interpret the bytes it reads as in MTOM format.

Syntax

struct WS_XML_READER_MTOM_ENCODING {
  WS_XML_READER_ENCODING  encoding;
  WS_XML_READER_ENCODING* textEncoding;
  BOOL                    readMimeHeader;
  WS_STRING               startInfo;
  WS_STRING               boundary;
  WS_STRING               startUri;
};

Members

encoding

The base type for all types that derive from WS_XML_READER_ENCODING.

textEncoding

The encoding of the xml document carried by MTOM.

readMimeHeader

Specifies whether or not the reader should read the MIME header.

startInfo

The type used by the mime part that contains the xml. This corresponds to the "start-info" parameter in the of the MIME Content-Type. If readMimeHeader is specified as TRUE, then this must be empty as the startInfo will be read from the mime header.

boundary

The character sequence that should be used to delimit the mime parts. This corresponds to the "boundary" parameter of the MIME Content-Type. If readMimeHeader is specified as TRUE, then this must be empty as the boundary will be read from the mime header.

startUri

The mime part that contains the xml. This corresponds to the "start" parameter of the MIME Content-Type. If readMimeHeader is specified as TRUE, then this must be empty as the startUri will be read from the mime header.

Security

Only four actual headers in MIME part that the MTOM implementation is concerned with are handled. Other headers are discarded and consumes no memory.

In streamed mode, the root MIME part of the document must be the first MIME part received, and the MIME parts must appear exactly in the order in which they are referenced, otherwise XML reader rejects the document.

The boundary defining the root MIME part must be found within the value specified by WS_XML_READER_PROPERTY_STREAM_MAX_ROOT_MIME_PART_SIZE, with default value of 64k. Resetting the property to a large value may present an opportunity for a denial of service attack.

The boundary defining the MIME headers must be found within the value specified by WS_XML_READER_PROPERTY_STREAM_MAX_MIME_HEADERS_SIZE, with default value of 4k. Resetting the property to a large value may present an opportunity for a denial of service attack.

The maximum number of MIME parts permitted in a XML document is specified by WS_XML_READER_PROPERTY_MAX_MIME_PARTS, with default value of 256. Documents with MIME part number exceeding this value are rejected. Resetting the property to a large value may present an opportunity for a denial of service attack.

Remarks

When used with WS_XML_READER_BUFFER_INPUT the MIME parts may appear in any order.

When used with WS_XML_READER_STREAM_INPUT the root MIME part must be first, and subsequent MIME parts must appear in the order that they are referenced from xop:Include elements.

See http://www.w3.org/TR/2005/REC-xop10-20050125/ for the MTOM specification.

Requirements