prerna.auth.AuthProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of semoss Show documentation
SEMOSS
The newest version!
package prerna.auth;

import java.io.Serializable;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import prerna.io.connector.GenericTokenFiller;
import prerna.io.connector.github.GithubTokenFiller;
import prerna.io.connector.gitlab.GitLabTokenFiller;
import prerna.io.connector.google.GoogleTokenFiller;
import prerna.io.connector.ms.MicrosoftTokenFiller;
import prerna.io.connector.okta.OktaTokenFiller;

public enum AuthProvider implements Serializable {

	GOOGLE("GOOGLE", "Google", true, GoogleTokenFiller.class.getName()), 
	GOOGLE_MAP("GOOGLE_MAP", "GoogleMap", true, null),
	GITHUB("GITHUB", "GitHub", true, GithubTokenFiller.class.getName()),
	GITLAB("GITLAB", "GitLab", true, GitLabTokenFiller.class.getName()),
	//TODO: build out custom endpoint in UserResource
	KEYCLOAK("KEYCLOAK", "Keycloak", true, GenericTokenFiller.class.getName()),
	MICROSOFT("MICROSOFT", "Microsoft", true, MicrosoftTokenFiller.class.getName()), // this is azure graph
	SALESFORCE("SALESFORCE", "Salesforce", true, null), 
	SITEMINDER("SITEMINDER", "SiteMinder", true, null),
	SURVEYMONKEY("SURVEYMONKEY", "SurveyMonkey", true, null),
	ADFS("ADFS", "ADFS", true, null),
	OKTA("OKTA", "Okta", true, OktaTokenFiller.class.getName()),

	// native login
	NATIVE("NATIVE", "Native", false, null),
	// saml
	SAML("SAML", "SAML", false, null),
	// using ldap
	LDAP("LDAP", "Active Directory", false, null),
	// linOTP
	LINOTP("LINOTP", "LinOTP", false, null),
	
	// this one is kinda special ...
	CAC("CAC", "CAC", false, null),
	WINDOWS_USER("WINDOWS_USER", "Windows NLTM", false, null),
	API_USER("API_USER", "API Login", false, null),
	
	// these are not used as much ...
	TWITTER("TWITTER", "Twitter", true, null),
	DROPBOX("DROPBOX", "Dropbox", true, null),
	PRODUCT_HUNT("PRODUCT_HUNT", "Product Hunt", true, null),
	LINKEDIN("LINKEDIN", "LinkedIn", true, null),

	// catch all for other OAuth
	GENERIC("GENERIC", "Generic", true, GenericTokenFiller.class.getName()),
	;

	private String label;
	private String displayName;
	private boolean isOAuth;
	private String tokenFillerClass;
	
	AuthProvider(String label, String displayName, boolean isOAuth, String tokenFillerClass) {
		this.label = label;
		this.displayName = displayName;
		this.isOAuth = isOAuth;
		this.tokenFillerClass = tokenFillerClass;
	}
	
	public String getLabel() {
		return label;
	}
	
	public String getDisplayName() {
		return displayName;
	}
	
	public boolean isOAuth() {
		return isOAuth;
	}
	
	public String getTokenFillerClass() {
		return tokenFillerClass;
	}
	
	@Override
	public String toString() {
		return getLabel();
	}
	
	public static AuthProvider getProviderFromString(String authProv) {
		AuthProvider provider = null;
		try {
			provider = AuthProvider.valueOf(authProv.toUpperCase());
		} catch(Exception e){
			provider = AuthProvider.GENERIC;
		}
		return provider;
	}
	
	/**
	 * Get the keys are they should be in the social.properties files
	 * All keys should be the same as the enum name but lower case
	 * @return
	 */
	public static Set getSocialPropKeys() {
		Set vals = new HashSet<>();
		for(AuthProvider auth : AuthProvider.values()) {
			vals.add(auth.name().toLowerCase());
		}
		// TODO: account for legacy MS
		vals.add("ms");
		return vals;
	}
	
	public static Map getSocialPropKeysToEnum() {
		Map vals = new HashMap<>();
		for(AuthProvider auth : AuthProvider.values()) {
			vals.put(auth.name().toLowerCase(), auth);
		}
		// TODO: account for legacy MS
		vals.put("ms", AuthProvider.MICROSOFT);
		
		return vals;
	}
	
	@Deprecated
	public static Map getLabelToLegacyName() {
		Map vals = new HashMap<>();
		for(AuthProvider auth : AuthProvider.values()) {
			vals.put(auth.label, auth.getLegacyName());
		}
		return vals;
	}
	
	/**
	 * Really gross looking... you get things like "Ms", "Cac"...
	 * IF CREATING NEW LOGIC, PLEASE USE AuthProvider.name / getLabel
	 */
	@Deprecated
	private String getLegacyName() {
		return name().charAt(0) + name().substring(1).toLowerCase();
	}

}