[fineract] branch develop updated: add new /echo debug API endpoint (FINERACT-915) (#797)

[aw...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

awasum pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/fineract.git


The following commit(s) were added to refs/heads/develop by this push:
     new d33e0ba  add new /echo debug API endpoint (FINERACT-915) (#797)
d33e0ba is described below

commit d33e0ba72a601d7bbe2295a3c6016bfb8b520314
Author: Michael Vorburger ⛑️ <mi...@vorburger.ch>
AuthorDate: Sun May 3 23:34:37 2020 +0200

    add new /echo debug API endpoint (FINERACT-915) (#797)
---
 .../core/debug/EchoHeadersResource.java            | 57 ++++++++++++++++++++++
 .../resources/META-INF/spring/securityContext.xml  |  5 +-
 2 files changed, 60 insertions(+), 2 deletions(-)

diff --git a/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/debug/EchoHeadersResource.java b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/debug/EchoHeadersResource.java
new file mode 100644
index 0000000..97c94f3
--- /dev/null
+++ b/fineract-provider/src/main/java/org/apache/fineract/infrastructure/core/debug/EchoHeadersResource.java
@@ -0,0 +1,57 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.fineract.infrastructure.core.debug;
+
+import javax.ws.rs.Consumes;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.core.HttpHeaders;
+import javax.ws.rs.core.MediaType;
+import org.springframework.context.annotation.Scope;
+import org.springframework.stereotype.Component;
+
+/**
+ * Returns HTTP Request headers. Useful for debugging (e.g. for <a href=
+ * "https://issues.apache.org/jira/browse/FINERACT-914">FINERACT-914</a>. Could
+ * later be replaced with <a href=
+ * "https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready-http-tracing">Spring
+ * Boot's Actuator HTTP Tracing</a> (see also
+ * <a href="https://www.baeldung.com/spring-boot-actuator-http">related tutorial
+ * on Baeldung.com</a>), but that exposes a lot more than just the current
+ * request out of the box, and would to be properly authenticated for a
+ * dedicated new debug role.
+ *
+ * @author Michael Vorburger.ch
+ */
+@Component
+@Path("/echo")
+@Scope("singleton")
+public class EchoHeadersResource {
+
+    @GET
+    @Consumes({ MediaType.WILDCARD })
+    @Produces({ MediaType.TEXT_PLAIN })
+    public String get(@Context HttpHeaders headers) {
+        StringBuilder sb = new StringBuilder("Request Headers:\n");
+        headers.getRequestHeaders().forEach((k, v) -> sb.append(k).append(" : ").append(v.get(0)).append("\n"));
+        return sb.toString();
+    }
+}
diff --git a/fineract-provider/src/main/resources/META-INF/spring/securityContext.xml b/fineract-provider/src/main/resources/META-INF/spring/securityContext.xml
index 0480700..56f6194 100644
--- a/fineract-provider/src/main/resources/META-INF/spring/securityContext.xml
+++ b/fineract-provider/src/main/resources/META-INF/spring/securityContext.xml
@@ -35,6 +35,7 @@
 		<http create-session="stateless" use-expressions="true" pattern="/api/**"
 			entry-point-ref="basicAuthenticationEntryPoint">
 			<csrf disabled="true"/>
+			<intercept-url pattern="/api/*/echo" access="permitAll" />
 			<intercept-url pattern="/api/*/authentication" access="permitAll"
 				method="POST" requires-channel="https" />
 			<intercept-url pattern="/api/*/self/authentication" access="permitAll"
@@ -59,7 +60,7 @@
 				method="DELETE" requires-channel="https" />
 			<intercept-url pattern="/api/**" access="isFullyAuthenticated() and hasAuthority('TWOFACTOR_AUTHENTICATED')"
 				method="HEAD" requires-channel="https" />
-	
+
 			<custom-filter after="SECURITY_CONTEXT_FILTER" ref="basicAuthenticationProcessingFilter" />
 			<custom-filter ref="twoFactorAuthFilter" after="BASIC_AUTH_FILTER" />
 		</http>
@@ -187,7 +188,7 @@
 			class="org.springframework.security.oauth2.provider.client.JdbcClientDetailsService">
 			<beans:constructor-arg ref="routingDataSource" />
 		</beans:bean>
-	
+
 		<beans:bean id="tokenStore"
 			class="org.springframework.security.oauth2.provider.token.store.JdbcTokenStore">
 			<beans:constructor-arg ref="routingDataSource" />