com.google.gerrit.server.account.externalids

Class ExternalId

java.lang.Object

com.google.gerrit.server.account.externalids.ExternalId

All Implemented Interfaces:

java.io.Serializable

public abstract class ExternalId
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalId.Key

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SCHEME_EXTERNAL Scheme for external auth used during authentication, e.g.
static java.lang.String	SCHEME_GERRIT Scheme used for AuthType.LDAP, AuthType.CLIENT_SSL_CERT_LDAP, AuthType.HTTP_LDAP, and AuthType.LDAP_BIND usernames.
static java.lang.String	SCHEME_GPGKEY Scheme used for GPG public keys.
static java.lang.String	SCHEME_MAILTO Scheme used to represent only an email address.
static java.lang.String	SCHEME_USERNAME Scheme for the username used to authenticate an account, e.g.
static java.lang.String	SCHEME_UUID Scheme used for randomly created identities constructed by a UUID.

Constructor Summary

Constructors

Constructor and Description
ExternalId()

Method Summary

Modifier and Type	Method and Description
abstract Account.Id	accountId()
abstract org.eclipse.jgit.lib.ObjectId	blobId() ID of the note blob in the external IDs branch that stores this external ID.
void	checkThatBlobIdIsSet()
static ExternalId	create(ExternalId.Key key, Account.Id accountId)
static ExternalId	create(ExternalId.Key key, Account.Id accountId, java.lang.String email, java.lang.String hashedPassword)
static ExternalId	create(ExternalId.Key key, Account.Id accountId, java.lang.String email, java.lang.String hashedPassword, org.eclipse.jgit.lib.ObjectId blobId)
static ExternalId	create(java.lang.String scheme, java.lang.String id, Account.Id accountId) Creates an external ID.
static ExternalId	create(java.lang.String scheme, java.lang.String id, Account.Id accountId, java.lang.String email, java.lang.String hashedPassword) Creates an external ID.
static ExternalId	createEmail(Account.Id accountId, java.lang.String email)
static ExternalId	createUsername(java.lang.String id, Account.Id accountId, java.lang.String plainPassword) Create a external ID for a username (scheme "username").
static ExternalId	createWithEmail(ExternalId.Key key, Account.Id accountId, java.lang.String email)
static ExternalId	createWithEmail(java.lang.String scheme, java.lang.String id, Account.Id accountId, java.lang.String email) Creates an external ID with an email.
static ExternalId	createWithPassword(ExternalId.Key key, Account.Id accountId, java.lang.String email, java.lang.String plainPassword)
abstract java.lang.String	email()
boolean	equals(java.lang.Object obj) For checking if two external IDs are equals the blobId is excluded and external IDs that have different blob IDs but identical other fields are considered equal.
static java.util.stream.Stream<java.lang.String>	getEmails(java.util.Collection<ExternalId> extIds) Returns all IDs of the provided external IDs that have the SCHEME_MAILTO scheme as a distinct stream.
static java.util.Optional<java.lang.String>	getUserName(java.util.Collection<ExternalId> extIds) Returns the ID of the first external ID from the provided external IDs that has the SCHEME_USERNAME scheme.
int	hashCode()
boolean	isScheme(java.lang.String scheme)
static boolean	isValidUsername(java.lang.String username)
abstract ExternalId.Key	key()
static ExternalId	parse(java.lang.String noteId, byte[] raw, org.eclipse.jgit.lib.ObjectId blobId) Parses an external ID from a byte array that contain the external ID as an Git config file text.
static ExternalId	parse(java.lang.String noteId, org.eclipse.jgit.lib.Config externalIdConfig, org.eclipse.jgit.lib.ObjectId blobId)
abstract java.lang.String	password()
byte[]	toByteArray()
java.lang.String	toString() Exports this external ID as Git config file text.
void	writeToConfig(org.eclipse.jgit.lib.Config c)

Methods inherited from class java.lang.Object

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

Field Detail

SCHEME_GERRIT

public static final java.lang.String SCHEME_GERRIT

Scheme used for AuthType.LDAP, AuthType.CLIENT_SSL_CERT_LDAP, AuthType.HTTP_LDAP, and AuthType.LDAP_BIND usernames.

The name gerrit: was a very poor choice.

Scheme names must not contain colons (':').

See Also:

Constant Field Values

SCHEME_UUID

public static final java.lang.String SCHEME_UUID

Scheme used for randomly created identities constructed by a UUID.

See Also:

Constant Field Values

SCHEME_MAILTO

public static final java.lang.String SCHEME_MAILTO

Scheme used to represent only an email address.

See Also:

Constant Field Values

SCHEME_USERNAME

public static final java.lang.String SCHEME_USERNAME

Scheme for the username used to authenticate an account, e.g. over SSH.

See Also:

Constant Field Values

SCHEME_GPGKEY

public static final java.lang.String SCHEME_GPGKEY

Scheme used for GPG public keys.

See Also:

Constant Field Values

SCHEME_EXTERNAL

public static final java.lang.String SCHEME_EXTERNAL

Scheme for external auth used during authentication, e.g. OAuth Token

See Also:

Constant Field Values

Constructor Detail

ExternalId

public ExternalId()

Method Detail

isValidUsername

public static boolean isValidUsername(java.lang.String username)

getUserName

public static java.util.Optional<java.lang.String> getUserName(java.util.Collection<ExternalId> extIds)

Returns the ID of the first external ID from the provided external IDs that has the SCHEME_USERNAME scheme.

Parameters:

extIds - external IDs

Returns:

the ID of the first external ID from the provided external IDs that has the SCHEME_USERNAME scheme

getEmails

public static java.util.stream.Stream<java.lang.String> getEmails(java.util.Collection<ExternalId> extIds)

Returns all IDs of the provided external IDs that have the SCHEME_MAILTO scheme as a distinct stream.

Parameters:

extIds - external IDs

Returns:

distinct stream of all IDs of the provided external IDs that have the SCHEME_MAILTO scheme

create

public static ExternalId create(java.lang.String scheme,
                                java.lang.String id,
                                Account.Id accountId)

Creates an external ID.

Parameters:

scheme - the scheme name, must not contain colons (':')

id - the external ID, must not contain colons (':')

accountId - the ID of the account to which the external ID belongs

Returns:

the created external ID

create

public static ExternalId create(java.lang.String scheme,
                                java.lang.String id,
                                Account.Id accountId,
                                java.lang.String email,
                                java.lang.String hashedPassword)

Creates an external ID.

Parameters:

scheme - the scheme name, must not contain colons (':')

id - the external ID, must not contain colons (':')

accountId - the ID of the account to which the external ID belongs

email - the email of the external ID, may be null

hashedPassword - the hashed password of the external ID, may be null

Returns:

the created external ID

create

public static ExternalId create(ExternalId.Key key,
                                Account.Id accountId)

create

public static ExternalId create(ExternalId.Key key,
                                Account.Id accountId,
                                java.lang.String email,
                                java.lang.String hashedPassword)

createWithPassword

public static ExternalId createWithPassword(ExternalId.Key key,
                                            Account.Id accountId,
                                            java.lang.String email,
                                            java.lang.String plainPassword)

createUsername

public static ExternalId createUsername(java.lang.String id,
                                        Account.Id accountId,
                                        java.lang.String plainPassword)

Create a external ID for a username (scheme "username").

Parameters:

id - the external ID, must not contain colons (':')

accountId - the ID of the account to which the external ID belongs

plainPassword - the plain HTTP password, may be null

Returns:

the created external ID

createWithEmail

public static ExternalId createWithEmail(java.lang.String scheme,
                                         java.lang.String id,
                                         Account.Id accountId,
                                         java.lang.String email)

Creates an external ID with an email.

Parameters:

scheme - the scheme name, must not contain colons (':')

id - the external ID, must not contain colons (':')

accountId - the ID of the account to which the external ID belongs

email - the email of the external ID, may be null

Returns:

the created external ID

createWithEmail

public static ExternalId createWithEmail(ExternalId.Key key,
                                         Account.Id accountId,
                                         java.lang.String email)

createEmail

public static ExternalId createEmail(Account.Id accountId,
                                     java.lang.String email)

create

public static ExternalId create(ExternalId.Key key,
                                Account.Id accountId,
                                java.lang.String email,
                                java.lang.String hashedPassword,
                                org.eclipse.jgit.lib.ObjectId blobId)

parse

public static ExternalId parse(java.lang.String noteId,
                               byte[] raw,
                               org.eclipse.jgit.lib.ObjectId blobId)
                        throws org.eclipse.jgit.errors.ConfigInvalidException

Parses an external ID from a byte array that contain the external ID as an Git config file text.

The Git config must have exactly one externalId subsection with an accountId and optionally email and password:

 [externalId "username:jdoe"]
   accountId = 1003407
   email = [email protected]
   password = bcrypt:4:LCbmSBDivK/hhGVQMfkDpA==:XcWn0pKYSVU/UJgOvhidkEtmqCp6oKB7
 

Throws:

org.eclipse.jgit.errors.ConfigInvalidException

parse

public static ExternalId parse(java.lang.String noteId,
                               org.eclipse.jgit.lib.Config externalIdConfig,
                               org.eclipse.jgit.lib.ObjectId blobId)
                        throws org.eclipse.jgit.errors.ConfigInvalidException

Throws:

org.eclipse.jgit.errors.ConfigInvalidException

key

public abstract ExternalId.Key key()

accountId

public abstract Account.Id accountId()

email

public abstract java.lang.String email()

password

public abstract java.lang.String password()

blobId

public abstract org.eclipse.jgit.lib.ObjectId blobId()

ID of the note blob in the external IDs branch that stores this external ID. null if the external ID was created in code and is not yet stored in Git.

checkThatBlobIdIsSet

public void checkThatBlobIdIsSet()

isScheme

public boolean isScheme(java.lang.String scheme)

toByteArray

public byte[] toByteArray()

equals

public final boolean equals(java.lang.Object obj)

For checking if two external IDs are equals the blobId is excluded and external IDs that have different blob IDs but identical other fields are considered equal. This way an external ID that was loaded from Git can be equal with an external ID that was created from code.

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public final java.lang.String toString()

Exports this external ID as Git config file text.

The Git config has exactly one externalId subsection with an accountId and optionally email and password:

 [externalId "username:jdoe"]
   accountId = 1003407
   email = [email protected]
   password = bcrypt:4:LCbmSBDivK/hhGVQMfkDpA==:XcWn0pKYSVU/UJgOvhidkEtmqCp6oKB7
 

Overrides:

toString in class java.lang.Object

writeToConfig

public void writeToConfig(org.eclipse.jgit.lib.Config c)