rename files with Oracle SSO header decoding

Author: Vladimir Kotal

plugins/UserPlugin/src/opengrok/auth/plugin/UserPlugin.java

@@ -24,8 +24,8 @@
 
 import java.util.Map;
 import javax.servlet.http.HttpServletRequest;
-import opengrok.auth.plugin.decoders.FakeHeaderDecoder;
-import opengrok.auth.plugin.decoders.HeaderDecoder;
+import opengrok.auth.plugin.decoders.FakeOSSOHeaderDecoder;
+import opengrok.auth.plugin.decoders.OSSOHeaderDecoder;
 import opengrok.auth.plugin.decoders.IUserDecoder;
 import opengrok.auth.plugin.entity.User;
 import org.opensolaris.opengrok.authorization.IAuthorizationPlugin;
@@ -43,15 +43,15 @@ public class UserPlugin implements IAuthorizationPlugin {
 
     public static final String REQUEST_ATTR = "opengrok-user-plugin-user";
 
-    private IUserDecoder decoder = new HeaderDecoder();
+    private IUserDecoder decoder = new OSSOHeaderDecoder();
 
     @Override
     public void load(Map<String, Object> parameters) {
         Boolean fake;
 
         if ((fake = (Boolean) parameters.get(FAKE_PARAM)) != null
                 && fake) {
-            decoder = new FakeHeaderDecoder();
+            decoder = new FakeOSSOHeaderDecoder();
         }
     }
 

plugins/UserPlugin/src/opengrok/auth/plugin/decoders/FakeHeaderDecoder.java renamed to plugins/UserPlugin/src/opengrok/auth/plugin/decoders/FakeOSSOHeaderDecoder.java

@@ -17,18 +17,21 @@
  * CDDL HEADER END
  */
 
- /*
+/*
  * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
  */
 package opengrok.auth.plugin.decoders;
 
 /**
+ * Almost like @{code OSSOHeaderDecoder} however uses HTTP headers with
+ * the "my-" prefix which allows for custom header insertion.
+ * This class should therefore only be used for debugging.
  *
  * @author Krystof Tulinger
  */
-public class FakeHeaderDecoder extends HeaderDecoder {
+public class FakeOSSOHeaderDecoder extends OSSOHeaderDecoder {
 
-    public FakeHeaderDecoder() {
+    public FakeOSSOHeaderDecoder() {
         OSSO_COOKIE_TIMESTAMP_HEADER = "my-osso-cookie-timestamp";
         OSSO_TIMEOUT_EXCEEDED_HEADER = "my-osso-idle-timeout-exceeded";
         OSSO_SUBSCRIBER_DN_HEADER = "my-osso-subscriber-dn";

plugins/UserPlugin/src/opengrok/auth/plugin/decoders/HeaderDecoder.java renamed to plugins/UserPlugin/src/opengrok/auth/plugin/decoders/OSSOHeaderDecoder.java

@@ -34,9 +34,9 @@
  *
  * @author Krystof Tulinger
  */
-public class HeaderDecoder implements IUserDecoder {
+public class OSSOHeaderDecoder implements IUserDecoder {
 
-    private static final Logger LOGGER = Logger.getLogger(HeaderDecoder.class.getName());
+    private static final Logger LOGGER = Logger.getLogger(OSSOHeaderDecoder.class.getName());
 
     protected static String OSSO_COOKIE_TIMESTAMP_HEADER = "osso-cookie-timestamp";
     protected static String OSSO_TIMEOUT_EXCEEDED_HEADER = "osso-idle-timeout-exceeded";

plugins/UserPlugin/test/opengrok/auth/plugin/decoders/DecoderTest.java renamed to plugins/UserPlugin/test/opengrok/auth/plugin/decoders/OSSODecoderTest.java

@@ -17,7 +17,7 @@
  * CDDL HEADER END
  */
 
- /*
+/*
  * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
  */
 package opengrok.auth.plugin.decoders;
@@ -29,13 +29,14 @@
 import org.junit.Test;
 
 /**
+ * Test OSSO header decoder.
  *
  * @author Krystof Tulinger
  */
-public class DecoderTest {
+public class OSSODecoderTest {
 
     DummyHttpServletRequest dummyRequest;
-    HeaderDecoder decoder = new HeaderDecoder();
+    OSSOHeaderDecoder decoder = new OSSOHeaderDecoder();
 
     @Before
     public void setUp() {
@@ -144,9 +145,7 @@ public void testInvalidGetCookieTimestamp() {
             "ffffx" // not a hex number
         };
 
-        for (int i = 0;
-                i < tests.length;
-                i++) {
+        for (int i = 0; i < tests.length; i++) {
             dummyRequest.setHeader("osso-cookie-timestamp", tests[i]);
             Assert.assertNotNull(u = decoder.fromRequest(dummyRequest));
             Assert.assertNull(u.getCookieTimestamp());