Add syntactic sugar for URI paths (gh-3293)

[Arnav05-cyber]

Description

This Pull Request addresses issue #3293 by adding "syntactic sugar" for RouteDefinition URIs that contain a path component.

Currently, if a user specifies a path in the URI (e.g., uri: https://example.com/foo/bar), the Gateway does not automatically handle the path mapping, often requiring an explicit SetPath filter to avoid routing errors or double-pathing.

Changes introduced in this PR:

1. Automatic Path Detection: The RouteDefinitionRouteLocator now checks if the provided URI has a non-root path.
2. Filter Injection: If a path is detected and no SetPath filter is manually defined, a SetPath filter is automatically added to the beginning of the filter chain.
3. URI Normalization: The path component is stripped from the base URI after the filter is added to prevent "double-routing" (sending the path twice to the downstream service).

Testing

Added a new unit test uriWithMappingShouldAddSetPathFilter in RouteDefinitionRouteLocatorTests.java to verify:

• The SetPath filter is correctly injected with the URI's path.
• The Route URI is correctly stripped of its path component.
• The logic respects existing SetPath filters and does not duplicate them.

Signed-off-by: Arnav arnav.vyas06@gmail.com

[spencergibb]

I'll have to think about this, since RouteDefinitionRouteLocator is only one implementation of RouteLocator. Ideally this would work with any implementation.

[spencergibb]

Please revert all changes to this file

[Arnav05-cyber]

Thanks for the feedback, @spencergibb

I have reverted the changes to .settings.xml and fixed the DCO sign-off on that commit.

Regarding the implementation: I see your point. By putting this in RouteDefinitionRouteLocator, it only benefits users defining routes via properties/YAML.

Proposed Plan: I’m planning to move the path-detection and 'sugar' logic into the Route.Builder (specifically within the uri(URI uri) method). This would ensure that whether a route is created via the Java DSL, Discovery Client, or RouteDefinition, the path is correctly identified and a SetPath filter is added if missing.

Please advise!