Package io.lakefs.clients.api.model

Class LoginConfig

java.lang.Object

io.lakefs.clients.api.model.LoginConfig

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class LoginConfig
extends Object

LoginConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LoginConfig.CustomTypeAdapterFactory
static class	LoginConfig.RBACEnum	RBAC will remain enabled on GUI if \"external\".

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_FALLBACK_LOGIN_LABEL
static String	SERIALIZED_NAME_FALLBACK_LOGIN_URL
static String	SERIALIZED_NAME_LOGIN_COOKIE_NAMES
static String	SERIALIZED_NAME_LOGIN_FAILED_MESSAGE
static String	SERIALIZED_NAME_LOGIN_URL
static String	SERIALIZED_NAME_LOGOUT_URL
static String	SERIALIZED_NAME_R_B_A_C

Constructor Summary

Constructors

Constructor	Description
LoginConfig()

Method Summary

Modifier and Type	Method	Description
LoginConfig	addLoginCookieNamesItem(String loginCookieNamesItem)
boolean	equals(Object o)
LoginConfig	fallbackLoginLabel(String fallbackLoginLabel)
LoginConfig	fallbackLoginUrl(String fallbackLoginUrl)
static LoginConfig	fromJson(String jsonString)	Create an instance of LoginConfig given an JSON string
String	getFallbackLoginLabel()	label to place on fallback_login_url.
String	getFallbackLoginUrl()	secondary URL to offer users to use for login.
List<String>	getLoginCookieNames()	cookie names used to store JWT
String	getLoginFailedMessage()	message to display to users who fail to login; a full sentence that is rendered in HTML and may contain a link to a secondary login method
String	getLoginUrl()	primary URL to use for login.
String	getLogoutUrl()	URL to use for logging out.
LoginConfig.RBACEnum	getRBAC()	RBAC will remain enabled on GUI if \"external\".
int	hashCode()
LoginConfig	loginCookieNames(List<String> loginCookieNames)
LoginConfig	loginFailedMessage(String loginFailedMessage)
LoginConfig	loginUrl(String loginUrl)
LoginConfig	logoutUrl(String logoutUrl)
LoginConfig	RBAC(LoginConfig.RBACEnum RBAC)
void	setFallbackLoginLabel(String fallbackLoginLabel)
void	setFallbackLoginUrl(String fallbackLoginUrl)
void	setLoginCookieNames(List<String> loginCookieNames)
void	setLoginFailedMessage(String loginFailedMessage)
void	setLoginUrl(String loginUrl)
void	setLogoutUrl(String logoutUrl)
void	setRBAC(LoginConfig.RBACEnum RBAC)
String	toJson()	Convert an instance of LoginConfig to an JSON string
String	toString()
static void	validateJsonObject(com.google.gson.JsonObject jsonObj)	Validates the JSON Object and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_R_B_A_C

public static final String SERIALIZED_NAME_R_B_A_C

See Also:

Constant Field Values

SERIALIZED_NAME_LOGIN_URL

public static final String SERIALIZED_NAME_LOGIN_URL

See Also:

Constant Field Values

SERIALIZED_NAME_LOGIN_FAILED_MESSAGE

public static final String SERIALIZED_NAME_LOGIN_FAILED_MESSAGE

See Also:

Constant Field Values

SERIALIZED_NAME_FALLBACK_LOGIN_URL

public static final String SERIALIZED_NAME_FALLBACK_LOGIN_URL

See Also:

Constant Field Values

SERIALIZED_NAME_FALLBACK_LOGIN_LABEL

public static final String SERIALIZED_NAME_FALLBACK_LOGIN_LABEL

See Also:

Constant Field Values

SERIALIZED_NAME_LOGIN_COOKIE_NAMES

public static final String SERIALIZED_NAME_LOGIN_COOKIE_NAMES

See Also:

Constant Field Values

SERIALIZED_NAME_LOGOUT_URL

public static final String SERIALIZED_NAME_LOGOUT_URL

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

LoginConfig

public LoginConfig()

Method Detail

RBAC

public LoginConfig RBAC(LoginConfig.RBACEnum RBAC)

getRBAC

@Nullable
public LoginConfig.RBACEnum getRBAC()

RBAC will remain enabled on GUI if \"external\". That only works with an external auth service.

Returns:

RBAC

setRBAC

public void setRBAC(LoginConfig.RBACEnum RBAC)

loginUrl

public LoginConfig loginUrl(String loginUrl)

getLoginUrl

@Nonnull
public String getLoginUrl()

primary URL to use for login.

Returns:

loginUrl

setLoginUrl

public void setLoginUrl(String loginUrl)

loginFailedMessage

public LoginConfig loginFailedMessage(String loginFailedMessage)

getLoginFailedMessage

@Nullable
public String getLoginFailedMessage()

message to display to users who fail to login; a full sentence that is rendered in HTML and may contain a link to a secondary login method

Returns:

loginFailedMessage

setLoginFailedMessage

public void setLoginFailedMessage(String loginFailedMessage)

fallbackLoginUrl

public LoginConfig fallbackLoginUrl(String fallbackLoginUrl)

getFallbackLoginUrl

@Nullable
public String getFallbackLoginUrl()

secondary URL to offer users to use for login.

Returns:

fallbackLoginUrl

setFallbackLoginUrl

public void setFallbackLoginUrl(String fallbackLoginUrl)

fallbackLoginLabel

public LoginConfig fallbackLoginLabel(String fallbackLoginLabel)

getFallbackLoginLabel

@Nullable
public String getFallbackLoginLabel()

label to place on fallback_login_url.

Returns:

fallbackLoginLabel

setFallbackLoginLabel

public void setFallbackLoginLabel(String fallbackLoginLabel)

loginCookieNames

public LoginConfig loginCookieNames(List<String> loginCookieNames)

addLoginCookieNamesItem

public LoginConfig addLoginCookieNamesItem(String loginCookieNamesItem)

getLoginCookieNames

@Nonnull
public List<String> getLoginCookieNames()

cookie names used to store JWT

Returns:

loginCookieNames

setLoginCookieNames

public void setLoginCookieNames(List<String> loginCookieNames)

logoutUrl

public LoginConfig logoutUrl(String logoutUrl)

getLogoutUrl

@Nonnull
public String getLogoutUrl()

URL to use for logging out.

Returns:

logoutUrl

setLogoutUrl

public void setLogoutUrl(String logoutUrl)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

IOException - if the JSON Object is invalid with respect to LoginConfig

fromJson

public static LoginConfig fromJson(String jsonString)
                            throws IOException

Create an instance of LoginConfig given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of LoginConfig

Throws:

IOException - if the JSON string is invalid with respect to LoginConfig

toJson

public String toJson()

Convert an instance of LoginConfig to an JSON string

Returns:

JSON string