com.google.gerrit.extensions.auth.oauth

Interface OAuthLoginProvider

public interface OAuthLoginProvider

Method Summary

Modifier and Type	Method and Description
OAuthUserInfo	login(java.lang.String username, java.lang.String secret) Performs a login with an OAuth2 provider for Git over HTTP communication.

Method Detail

login

OAuthUserInfo login(java.lang.String username,
                    java.lang.String secret)
             throws java.io.IOException

Performs a login with an OAuth2 provider for Git over HTTP communication.

An implementation of this interface must transmit the given user name and secret, which can be either an OAuth2 access token or a password, to the OAuth2 backend for verification.

Parameters:

username - the user's identifier.

secret - the secret to verify, e.g. a previously received access token or a password.

Returns:

information about the logged in user, at least external id, user name and email address.

Throws:

java.io.IOException - if the login failed.