com.google.gerrit.server.account

Class AuthRequest

java.lang.Object

com.google.gerrit.server.account.AuthRequest

public class AuthRequest
extends java.lang.Object

Information for AccountManager.authenticate(AuthRequest).

Callers should populate this object with as much information as possible about the user account. For example, OpenID authentication might return registration information including a display name for the user, and an email address for them. These fields however are optional, as not all OpenID providers return them, and not all non-OpenID systems can use them.

Constructor Summary

Constructors

Constructor and Description
AuthRequest(ExternalId.Key externalId)

Method Summary

Modifier and Type	Method and Description
boolean	authProvidesAccountActiveStatus()
static AuthRequest	forEmail(java.lang.String email) Create a request for an email address registration.
static AuthRequest	forExternalUser(java.lang.String username) Create a request for an external username.
static AuthRequest	forUser(java.lang.String username) Create a request for a local username, such as from LDAP.
java.lang.String	getAuthPlugin()
java.lang.String	getAuthProvider()
java.lang.String	getDisplayName()
java.lang.String	getEmailAddress()
ExternalId.Key	getExternalIdKey()
java.lang.String	getLocalUser()
java.lang.String	getPassword()
java.util.Optional<java.lang.String>	getUserName()
boolean	isActive()
boolean	isSkipAuthentication()
void	setActive(java.lang.Boolean isActive)
void	setAuthPlugin(java.lang.String authPlugin)
void	setAuthProvider(java.lang.String authProvider)
void	setAuthProvidesAccountActiveStatus(boolean authProvidesAccountActiveStatus)
void	setDisplayName(java.lang.String name)
void	setEmailAddress(java.lang.String email)
void	setLocalUser(java.lang.String localUser)
void	setPassword(java.lang.String pass)
void	setSkipAuthentication(boolean skip)
void	setUserName(java.lang.String user)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthRequest

public AuthRequest(ExternalId.Key externalId)

Method Detail

forUser

public static AuthRequest forUser(java.lang.String username)

Create a request for a local username, such as from LDAP.

forExternalUser

public static AuthRequest forExternalUser(java.lang.String username)

Create a request for an external username.

forEmail

public static AuthRequest forEmail(java.lang.String email)

Create a request for an email address registration.

This type of request should be used only to attach a new email address to an existing user account.

getExternalIdKey

public ExternalId.Key getExternalIdKey()

getLocalUser

public java.lang.String getLocalUser()

setLocalUser

public void setLocalUser(java.lang.String localUser)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String pass)

getDisplayName

public java.lang.String getDisplayName()

setDisplayName

public void setDisplayName(java.lang.String name)

getEmailAddress

public java.lang.String getEmailAddress()

setEmailAddress

public void setEmailAddress(java.lang.String email)

getUserName

public java.util.Optional<java.lang.String> getUserName()

setUserName

public void setUserName(java.lang.String user)

isSkipAuthentication

public boolean isSkipAuthentication()

setSkipAuthentication

public void setSkipAuthentication(boolean skip)

getAuthPlugin

public java.lang.String getAuthPlugin()

setAuthPlugin

public void setAuthPlugin(java.lang.String authPlugin)

getAuthProvider

public java.lang.String getAuthProvider()

setAuthProvider

public void setAuthProvider(java.lang.String authProvider)

authProvidesAccountActiveStatus

public boolean authProvidesAccountActiveStatus()

setAuthProvidesAccountActiveStatus

public void setAuthProvidesAccountActiveStatus(boolean authProvidesAccountActiveStatus)

isActive

public boolean isActive()

setActive

public void setActive(java.lang.Boolean isActive)