Package com.google.gerrit.server.account

Class AccountResolver

java.lang.Object

com.google.gerrit.server.account.AccountResolver

public class AccountResolver
extends Object

Helper for resolving accounts given arbitrary user-provided input.

The resolve* methods each define a list of accepted formats for account resolution. The algorithm for resolving accounts from a list of formats is as follows:

1. For each recognized format in the order listed in the method Javadoc, check whether the input matches that format.
2. If so, resolve accounts according to that format.
3. Filter out invisible and inactive accounts.
4. If the result list is non-empty, return.
5. If the format is listed above as being short-circuiting, return.
6. Otherwise, return to step 1 with the next format.

The result never includes accounts that are not visible to the calling user. It also never includes inactive accounts, with a small number of specific exceptions noted in method Javadoc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AccountResolver.Result
static class	AccountResolver.UnresolvableAccountException

Method Summary

Modifier and Type	Method	Description
static String	exceptionMessage(AccountResolver.Result result)
static boolean	isSelf(String input)
AccountResolver.Result	resolve(String input)	Resolves all accounts matching the input string, visible to the current user.
AccountResolver.Result	resolve(String input, Predicate<AccountState> accountActivityPredicate)
AccountResolver.Result	resolveAsUser(CurrentUser asUser, String input)	Resolves all accounts matching the input string, visible to the provided user.
AccountResolver.Result	resolveAsUser(CurrentUser asUser, String input, Predicate<AccountState> accountActivityPredicate)
AccountResolver.Result	resolveAsUserIgnoreVisibility(CurrentUser asUser, String input)
AccountResolver.Result	resolveAsUserIgnoreVisibility(CurrentUser asUser, String input, Predicate<AccountState> accountActivityPredicate)
AccountResolver.Result	resolveByExactNameOrEmail(String input)	Deprecated. for use only by MailUtil for parsing commit footers; that class needs to be reevaluated.
AccountResolver.Result	resolveByNameOrEmail(String input)	Deprecated. for use only by MailUtil for parsing commit footers; that class needs to be reevaluated.
AccountResolver.Result	resolveExact(String input)	Resolves accounts using exact searchers.
AccountResolver.Result	resolveExactIgnoreVisibility(String input)
AccountResolver.Result	resolveIgnoreVisibility(String input)
AccountResolver.Result	resolveIncludeInactive(String input)	As opposed to resolve(java.lang.String), the returned result includes all inactive accounts for the input search.
AccountResolver.Result	resolveIncludeInactiveIgnoreVisibility(String input)

Methods inherited from class java.lang.Object

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

Method Details

exceptionMessage

public static String exceptionMessage(AccountResolver.Result result)

isSelf

public static boolean isSelf(String input)

resolve

public AccountResolver.Result resolve(String input)
                               throws org.eclipse.jgit.errors.ConfigInvalidException,
IOException

Resolves all accounts matching the input string, visible to the current user.

The following input formats are recognized:

• The strings "self" and "me", if the current user is an IdentifiedUser. In this case, may return exactly one inactive account.
• A bare account ID ("18419"). In this case, may return exactly one inactive account. This case short-circuits if the input matches.
• An account ID in parentheses following a full name ("Full Name (18419)"). This case short-circuits if the input matches.
• A username ("username").
• A full name and email address ("Full Name <email@example>"). This case short-circuits if the input matches.
• An email address ("email@example". This case short-circuits if the input matches.
• An account name recognized by the configured Realm.lookup(String) Realm}.
• A full name ("Full Name").
• As a fallback, a default search against the account index.

Parameters:

input - input string.

Returns:

a result describing matching accounts. Never null even if the result set is empty.

Throws:

org.eclipse.jgit.errors.ConfigInvalidException - if an error occurs.

IOException - if an error occurs.

resolveExact

public AccountResolver.Result resolveExact(String input)
                                    throws org.eclipse.jgit.errors.ConfigInvalidException,
IOException

Resolves accounts using exact searchers. Similar to the previous method.

Throws:

org.eclipse.jgit.errors.ConfigInvalidException

IOException

resolve

public AccountResolver.Result resolve(String input,
 Predicate<AccountState> accountActivityPredicate)
                               throws org.eclipse.jgit.errors.ConfigInvalidException,
IOException

Throws:

org.eclipse.jgit.errors.ConfigInvalidException

IOException

resolveAsUser

public AccountResolver.Result resolveAsUser(CurrentUser asUser,
 String input)
                                     throws org.eclipse.jgit.errors.ConfigInvalidException,
IOException

Resolves all accounts matching the input string, visible to the provided user.

The following input formats are recognized:

• The strings "self" and "me", if the provided user is an IdentifiedUser. In this case, may return exactly one inactive account.
• A bare account ID ("18419"). In this case, may return exactly one inactive account. This case short-circuits if the input matches.
• An account ID in parentheses following a full name ("Full Name (18419)"). This case short-circuits if the input matches.
• A username ("username").
• A full name and email address ("Full Name <email@example>"). This case short-circuits if the input matches.
• An email address ("email@example". This case short-circuits if the input matches.
• An account name recognized by the configured Realm.lookup(String) Realm}.
• A full name ("Full Name").
• As a fallback, a default search against the account index.

Parameters:

asUser - user to resolve the users by.

input - input string.

Returns:

a result describing matching accounts. Never null even if the result set is empty.

Throws:

org.eclipse.jgit.errors.ConfigInvalidException - if an error occurs.

IOException - if an error occurs.

resolveAsUser

public AccountResolver.Result resolveAsUser(CurrentUser asUser,
 String input,
 Predicate<AccountState> accountActivityPredicate)
                                     throws org.eclipse.jgit.errors.ConfigInvalidException,
IOException

Throws:

org.eclipse.jgit.errors.ConfigInvalidException

IOException

resolveIncludeInactive

public AccountResolver.Result resolveIncludeInactive(String input)
                                              throws org.eclipse.jgit.errors.ConfigInvalidException,
IOException

As opposed to resolve(java.lang.String), the returned result includes all inactive accounts for the input search.

This can be used to resolve Gerrit Account from email to its Account.Id, to make sure that if Account with such email exists in Gerrit (even inactive), user data (email address) won't be recorded as it is, but instead will be stored as a link to the corresponding Gerrit Account.

Throws:

org.eclipse.jgit.errors.ConfigInvalidException

IOException

resolveIncludeInactiveIgnoreVisibility

public AccountResolver.Result resolveIncludeInactiveIgnoreVisibility(String input)
                                                              throws org.eclipse.jgit.errors.ConfigInvalidException,
IOException

Throws:

org.eclipse.jgit.errors.ConfigInvalidException

IOException

resolveIgnoreVisibility

public AccountResolver.Result resolveIgnoreVisibility(String input)
                                               throws org.eclipse.jgit.errors.ConfigInvalidException,
IOException

Throws:

org.eclipse.jgit.errors.ConfigInvalidException

IOException

resolveExactIgnoreVisibility

public AccountResolver.Result resolveExactIgnoreVisibility(String input)
                                                    throws org.eclipse.jgit.errors.ConfigInvalidException,
IOException

Throws:

org.eclipse.jgit.errors.ConfigInvalidException

IOException

resolveAsUserIgnoreVisibility

public AccountResolver.Result resolveAsUserIgnoreVisibility(CurrentUser asUser,
 String input)
                                                     throws org.eclipse.jgit.errors.ConfigInvalidException,
IOException

Throws:

org.eclipse.jgit.errors.ConfigInvalidException

IOException

resolveAsUserIgnoreVisibility

public AccountResolver.Result resolveAsUserIgnoreVisibility(CurrentUser asUser,
 String input,
 Predicate<AccountState> accountActivityPredicate)
                                                     throws org.eclipse.jgit.errors.ConfigInvalidException,
IOException

Throws:

org.eclipse.jgit.errors.ConfigInvalidException

IOException

resolveByNameOrEmail

@Deprecated
public AccountResolver.Result resolveByNameOrEmail(String input)
                                            throws org.eclipse.jgit.errors.ConfigInvalidException,
IOException

Deprecated.

for use only by MailUtil for parsing commit footers; that class needs to be reevaluated.

Resolves all accounts matching the input string by name or email.

The following input formats are recognized:

• A full name and email address ("Full Name <email@example>"). This case short-circuits if the input matches.
• An email address ("email@example". This case short-circuits if the input matches.
• An account name recognized by the configured Realm.lookup(String) Realm}.
• A full name ("Full Name").
• As a fallback, a default search against the account index.

Parameters:

input - input string.

Returns:

a result describing matching accounts. Never null even if the result set is empty.

Throws:

org.eclipse.jgit.errors.ConfigInvalidException - if an error occurs.

IOException - if an error occurs.

resolveByExactNameOrEmail

@Deprecated
public AccountResolver.Result resolveByExactNameOrEmail(String input)
                                                 throws org.eclipse.jgit.errors.ConfigInvalidException,
IOException

Deprecated.

for use only by MailUtil for parsing commit footers; that class needs to be reevaluated.

Same as resolveByNameOrEmail(String), but with exact matching for the full name, email and full name.

Parameters:

input - input string.

Returns:

a result describing matching accounts. Never null even if the result set is empty.

Throws:

org.eclipse.jgit.errors.ConfigInvalidException - if an error occurs.

IOException - if an error occurs.