com.google.gerrit.extensions.auth.oauth

Interface OAuthServiceProvider

public interface OAuthServiceProvider

Method Summary

Modifier and Type	Method and Description
OAuthToken	getAccessToken(OAuthVerifier verifier) Retrieve the access token
java.lang.String	getAuthorizationUrl() Returns the URL where you should redirect your users to authenticate your application.
java.lang.String	getName() Returns the name of this service.
OAuthUserInfo	getUserInfo(OAuthToken token) After establishing of secure communication channel, this method supossed to access the protected resoure and retrieve the username.
java.lang.String	getVersion() Returns the OAuth version of the service.

Method Detail

getAuthorizationUrl

java.lang.String getAuthorizationUrl()

Returns the URL where you should redirect your users to authenticate your application.

Returns:

the OAuth service URL to redirect your users for authentication

getAccessToken

OAuthToken getAccessToken(OAuthVerifier verifier)

Retrieve the access token

Parameters:

verifier - verifier code

Returns:

access token

getUserInfo

OAuthUserInfo getUserInfo(OAuthToken token)
                   throws java.io.IOException

After establishing of secure communication channel, this method supossed to access the protected resoure and retrieve the username.

Parameters:

token -

Returns:

OAuth user information

Throws:

java.io.IOException

getVersion

java.lang.String getVersion()

Returns the OAuth version of the service.

Returns:

oauth version as string

getName

java.lang.String getName()

Returns the name of this service. This name is resented the user to choose between multiple service providers

Returns:

name of the service