Rename getRequestURI() to getOriginalRelativeURI() (#2625)

* test infra (wip)

* wip

* finish xml test

* simplify tests

* add XmlProtectionTutorialTest

* add Json TutorialTests

* feat(xml-protection): set HTTP status codes for error responses

- Added explicit status codes (500, 415, 400) for error responses in `XMLProtectionInterceptor` to improve clarity and alignment with HTTP standards.

* refactor(core): remove `URLNormalizerInterceptor` and replace `getRequestURI` with `getUri` for improved URI handling

- Completely removed the unused `URLNormalizerInterceptor`.
- Updated multiple classes to replace deprecated `getRequestURI` with `getUri` or `getOriginalRelativeURI` for improved readability and consistency in URI handling.
- Added `getOriginalRelativeURI` method in `Exchange` class to encapsulate original relative URI logic.

* refactor(core): rename `getRequestURI` to `getOriginalRelativeURI` and remove redundant method

- Updated `Exchange` class to replace `getRequestURI` with `getOriginalRelativeURI` for improved naming consistency.
- Removed redundant `getOriginalRelativeURI` implementation that relied on `getRequestURI`.

* update to use `getOriginalRelativeURI()` instead of `getRequestURI()` across core and test classes

* test(core): simplify `getOpenapiValidatorRequestFromExchange` test setup

- Refactored test to use utility methods for cleaner and more concise setup.
- Replaced manual request creation with `post` method and static constants for improved readability.

* test(core): clean up imports and fix formatting in `UtilsTest`

- Removed unused imports for better readability.
- Standardized formatting to improve code consistency across `UtilsTest`.

* test(core): add suppression for empty try block warning in `UtilsTest`

- Added `//noinspection EmptyTryBlock` to silence warnings for intentionally empty try block in `getResourceAsStreamInvalidResource` test.

---------

Co-authored-by: Thomas Bayer <bayer@predic8.de>

Author: christiangoerdes

core/src/main/java/com/predic8/membrane/core/exchange/Exchange.java

@@ -14,19 +14,17 @@
 
 package com.predic8.membrane.core.exchange;
 
-import com.predic8.membrane.core.*;
 import com.predic8.membrane.core.http.*;
-import com.predic8.membrane.core.proxies.Proxy;
 import com.predic8.membrane.core.proxies.*;
+import com.predic8.membrane.core.proxies.Proxy;
 import com.predic8.membrane.core.transport.http.*;
 import com.predic8.membrane.core.util.*;
 import org.slf4j.*;
 
 import java.net.*;
 import java.util.*;
 
-import static java.lang.Boolean.TRUE;
-import static java.util.stream.Collectors.toMap;
+import static java.util.stream.Collectors.*;
 
 public class Exchange extends AbstractExchange {
 
@@ -125,7 +123,7 @@ public void collectStatistics() {
      * <p>
      * To be used, for example, when generating self-referring web pages.
      */
-    public String getRequestURI() {
+    public String getOriginalRelativeURI() {
         if (HttpUtil.isAbsoluteURI(getOriginalRequestUri())) {
             try {
                 return new URL(getOriginalRequestUri()).getFile();

core/src/main/java/com/predic8/membrane/core/interceptor/DispatchingInterceptor.java

@@ -80,7 +80,7 @@ public Outcome handleRequest(Exchange exc) {
     }
 
     private static @NotNull String getMessageForURISyntaxException(Exchange exc, URISyntaxException e) {
-        var uri = exc.getRequestURI();
+        var uri = exc.getOriginalRelativeURI();
         if (e.getIndex() >= 0 && e.getIndex() < uri.length()) {
             return "The request path contains an invalid character '%s' at pos %d".formatted(uri.charAt(e.getIndex()), e.getIndex());
         }

core/src/main/java/com/predic8/membrane/core/interceptor/RelocatingInterceptor.java

@@ -59,7 +59,7 @@ public Outcome handleResponse(Exchange exc) {
 			log.error("",e);
 			internal(router.getConfiguration().isProduction(),getDisplayName())
 					.detail("Error rewriting URI")
-					.topLevel("URI", exc.getRequestURI())
+					.topLevel("URI", exc.getOriginalRelativeURI())
 					.exception(e)
 					.buildAndSetResponse(exc);
 			return ABORT;

core/src/main/java/com/predic8/membrane/core/interceptor/URLNormalizerInterceptor.java

@@ -67,7 +67,7 @@ public Outcome handleRequest(Exchange exc) {
         String remoteIp = exc.getRemoteAddrIp();
         if (!accessControl.isPermitted(remoteIp)) {
             setResponseToAccessDenied(exc);
-            log.debug("Access denied. remoteIp={} method={} uri={}", remoteIp, exc.getRequest().getMethod(), exc.getRequestURI());
+            log.debug("Access denied. remoteIp={} method={} uri={}", remoteIp, exc.getRequest().getMethod(), exc.getOriginalRelativeURI());
             return ABORT;
         }
         return CONTINUE;

core/src/main/java/com/predic8/membrane/core/interceptor/acl/AccessControlInterceptor.java

@@ -77,7 +77,7 @@ public void init() {
     @Override
     public Outcome handleRequest(Exchange exc) {
         try {
-            String uri = exc.getRequestURI();
+            String uri = exc.getRequest().getUri();
             if (uri.matches(".*/health.*")) {
                 return handleHealth(exc);
             } else if (uri.matches(".*/apis.*")) {
@@ -242,7 +242,7 @@ private void writePluginRow(List<Interceptor> plugins, Flow limitedFlow, JsonGen
     private Outcome handleCalls(Exchange exc) {
         ExchangeQueryResult res;
         try {
-            QueryParameter qp = new QueryParameter(queryToParameters(new URI(exc.getRequestURI()).getQuery()), null);
+            QueryParameter qp = new QueryParameter(queryToParameters(new URI(exc.getRequest().getUri()).getQuery()), null);
             res = getRouter().getExchangeStore().getFilteredSortedPaged(qp, false);
 
             StringWriter writer = new StringWriter();

core/src/main/java/com/predic8/membrane/core/interceptor/adminapi/AdminApiInterceptor.java

@@ -108,7 +108,7 @@ public void init() {
     public Outcome handleRequest(Exchange exc) {
         var key = getKey(exc);
         if (required && key.isEmpty()) {
-            log.warn("Tried access apiKey protected resource without key. Uri: {}", exc.getRequestURI());
+            log.warn("Tried access apiKey protected resource without key. Uri: {}", exc.getOriginalRelativeURI());
             security(false, getDisplayName())
                     .title(TITLE_4XX)
                     .status(401)

core/src/main/java/com/predic8/membrane/core/interceptor/apikey/ApiKeysInterceptor.java

@@ -137,7 +137,7 @@ private String getT2Payload(Exchange resT1) {
     }
 
     private String buildRequestUrl(Exchange exc) {
-        return (exc.getTargetConnection().getSslProvider() != null ? "https" : "http") + "://" + exc.getRequest().getHeader().getHost() + exc.getRequestURI();
+        return (exc.getTargetConnection().getSslProvider() != null ? "https" : "http") + "://" + exc.getRequest().getHeader().getHost() + exc.getOriginalRelativeURI();
     }
 
     private void prepareStreamByEmptyingIt(Exchange exc) {

core/src/main/java/com/predic8/membrane/core/interceptor/ntlm/NtlmInterceptor.java

@@ -47,7 +47,7 @@ protected Outcome respondWithAuthorizationCodeAndRedirect(Exchange exc, String c
         String state = null;
         String redirectUrl;
 
-        String rawQuery = URLUtil.getPathQuery(authServer.getRouter().getConfiguration().getUriFactory(),exc.getRequestURI());
+        String rawQuery = URLUtil.getPathQuery(authServer.getRouter().getConfiguration().getUriFactory(),exc.getOriginalRelativeURI());
         if(rawQuery.startsWith(authServer.getBasePath() + "/"))
             rawQuery = rawQuery.substring(authServer.getBasePath().length() + 1);
         if(rawQuery.startsWith("?"))

core/src/main/java/com/predic8/membrane/core/interceptor/oauth2/flows/CodeFlow.java

@@ -34,7 +34,7 @@ public AuthEndpointProcessor(OAuth2AuthorizationServerInterceptor authServer) {
 
     @Override
     public boolean isResponsible(Exchange exc) {
-        return exc.getRequestURI().startsWith(authServer.getBasePath() + "/oauth2/auth") && !authServer.isLoginViewDisabled();
+        return exc.getOriginalRelativeURI().startsWith(authServer.getBasePath() + "/oauth2/auth") && !authServer.isLoginViewDisabled();
     }
 
     @Override