org.apache.shindig.gadgets.oauth2.handler

Interface TokenEndpointResponseHandler

All Known Implementing Classes:

TokenAuthorizationResponseHandler

public interface TokenEndpointResponseHandler

When an TokenEndpointResponseHandler is injected into the system it will be called on every response from the token server that it claims to handle. See http://tools.ietf.org/html/draft-ietf-oauth-v2-21#section-4 By default shindig has handlers for the Authorization Code and Client Credential flows.

Method Summary

Methods

Modifier and Type	Method and Description
OAuth2HandlerError	handleResponse(OAuth2Accessor accessor, HttpResponse response) Let the handler do it's magic including any accessor/store updates.
boolean	handlesResponse(OAuth2Accessor accessor, HttpResponse response) Does the handler support this OAuth2Accessor / HttpResponse response?

Method Detail

handleResponse

OAuth2HandlerError handleResponse(OAuth2Accessor accessor,
                                HttpResponse response)

Let the handler do it's magic including any accessor/store updates. If the handler is executed and encountered an error that should stop the authorization process it should return the appropriate OAuth2HandlerError. Applies in particular to the client_credentials flow. See http://tools.ietf.org/html/draft-ietf-oauth-v2-21#section-4.4.1

Parameters:

accessor -

response -

Returns:

see above

handlesResponse

boolean handlesResponse(OAuth2Accessor accessor,
                      HttpResponse response)

Does the handler support this OAuth2Accessor / HttpResponse response?

Parameters:

accessor -

request -

Returns:

true if handleRequest() should be invoked