Package com.google.appengine.api.oauth

Interface OAuthService

public interface OAuthService

The OAuthService provides methods useful for validating OAuth requests.

See Also:

• RFC 5849 for the OAuth specification.

Method Summary

Modifier and Type	Method	Description
String[]	getAuthorizedScopes(String... scopes)	Return authorized scopes from input scopes.
String	getClientId(String scope)	Returns the client_id from oauth2 request.
String	getClientId(String... scopes)	Returns the client_id from oauth2 request.
User	getCurrentUser()	Returns the User on whose behalf the request was made.
User	getCurrentUser(String scope)	Returns the User on whose behalf the request was made.
User	getCurrentUser(String... scopes)	Returns the User on whose behalf the request was made.
String	getOAuthConsumerKey()	Deprecated. OAuth1 is no longer supported
boolean	isUserAdmin()	Returns true if the user on whose behalf the request was made is an admin for this application, false otherwise.
boolean	isUserAdmin(String scope)	Returns true if the user on whose behalf the request was made is an admin for this application, false otherwise.
boolean	isUserAdmin(String... scopes)	Returns true if the user on whose behalf the request was made is an admin for this application, false otherwise.

Method Details

getCurrentUser

User getCurrentUser()
             throws OAuthRequestException

Returns the User on whose behalf the request was made.

Throws:

OAuthRequestException - If the request was not a valid OAuth request.

OAuthServiceFailureException - If an unknown OAuth error occurred.

getCurrentUser

User getCurrentUser(String scope)
             throws OAuthRequestException

Returns the User on whose behalf the request was made.

Parameters:

scope - The custom OAuth scope that is accepted.

Throws:

OAuthRequestException - If the request was not a valid OAuth request.

OAuthServiceFailureException - If an unknown OAuth error occurred.

getCurrentUser

User getCurrentUser(String... scopes)
             throws OAuthRequestException

Returns the User on whose behalf the request was made.

Parameters:

scopes - The custom OAuth scopes at least one of which is accepted.

Throws:

OAuthRequestException - If the request was not a valid OAuth request.

OAuthServiceFailureException - If an unknown OAuth error occurred.

isUserAdmin

boolean isUserAdmin()
             throws OAuthRequestException

Returns true if the user on whose behalf the request was made is an admin for this application, false otherwise.

Throws:

OAuthRequestException - If the request was not a valid OAuth request.

OAuthServiceFailureException - If an unknown OAuth error occurred.

isUserAdmin

boolean isUserAdmin(String scope)
             throws OAuthRequestException

Returns true if the user on whose behalf the request was made is an admin for this application, false otherwise.

Parameters:

scope - The custom OAuth scope that is accepted.

Throws:

OAuthRequestException - If the request was not a valid OAuth request.

OAuthServiceFailureException - If an unknown OAuth error occurred.

Since:

App Engine 1.7.3.

isUserAdmin

boolean isUserAdmin(String... scopes)
             throws OAuthRequestException

Returns true if the user on whose behalf the request was made is an admin for this application, false otherwise.

Parameters:

scopes - The custom OAuth scopes at least one of which is accepted.

Throws:

OAuthRequestException - If the request was not a valid OAuth request.

OAuthServiceFailureException - If an unknown OAuth error occurred.

getOAuthConsumerKey

@Deprecated
String getOAuthConsumerKey()
                    throws OAuthRequestException

Deprecated.

OAuth1 is no longer supported

Throws OAuthRequestException

Throws:

OAuthRequestException

getClientId

String getClientId(String scope)
            throws OAuthRequestException

Returns the client_id from oauth2 request.

Throws:

OAuthRequestException - If the request was not a valid OAuth2 request.

OAuthServiceFailureException - If an unknown OAuth error occurred.

getClientId

String getClientId(String... scopes)
            throws OAuthRequestException

Returns the client_id from oauth2 request.

Parameters:

scopes - The custom OAuth scopes at least one of which is accepted.

Throws:

OAuthRequestException - If the request was not a valid OAuth2 request.

OAuthServiceFailureException - If an unknown OAuth error occurred.

getAuthorizedScopes

String[] getAuthorizedScopes(String... scopes)
                      throws OAuthRequestException

Return authorized scopes from input scopes.

Parameters:

scopes - The custom OAuth scopes at least one of which is accepted.

Throws:

OAuthRequestException - If the request was not a valid OAuth2 request.

OAuthServiceFailureException - If an unknown OAuth error occurred.