JOSIF Main Page | JOSIF Framework  | TIP Soap Generator | TIP Soap Generator Mapping Rules - Part VI

tipOperation; BulkTransferPattern - Iterator

Iterator XML Mapping Overview

Refer to the Iterator Pattern for a description of how this interaction pattern is defined from a Protocol Neutral point-of-view.

The Soap Generator mapping of the Iterator interaction pattern model artifacts to XML includes generation of:

• the XSD from the implicit meta-data Model Iterator package definitions of the TIP Generator Internal Model
• the WSDL/XSD of a TIP service interface operation associated with Iterator Pattern
• the WSDL/XSD of each entity specific TIP Iterator service interface

Currently, only the download direction of the bulk data transfer is supported (Server to Client flow).

Iterator XML Mapping Rules

There are no special mapping rules other than the existing rules for each specific TS model artifact as described in the other parts of this guide.

However, the following XML definitions are implicitly generated:

• For each entity a complexType as followed:
  • name = <EntityName>ResultWithIterator
  • with local XML elements:
    • result of type ArrayOf<EntityName> (from same xmlns)
    • iterator of type IteratorInfo (from TIP Generator Internal Model)
• For each out argument with tipAttribute isBulkPotential in an operation with bulkTransferPattern=ITERATOR
  • The generated argument is associated with a type based on above <EntityName>ResultWithIterator complexType.

Finally, the Soap Generator mapping of the Iterator interaction pattern model artifacts has the following limitations:

• the upload direction (from Client to Server) of the bulk transfer of data is not supported (JOSIF v2)

Iterator XML Mapping Example

This example is based on the  General Patterns#Iterator Model Example. The Soap Generator generates the following corresponding XML artifacts:

• The spm_service_problem.xsd with the ServiceProblemResultWithIterator complexType including:
  • result based on type: ArrayOfServiceProblem
  • iterator based on type: IteratorInfo (from TIP Generator Internal Model)
• The spm_service_problem_serviceproblemiterator_msg.xsd with the schema definitions for:
  • The getNextServiceProblemIteration operation request and response messages
  • The releaseServiceProblemIterator operation request and response messages
• The spm_service_problem_serviceproblemiterator.wsdl with the WS definitions for:
  • The getNextServiceProblemIteration operation
  • The releaseServiceProblemIterator operation
• The spm_service_problem_serviceprobleminterface_msg.xsd with the schema definitions for:
  • The getServiceProblemsByTemplateRequest operation request message as defined in the TS model
  • The getServiceProblemsByTemplateResponse operation response message based with the objects parameter (local XML element) based on the ServiceProblemResultWithIterator (See first bullet above)

tipOperation; BulkTransferPattern - File

This interaction pattern is not yet defined. Supporting plan is for JOSIF v2.