Skip navigation links

oracle.ocsg.oauth2.ext.api
Interface OAuth2Handler

All Known Subinterfaces:

ExtendedOAuth2Handler

public interface OAuth2Handler

Method Summary

OAuth2Action	onAuthRequest(String responseType, Map attribute) Invoked when clients visit the endpoint "oaut2/authorize".
OAuth2Action	onDelegatedAuthRequest(String responseType, Map attribute) Invoked when clients visit the endpoint "oauth2/grant".
OAuth2Action	onTokenRequest(String grantType, Map attribute) Invoked when clients visit the endpoint "oauth2/token".

Method Detail

onAuthRequest

public OAuth2Action onAuthRequest(String responseType,
                                  Map attribute)

Invoked when clients visit the endpoint "oaut2/authorize". The handler will determine actions to be taken. The supported actions are: OAuth2ErrorAction, OAuth2DelegatedAction.

Parameters:

responseType - value of "response_type" in request

attribute - mandatory and optional parameters' key-value pairs in this request.

Returns:

OAuth2Action Action to be taken

onDelegatedAuthRequest

public OAuth2Action onDelegatedAuthRequest(String responseType,
                                           Map attribute)

Invoked when clients visit the endpoint "oauth2/grant". The handler will determine actions to be taken. The supported actions are OAuth2ErrorAction, OAuth2IssueCodeAction, OAuth2IssueTokenAction.

Parameters:

responseType - Value of "response_type" in request

attribute - Mandatory and optional parameters' key-value pairs in this request("oauth2/authorize") and previous requests

Returns:

OAuth2Action action to be taken

onTokenRequest

public OAuth2Action onTokenRequest(String grantType,
                                   Map attribute)

Invoked when clients visit the endpoint "oauth2/token". The handler will determine actions to be taken. The supported actions are OAuth2ErrorAction, OAuth2IssueTokenAction.

Parameters:

grantType - Value of "grant_type" in request

attribute - Mandatory and optional parameters' key-value pairs in this request

Returns:

OAuth2Action Action to be taken

Skip navigation links