org.apache.shindig.gadgets.oauth2.handler

Interface AuthorizationEndpointResponseHandler

All Known Implementing Classes:

CodeAuthorizationResponseHandler

public interface AuthorizationEndpointResponseHandler

When an AuthorizationEndpointResponseHandler is injected into the system it will be called on every response from the authorization server that it claims to handle. It may not make sense for a single handler to support both requests and responses but it must support at least one. 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	handleRequest(OAuth2Accessor accessor, javax.servlet.http.HttpServletRequest request) Let the handler do it's magic including any accessor/store updates.
OAuth2HandlerError	handleResponse(OAuth2Accessor accessor, HttpResponse response) Let the handler do it's magic including any accessor/store updates.
boolean	handlesRequest(OAuth2Accessor accessor, javax.servlet.http.HttpServletRequest request) Does the handler support this OAuth2Accessor / HttpServletRequest response? The presumably has come from the OAuth2CallbackServlet or somewhere similar.
boolean	handlesResponse(OAuth2Accessor accessor, HttpResponse response) Does the handler support thisOAuth2Accessor / HttpResponse response?

Method Detail

handleRequest

OAuth2HandlerError handleRequest(OAuth2Accessor accessor,
                               javax.servlet.http.HttpServletRequest request)

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 Authorization Code flow redirect. See http://tools.ietf.org/html/draft-ietf-oauth-v2-21#section-4.1.2

Parameters:

accessor -

response -

Returns:

see above

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

handlesRequest

boolean handlesRequest(OAuth2Accessor accessor,
                     javax.servlet.http.HttpServletRequest request)

Does the handler support this OAuth2Accessor / HttpServletRequest response? The presumably has come from the OAuth2CallbackServlet or somewhere similar.

Parameters:

accessor -

request -

Returns:

true if handleRequest() should be invoked

handlesResponse

boolean handlesResponse(OAuth2Accessor accessor,
                      HttpResponse response)

Does the handler support thisOAuth2Accessor / HttpResponse response?

Parameters:

accessor -

response -

Returns:

true if handleRequest() should be invoked