Fix XML Schema validation not working for Soap APIs

[NethmiRanasinghe]

Purpose:

Fix the error in XML Schema Validation for Soap APIs, which occurs due to the incorrect retrieval of the Content-Type property. For Soap APIs, this is retrieved as null.

For Rest APIs Content-Type is correctly retrieved and therefore the XML validation works as expected.

Approach:

Modified the code to get the correct property for Content-Type when it is null.

Fix: wso2/api-manager#3596

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request updates the cloneRequestMessage method within the GatewayUtils class. The change introduces a null check when retrieving the content type property from the Axis2 message context. If the property is null, it now falls back to the default SOAP content type, thereby preventing a potential NullPointerException.

Changes

File	Change Summary
components/apimgt/…/GatewayUtils.java	Added a null check on the contentType property in the cloneRequestMessage method, with a fallback to ThreatProtectorConstants.SOAP_CONTENT_TYPE when the property is null.

Sequence Diagram(s)

sequenceDiagram
    participant G as GatewayUtils
    participant A as Axis2MC
    G->>A: getProperty(ThreatProtectorConstants.CONTENT_TYPE)
    alt Property is not null
        A-->>G: returns content type value
        G->>G: contentType = value.toString()
    else Property is null
        G->>G: contentType = ThreatProtectorConstants.SOAP_CONTENT_TYPE
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Error in XML Schema validation in Soap API (#3596)	✅

Suggested reviewers

• tgtshanika
• chamilaadhi
• tharindu1st
• dushaniw
• Arshardh
• AnuGayan

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b08daad and c9fbe7b.

📒 Files selected for processing (1)

• components/apimgt/org.wso2.carbon.apimgt.gateway/src/main/java/org/wso2/carbon/apimgt/gateway/utils/GatewayUtils.java (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: run-benchmark-test
• GitHub Check: build-product (2, group2)
• GitHub Check: build-product (4, group4)
• GitHub Check: build-product (3, group3)
• GitHub Check: build-product (1, group1)
• GitHub Check: build-carbon

🔇 Additional comments (1)

components/apimgt/org.wso2.carbon.apimgt.gateway/src/main/java/org/wso2/carbon/apimgt/gateway/utils/GatewayUtils.java (1)

474-480: Added null check for content type to fix XML Schema validation for SOAP APIs

The code now properly handles the case when the content type property is null by falling back to a default SOAP content type. This prevents a potential NullPointerException when calling toString() on a null property and ensures XML Schema validation works correctly for SOAP APIs.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.