Oracle Communications Services Gatekeeper Java API Reference
7.0.0.1

E96578-01

oracle.ocsg.oauth2.ext.api
Interface OAuth2Handler

All Known Subinterfaces:
ExtendedOAuth2Handler

public interface OAuth2Handler

OAuth2Handler.


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

Method Detail

onAuthRequest

public OAuth2Action onAuthRequest(java.lang.String responseType,
                                  java.util.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(java.lang.String responseType,
                                           java.util.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(java.lang.String grantType,
                                   java.util.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

Oracle Communications Services Gatekeeper Java API Reference
7.0.0.1

E96578-01

Copyright © 2008, 2018, Oracle and/or its affiliates. All rights reserved.