JOSIF Main Page | JOSIF Framework | TIP Soap Generator
| Table of Contents |
|---|
| outline | true |
|---|
| indent | 20px |
|---|
| style | none |
|---|
| printable | false |
|---|
|
Introduction
The TIP Soap Generator is a sub project of the TIP Framework, which is being developed as part of JOSIF.
The purpose of the TIP Soap Generator is to generate the SOAP-based protocol specific artifacts from the following TIP Tigerstripe projects:
- The TIP_Generator_Internal_Model with all its implicit TIP Interface meta-data definitions,
- The TIP_Common_Model with all its TIP common explicit TIP Interface meta-data definitions,
- All the TIP_Interfaces Model projects
The generated SOAP-based protocol specific artifacts include:
- WSDL (Web Service Definition Language) v1.1 from W3C (http://www.w3.org/TR/wsdl) and the following two profiles:
- the SOAP/HTTP binding for standard-based Web Services specifications and Internet HTTP transport/communication protocol.
- Future the SOAP/JMS binding for Web Services specifications using a Java Message Service API as transport/communication protocol.
- XSD (XML Schema Definition) v1.0 from W3C (http://www.w3.org/XML/Schema#dev) for all XML-based data structure definitions
TS Model to XML Mapping Rules
| Panel |
|---|
| borderColor | #ccc |
|---|
| bgColor | #fff |
|---|
| title | Mapping rules documentation sections |
|---|
| borderStyle | dashed |
|---|
|
|
XSD Documentation Display Rules
| Panel |
|---|
| borderColor | #ccc |
|---|
| bgColor | #fff |
|---|
| title | display roles |
|---|
| borderStyle | dashed |
|---|
|
Section | Content |
|---|
Display Rules | the display rules for the XSD documentation |
|
External XSD support
| Panel |
|---|
| borderColor | #ccc |
|---|
| bgColor | #fff |
|---|
| title | display roles |
|---|
| borderStyle | dashed |
|---|
|
Section | Content |
|---|
External XSD | the support for external XSDs in SOAP generator |
|
Code Access
Variables
The generator needs some values of variables to be provided by model projects. Here we give description and default value of these variables. Please note that some variables are possibly moved into the generator in next releases, and not need to exposure to the users.
| Panel |
|---|
| borderColor | #ccc |
|---|
| bgColor | #fff |
|---|
| title | Plugin Settings table |
|---|
| borderStyle | dashed |
|---|
|
Variable | Description | Default Value |
|---|
ROOT_PKG | the root package of all TIP model. That is, any packages, any artifacts are enclosed by the root package or its children | org.tmforum.tip | ROOT_XMLNS | The root XML namespace for all TIP specifications | http://www.tmforum.org/xml/tip | COMMON_MODEL_MODEL_ID | the model id of TIP Common Model | tip_common_model | COMMON_MODEL_VER | the version of TIP Common Model | 0.1 | COMMON_MODEL_PKG | the root package of TIP Common Model | org.tmforum.tip.common | INTERNAL_MODEL_MODEL_ID | the model id of TIP Generator Internal Model | tip_generator_internal_model | INTERNAL_MODEL_PKG | the package where EntityIdentifier is defined | org.tmforum.tip.internal.entity | COMMON_ENTITY_ID | the fully qualified name of EntityIdentifier | org.tmforum.tip.internal.entity.EntityIdentifier | COMMON_ENTITY_BASE | the fully qualified name of EntityBase entity | org.tmforum.tip.internal.entity.EntityBase | COMMON_EVENT_BASE | the fully qualified name of NotificationBase | org.tmforum.tip.common.notifications.NotificationBase | COMMON_EXCEPTION_BASE | the fully qualified name of ExceptionBase | org.tmforum.tip.common.exceptions.ExceptionBase | MODEL_SHORT_NAME | the short name of the TIP model. It will be used as first part of the names of the generated XSD and WSDL files | none | DEPENDENCY_MODEL_SHORT_NAME | the short name of the dependency model. Every TIP model project will have at most 1 dependency model besides TIP common model. When we run the generator for the TIP model, some XSD files are possibly generated from the dependency model. The short name will be the first part of the names of the XSD files to indicate they are from dependency model | dep | INJECT_EXCEPTIONS | a boolean to indicate if we inject pre-exceptions to every operation in WSDL | true |
|
Notes:
- Example of MODEL_SHORT_NAME for TIP SPM model, if we take its short name as 'spm', then the short name will appear at the first part of the file names such as 'spm_service_problem_serviceprobleminterface.wsdl'.
Following picture shows a sample configuration.
Image Added