org.springframework.security.oauth2.provider.response

Interface AuthorizationRequestViewResolver

All Known Implementing Classes:

DefaultAuthorizationRequestViewResolver

public interface AuthorizationRequestViewResolver

AuthorizationRequestViewResolver is responsible for constructing the Views returned to the requester in response to an AuthorizationRequest for the OAuth2 flows.

Author:

Okke Harsta

Method Summary

Modifier and Type	Method and Description
org.springframework.web.servlet.View	getSuccessfulAuthorizationCodeView(AuthorizationRequest authorizationRequest, String authorizationCode) Resolve the resulting View for the AuthorizationCode flow
org.springframework.web.servlet.View	getSuccessfulImplicitGrantView(AuthorizationRequest authorizationRequest, OAuth2AccessToken accessToken) Resolve the resulting View for the ImplicitGrant flow
org.springframework.web.servlet.View	getUnsuccessfulView(AuthorizationRequest authorizationRequest, OAuth2Exception failure) Resolve the resulting View for a unsuccessful authorization request.

Method Detail

getSuccessfulAuthorizationCodeView

org.springframework.web.servlet.View getSuccessfulAuthorizationCodeView(AuthorizationRequest authorizationRequest,
                                                                        String authorizationCode)

Resolve the resulting View for the AuthorizationCode flow

Parameters:

authorizationRequest - the authorization request from the user

authorizationCode - the code to exchange for a token

Returns:

View containing the authorizationCode

getSuccessfulImplicitGrantView

org.springframework.web.servlet.View getSuccessfulImplicitGrantView(AuthorizationRequest authorizationRequest,
                                                                    OAuth2AccessToken accessToken)

Resolve the resulting View for the ImplicitGrant flow

Parameters:

authorizationRequest - the authorization request from the user

accessToken - the accessToken to include in the redirect

Returns:

View containing the accessToken

getUnsuccessfulView

org.springframework.web.servlet.View getUnsuccessfulView(AuthorizationRequest authorizationRequest,
                                                         OAuth2Exception failure)

Resolve the resulting View for a unsuccessful authorization request. Note that it must handle both ImplicitGrant and AuthorizationCode requests (e.g. use the fragment or not)

Parameters:

authorizationRequest - the authorization request from the user

failure - reason why it went wrong

Returns:

View with the exposed error