org.apache.shindig.gadgets.oauth2.handler

Interface GrantRequestHandler

All Known Implementing Classes:

ClientCredentialsGrantTypeHandler, CodeGrantTypeHandler

public interface GrantRequestHandler

Enables injection of new Grant Type schemes into the system. If a getGrantType() matches a OAuth2Accessor.getGrantType() it will be invoked to initiate the grant request. By default "code" and "client_credentials" are supported. Only one GrantRequestHandler will be executed (first to match.)

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	getAuthorizationRequest(OAuth2Accessor accessor, String completeAuthorizationUrl) If isRedirectRequired() is false the system will executes this request.
String	getCompleteUrl(OAuth2Accessor accessor) Url to send redirects to.
String	getGrantType()
boolean	isAuthorizationEndpointResponse()
boolean	isRedirectRequired()
boolean	isTokenEndpointResponse()

Method Detail

getAuthorizationRequest

HttpRequest getAuthorizationRequest(OAuth2Accessor accessor,
                                  String completeAuthorizationUrl)
                                    throws OAuth2RequestException

If isRedirectRequired() is false the system will executes this request.

Parameters:

accessor -

completeAuthorizationUrl -

Returns:

HttpRequest

Throws:

OAuth2RequestException

getCompleteUrl

String getCompleteUrl(OAuth2Accessor accessor)
                      throws OAuth2RequestException

Url to send redirects to.

Parameters:

accessor -

Returns:

String complete url

Throws:

OAuth2RequestException

getGrantType

String getGrantType()

Returns:

the grant_type this handler initiates

isAuthorizationEndpointResponse

boolean isAuthorizationEndpointResponse()

Returns:

true if the response is from the authorization endpoint, i.e. code

isRedirectRequired

boolean isRedirectRequired()

Returns:

true to redirect the client to the getCompleteUrl(OAuth2Accessor)

isTokenEndpointResponse

boolean isTokenEndpointResponse()

Returns:

true if the response is from the token endpoint i.e. client_credentials