org.springframework.security.oauth2.provider

Interface OAuth2RequestFactory

All Known Implementing Classes:

DefaultOAuth2RequestFactory

public interface OAuth2RequestFactory

Strategy for managing OAuth2 requests: AuthorizationRequest, TokenRequest, OAuth2Request.

Author:

Dave Syer, Amanda Anganes

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationRequest	createAuthorizationRequest(Map<String,String> authorizationParameters) Create a new AuthorizationRequest extracting all the needed information from the incoming parameter map, and initializing all individual fields on the AuthorizationRequest to reasonable values.
OAuth2Request	createOAuth2Request(AuthorizationRequest request) Create a new OAuth2Request by extracting the needed information from the current AuthorizationRequest object.
OAuth2Request	createOAuth2Request(ClientDetails client, TokenRequest tokenRequest) Create a new OAuth2Request by extracting the needed information from the current TokenRequest object.
TokenRequest	createTokenRequest(AuthorizationRequest authorizationRequest, String grantType) Create a new TokenRequest from an AuthorizationRequest.
TokenRequest	createTokenRequest(Map<String,String> requestParameters, ClientDetails authenticatedClient) Create a new TokenRequest by extracting the needed information from the incoming request parameter map.

Method Detail

createAuthorizationRequest

AuthorizationRequest createAuthorizationRequest(Map<String,String> authorizationParameters)

Create a new AuthorizationRequest extracting all the needed information from the incoming parameter map, and initializing all individual fields on the AuthorizationRequest to reasonable values. When a class uses the factory to create an AuthorizationRequest, it should not need to access the parameter map directly afterwards. Typical implementations would initialize the individual fields on the AuthorizationRequest with the values requested in the original parameter map. It may also load the client details from the client id provided and validate the grant type and scopes, populating any fields in the request that are known only to the authorization server.

Parameters:

authorizationParameters - the parameters in the request

Returns:

a new AuthorizationRequest

createOAuth2Request

OAuth2Request createOAuth2Request(AuthorizationRequest request)

Create a new OAuth2Request by extracting the needed information from the current AuthorizationRequest object.

Parameters:

request - the request to be converted

Returns:

an immutable object for storage

createOAuth2Request

OAuth2Request createOAuth2Request(ClientDetails client,
                                TokenRequest tokenRequest)

Create a new OAuth2Request by extracting the needed information from the current TokenRequest object.

Parameters:

client - TODO

tokenRequest - the request to be converted

Returns:

am immutable object for storage

createTokenRequest

TokenRequest createTokenRequest(Map<String,String> requestParameters,
                              ClientDetails authenticatedClient)

Create a new TokenRequest by extracting the needed information from the incoming request parameter map.

Parameters:

requestParameters - the parameters in the request

authenticatedClient - the client that authenticated during the token request

Returns:

a new TokenRequest

createTokenRequest

TokenRequest createTokenRequest(AuthorizationRequest authorizationRequest,
                              String grantType)

Create a new TokenRequest from an AuthorizationRequest. Principally used by the AuthorizationEndpoint during the implicit flow.

Parameters:

authorizationRequest - the incoming request

grantType - the grant type for the token request

Returns:

a new token request