Oracle Communications Services Gatekeeper Java API Reference
7.0.0.1

E96578-01

oracle.ocsg.oauth2.ext.api
Interface ExtendedOAuth2Handler

All Superinterfaces:
OAuth2Handler

public interface ExtendedOAuth2Handler
extends OAuth2Handler

Specified by the annotation OAuth2HandlerConfig, this stateless handler is able to handle a specified OAuth2 request according different response and grant types. You can specify a single OAuth2Validator which is used to overwrite default validation of parameters, such as the resource owner credential, or if one resource owner is allowed to grant a specified scope or not.

See Also:
OAuth2Handler, CustomizedOAuth2Validator

Method Summary
abstract  void buildAuthResponse(java.util.Map attribute, OAuth2ServletResponse response)
          Allows the handler to customize an authorization response request (endpoint: /oauth2/authorize).
abstract  void buildDelegatedAuthResponse(java.util.Map attributes, OAuth2ServletResponse response)
          Allows the handler to customize a response for a delegated authorization request (endpoint: /oauth2/grant).
abstract  void buildTokenResponse(java.util.Map attributes, OAuth2ServletResponse response)
          Allows the handler to customize a response for token requests (endpoint: /oauth2/token).
 
Methods inherited from interface oracle.ocsg.oauth2.ext.api.OAuth2Handler
onAuthRequest, onDelegatedAuthRequest, onTokenRequest
 

Method Detail

buildAuthResponse

public void buildAuthResponse(java.util.Map attribute,
                              OAuth2ServletResponse response)
Allows the handler to customize an authorization response request (endpoint: /oauth2/authorize).

Parameters:
attribute - Mandatory and optional parameters in the request
response - OAuth2 servlet response, for sending a response

buildDelegatedAuthResponse

public void buildDelegatedAuthResponse(java.util.Map attributes,
                                       OAuth2ServletResponse response)
Allows the handler to customize a response for a delegated authorization request (endpoint: /oauth2/grant).

Parameters:
attributes - Mandatory and optional parameters in the request.
response - OAuth2 servlet response, for sending a response.

buildTokenResponse

public void buildTokenResponse(java.util.Map attributes,
                               OAuth2ServletResponse response)
Allows the handler to customize a response for token requests (endpoint: /oauth2/token).

Parameters:
attributes - Mandatory and optional parameters in the request.
response - OAuth2 servlet response, for sending a response.

Oracle Communications Services Gatekeeper Java API Reference
7.0.0.1

E96578-01

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