[spi] Creating IThirdEyePrincipal interface for auth. +refactor

startreedata · Nov 8, 2023 · b08e39e · b08e39e
1 parent 12578ed
commit b08e39e
Show file tree

Hide file tree

Showing 10 changed files with 33 additions and 14 deletions.
diff --git a/thirdeye-server/src/main/java/ai/startree/thirdeye/auth/AuthRegistry.java b/thirdeye-server/src/main/java/ai/startree/thirdeye/auth/AuthRegistry.java
@@ -17,8 +17,8 @@
 import static com.google.common.base.Preconditions.checkState;
 import static java.util.Objects.requireNonNull;
 
-import ai.startree.thirdeye.auth.ThirdEyePrincipal.AuthenticationType;
 import ai.startree.thirdeye.auth.oauth.OAuthConfiguration;
+import ai.startree.thirdeye.spi.auth.AuthenticationType;
 import ai.startree.thirdeye.spi.auth.Authenticator.OauthAuthenticatorFactory;
 import ai.startree.thirdeye.spi.auth.OpenIdConfigurationProvider;
 import ai.startree.thirdeye.spi.auth.OpenIdConfigurationProvider.Factory;

diff --git a/thirdeye-server/src/main/java/ai/startree/thirdeye/auth/AuthorizationManager.java b/thirdeye-server/src/main/java/ai/startree/thirdeye/auth/AuthorizationManager.java
@@ -18,10 +18,10 @@
 import static ai.startree.thirdeye.spi.util.SpiUtils.optional;
 
 import ai.startree.thirdeye.alert.AlertTemplateRenderer;
-import ai.startree.thirdeye.auth.ThirdEyePrincipal.AuthenticationType;
 import ai.startree.thirdeye.datalayer.dao.SubEntities;
 import ai.startree.thirdeye.spi.auth.AccessControl;
 import ai.startree.thirdeye.spi.auth.AccessType;
+import ai.startree.thirdeye.spi.auth.AuthenticationType;
 import ai.startree.thirdeye.spi.auth.ResourceIdentifier;
 import ai.startree.thirdeye.spi.datalayer.dto.AbstractDTO;
 import ai.startree.thirdeye.spi.datalayer.dto.AlertDTO;

diff --git a/thirdeye-server/src/main/java/ai/startree/thirdeye/auth/ThirdEyeAuthenticatorDisabled.java b/thirdeye-server/src/main/java/ai/startree/thirdeye/auth/ThirdEyeAuthenticatorDisabled.java
@@ -15,7 +15,7 @@
 
 import static ai.startree.thirdeye.spi.util.SpiUtils.optional;
 
-import ai.startree.thirdeye.auth.ThirdEyePrincipal.AuthenticationType;
+import ai.startree.thirdeye.spi.auth.AuthenticationType;
 import io.dropwizard.auth.Authenticator;
 import java.util.Optional;
 

diff --git a/thirdeye-server/src/main/java/ai/startree/thirdeye/auth/ThirdEyePrincipal.java b/thirdeye-server/src/main/java/ai/startree/thirdeye/auth/ThirdEyePrincipal.java
@@ -13,19 +13,18 @@
  */
 package ai.startree.thirdeye.auth;
 
-import java.security.Principal;
+import ai.startree.thirdeye.spi.auth.AuthenticationType;
+import ai.startree.thirdeye.spi.auth.IThirdEyePrincipal;
 
-public class ThirdEyePrincipal implements Principal {
-
-  public enum AuthenticationType {
-    BASIC_AUTH, OAUTH, INTERNAL, DISABLED
-  }
+public class ThirdEyePrincipal implements IThirdEyePrincipal {
 
   private final String name;
   private final String authToken;
   private final AuthenticationType authenticationType;
 
-  public ThirdEyePrincipal(final String name, final String authToken, final AuthenticationType authenticationType) {
+  public ThirdEyePrincipal(final String name,
+      final String authToken,
+      final AuthenticationType authenticationType) {
     this.name = name;
     this.authToken = authToken;
     this.authenticationType = authenticationType;
@@ -36,10 +35,12 @@ public String getName() {
     return name;
   }
 
+  @Override
   public String getAuthToken() {
     return authToken;
   }
 
+  @Override
   public AuthenticationType getAuthenticationType() {
     return authenticationType;
   }

diff --git a/...deye-server/src/main/java/ai/startree/thirdeye/auth/basic/ThirdEyeBasicAuthenticator.java b/...deye-server/src/main/java/ai/startree/thirdeye/auth/basic/ThirdEyeBasicAuthenticator.java
@@ -14,7 +14,7 @@
 package ai.startree.thirdeye.auth.basic;
 
 import ai.startree.thirdeye.auth.ThirdEyePrincipal;
-import ai.startree.thirdeye.auth.ThirdEyePrincipal.AuthenticationType;
+import ai.startree.thirdeye.spi.auth.AuthenticationType;
 import com.google.inject.Inject;
 import io.dropwizard.auth.Authenticator;
 import io.dropwizard.auth.basic.BasicCredentials;

diff --git a/thirdeye-server/src/test/java/ai/startree/thirdeye/resources/AlertResourceTest.java b/thirdeye-server/src/test/java/ai/startree/thirdeye/resources/AlertResourceTest.java
@@ -27,7 +27,6 @@
 import ai.startree.thirdeye.auth.AuthorizationManager;
 import ai.startree.thirdeye.auth.NamespaceResolver;
 import ai.startree.thirdeye.auth.ThirdEyePrincipal;
-import ai.startree.thirdeye.auth.ThirdEyePrincipal.AuthenticationType;
 import ai.startree.thirdeye.service.AlertService;
 import ai.startree.thirdeye.service.AppAnalyticsService;
 import ai.startree.thirdeye.spi.api.AlertApi;
@@ -39,6 +38,7 @@
 import ai.startree.thirdeye.spi.api.PlanNodeApi;
 import ai.startree.thirdeye.spi.auth.AccessControl;
 import ai.startree.thirdeye.spi.auth.AccessType;
+import ai.startree.thirdeye.spi.auth.AuthenticationType;
 import ai.startree.thirdeye.spi.auth.ResourceIdentifier;
 import ai.startree.thirdeye.spi.datalayer.bao.AlertManager;
 import ai.startree.thirdeye.spi.datalayer.bao.AlertTemplateManager;

diff --git a/thirdeye-server/src/test/java/ai/startree/thirdeye/resources/CrudResourceTest.java b/thirdeye-server/src/test/java/ai/startree/thirdeye/resources/CrudResourceTest.java
@@ -24,13 +24,13 @@
 import ai.startree.thirdeye.auth.AuthorizationManager;
 import ai.startree.thirdeye.auth.NamespaceResolver;
 import ai.startree.thirdeye.auth.ThirdEyePrincipal;
-import ai.startree.thirdeye.auth.ThirdEyePrincipal.AuthenticationType;
 import ai.startree.thirdeye.datalayer.bao.AbstractManagerImpl;
 import ai.startree.thirdeye.datalayer.dao.GenericPojoDao;
 import ai.startree.thirdeye.service.CrudService;
 import ai.startree.thirdeye.spi.api.ThirdEyeCrudApi;
 import ai.startree.thirdeye.spi.auth.AccessControl;
 import ai.startree.thirdeye.spi.auth.AccessType;
+import ai.startree.thirdeye.spi.auth.AuthenticationType;
 import ai.startree.thirdeye.spi.auth.ResourceIdentifier;
 import ai.startree.thirdeye.spi.datalayer.bao.AbstractManager;
 import ai.startree.thirdeye.spi.datalayer.dto.AbstractDTO;

diff --git a/thirdeye-server/src/test/java/ai/startree/thirdeye/resources/DataSourceResourceTest.java b/thirdeye-server/src/test/java/ai/startree/thirdeye/resources/DataSourceResourceTest.java
@@ -22,13 +22,13 @@
 import ai.startree.thirdeye.auth.AuthorizationManager;
 import ai.startree.thirdeye.auth.NamespaceResolver;
 import ai.startree.thirdeye.auth.ThirdEyePrincipal;
-import ai.startree.thirdeye.auth.ThirdEyePrincipal.AuthenticationType;
 import ai.startree.thirdeye.core.DataSourceOnboarder;
 import ai.startree.thirdeye.datasource.cache.DataSourceCache;
 import ai.startree.thirdeye.service.DataSourceService;
 import ai.startree.thirdeye.spi.ThirdEyeStatus;
 import ai.startree.thirdeye.spi.api.StatusApi;
 import ai.startree.thirdeye.spi.api.StatusListApi;
+import ai.startree.thirdeye.spi.auth.AuthenticationType;
 import ai.startree.thirdeye.spi.datalayer.bao.DataSourceManager;
 import ai.startree.thirdeye.spi.datasource.ThirdEyeDataSource;
 import javax.ws.rs.core.Response;

diff --git a/thirdeye-spi/src/main/java/ai/startree/thirdeye/spi/auth/AuthenticationType.java b/thirdeye-spi/src/main/java/ai/startree/thirdeye/spi/auth/AuthenticationType.java
@@ -0,0 +1,5 @@
+package ai.startree.thirdeye.spi.auth;
+
+public enum AuthenticationType {
+  BASIC_AUTH, OAUTH, INTERNAL, DISABLED
+}
diff --git a/thirdeye-spi/src/main/java/ai/startree/thirdeye/spi/auth/IThirdEyePrincipal.java b/thirdeye-spi/src/main/java/ai/startree/thirdeye/spi/auth/IThirdEyePrincipal.java
@@ -0,0 +1,13 @@
+package ai.startree.thirdeye.spi.auth;
+
+import java.security.Principal;
+
+public interface IThirdEyePrincipal extends Principal {
+
+  @Override
+  String getName();
+
+  String getAuthToken();
+
+  AuthenticationType getAuthenticationType();
+}