From 519748106e8653acce8b2530a7f241889cfab7fc Mon Sep 17 00:00:00 2001
From: Sebastian Sdorra <sebastian.sdorra@cloudogu.com>
Date: Mon, 23 Aug 2021 20:07:52 +0200
Subject: [PATCH] Fix too heavy logging of SchemeBasedWebTokenGenerator (#1777)

Reduce log level of `could not create token from authentication header from warn to debug, because it is normal that these message is logged if multiple SchemeBasedWebTokenGenerator are registered.

Fixes #1772
---
 gradle/changelog/relax_logging.yaml           |  2 +
 .../scm/web/SchemeBasedWebTokenGenerator.java | 51 ++++---------------
 2 files changed, 13 insertions(+), 40 deletions(-)
 create mode 100644 gradle/changelog/relax_logging.yaml

diff --git a/gradle/changelog/relax_logging.yaml b/gradle/changelog/relax_logging.yaml
new file mode 100644
index 0000000000..ae277c14f6
--- /dev/null
+++ b/gradle/changelog/relax_logging.yaml
@@ -0,0 +1,2 @@
+- type: fixed
+  description: Too heavy logging of SchemeBasedWebTokenGenerator ([#1772](https://github.com/scm-manager/scm-manager/issues/1772) and [#1777](https://github.com/scm-manager/scm-manager/pull/1777))
diff --git a/scm-core/src/main/java/sonia/scm/web/SchemeBasedWebTokenGenerator.java b/scm-core/src/main/java/sonia/scm/web/SchemeBasedWebTokenGenerator.java
index 541b8c5edc..160e0e25d4 100644
--- a/scm-core/src/main/java/sonia/scm/web/SchemeBasedWebTokenGenerator.java
+++ b/scm-core/src/main/java/sonia/scm/web/SchemeBasedWebTokenGenerator.java
@@ -21,7 +21,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-    
+
 package sonia.scm.web;
 
 //~--- non-JDK imports --------------------------------------------------------
@@ -42,8 +42,7 @@ import javax.servlet.http.HttpServletRequest;
  * @author Sebastian Sdorra
  * @since 2.0.0
  */
-public abstract class SchemeBasedWebTokenGenerator implements WebTokenGenerator
-{
+public abstract class SchemeBasedWebTokenGenerator implements WebTokenGenerator {
 
   /** authorization header */
   private static final String HEADER_AUTHORIZATION = "Authorization";
@@ -51,54 +50,26 @@ public abstract class SchemeBasedWebTokenGenerator implements WebTokenGenerator
   /**
    * the logger for SchemeBasedWebTokenGenerator
    */
-  private static final Logger logger =
-    LoggerFactory.getLogger(SchemeBasedWebTokenGenerator.class);
+  private static final Logger LOG = LoggerFactory.getLogger(SchemeBasedWebTokenGenerator.class);
 
-  //~--- methods --------------------------------------------------------------
+  protected abstract AuthenticationToken createToken(HttpServletRequest request, String scheme, String authorization);
 
-  /**
-   * Method description
-   *
-   *
-   * @param request
-   * @param scheme
-   * @param authorization
-   *
-   * @return
-   */
-  protected abstract AuthenticationToken createToken(
-    HttpServletRequest request, String scheme, String authorization);
-
-  /**
-   * Method description
-   *
-   *
-   * @param request
-   *
-   * @return
-   */
   @Override
-  public AuthenticationToken createToken(HttpServletRequest request)
-  {
+  public AuthenticationToken createToken(HttpServletRequest request) {
     AuthenticationToken token = null;
     String authorization = request.getHeader(HEADER_AUTHORIZATION);
 
-    if (!Strings.isNullOrEmpty(authorization))
-    {
+    if (!Strings.isNullOrEmpty(authorization)) {
       String[] parts = authorization.split("\\s+");
 
-      if (parts.length > 0)
-      {
+      if (parts.length > 0) {
         token = createToken(request, parts[0], parts[1]);
 
-        if (token == null)
-        {
-          logger.warn("could not create token from authentication header");
+        if (token == null) {
+          LOG.debug("could not create token from authentication header");
         }
-      }
-      else
-      {
-        logger.warn("found malformed authentication header");
+      } else {
+        LOG.warn("found malformed authentication header");
       }
     }