com.google.gerrit.server.account

Class AccountManager

java.lang.Object

com.google.gerrit.server.account.AccountManager

public class AccountManager
extends java.lang.Object

Tracks authentication related details for user accounts.

Method Summary

Modifier and Type	Method and Description
AuthResult	authenticate(AuthRequest who) Authenticate the user, potentially creating a new account if they are new.
AuthResult	link(Account.Id to, AuthRequest who) Link another authentication identity to an existing account.
java.util.Optional<Account.Id>	lookup(java.lang.String externalId)
AuthResult	unlink(Account.Id from, AuthRequest who) Unlink an authentication identity from an existing account.
AuthResult	updateLink(Account.Id to, AuthRequest who) Update the link to another unique authentication identity to an existing account.

Methods inherited from class java.lang.Object

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

Method Detail

lookup

public java.util.Optional<Account.Id> lookup(java.lang.String externalId)
                                      throws AccountException

Returns:

user identified by this external identity string

Throws:

AccountException

authenticate

public AuthResult authenticate(AuthRequest who)
                        throws AccountException,
                               java.io.IOException

Authenticate the user, potentially creating a new account if they are new.

Parameters:

who - identity of the user, with any details we received about them.

Returns:

the result of authenticating the user.

Throws:

AccountException - the account does not exist, and cannot be created, or exists, but cannot be located, or is inactive.

java.io.IOException

link

public AuthResult link(Account.Id to,
                       AuthRequest who)
                throws AccountException,
                       com.google.gwtorm.server.OrmException,
                       java.io.IOException

Link another authentication identity to an existing account.

Parameters:

to - account to link the identity onto.

who - the additional identity.

Returns:

the result of linking the identity to the user.

Throws:

AccountException - the identity belongs to a different account, or it cannot be linked at this time.

com.google.gwtorm.server.OrmException

java.io.IOException

updateLink

public AuthResult updateLink(Account.Id to,
                             AuthRequest who)
                      throws com.google.gwtorm.server.OrmException,
                             AccountException,
                             java.io.IOException

Update the link to another unique authentication identity to an existing account.

Existing external identities with the same scheme will be removed and replaced with the new one.

Parameters:

to - account to link the identity onto.

who - the additional identity.

Returns:

the result of linking the identity to the user.

Throws:

com.google.gwtorm.server.OrmException

AccountException - the identity belongs to a different account, or it cannot be linked at this time.

java.io.IOException

unlink

public AuthResult unlink(Account.Id from,
                         AuthRequest who)
                  throws AccountException,
                         com.google.gwtorm.server.OrmException,
                         java.io.IOException

Unlink an authentication identity from an existing account.

Parameters:

from - account to unlink the identity from.

who - the identity to delete

Returns:

the result of unlinking the identity from the user.

Throws:

AccountException - the identity belongs to a different account, or it cannot be unlinked at this time.

com.google.gwtorm.server.OrmException

java.io.IOException