Package com.oracle.communications.brm.cc.modules

Interface OAuthTokenModule

All Superinterfaces:

BaseModule

All Known Implementing Classes:

PCMOAuthTokenModule

public interface OAuthTokenModule
extends BaseModule

Method Summary

Modifier and Type	Method	Description
IdentityProvider	getIdentityProvider()	Method returns the IdentityProvider implementation for generating and validating OAuth token.
Response	queryAccessToken(HttpServletRequest servletRequest)	Requests access token for a client
String	validateToken(HttpServletRequest httpServletRequest)	Validate token and Retrieves Client ID on successful validation

Methods inherited from interface com.oracle.communications.brm.cc.modules.BaseModule

getBaseOps, getURIContext, getUserContext, setBaseOps, setURIContext, setUserContext

Method Details

queryAccessToken

Response queryAccessToken(HttpServletRequest servletRequest)
                   throws ApplicationException,
com.fasterxml.jackson.core.JsonProcessingException

Requests access token for a client

Parameters:

servletRequest -

Returns:

Response

Throws:

com.fasterxml.jackson.core.JsonProcessingException - when ObjectMapper cannot read JSON response to Java object

ApplicationException

validateToken

String validateToken(HttpServletRequest httpServletRequest)
              throws InvalidTokenException,
com.fasterxml.jackson.core.JsonProcessingException

Validate token and Retrieves Client ID on successful validation

Parameters:

httpServletRequest -

Returns:

On successful validation, it returns clientId

Throws:

InvalidTokenException - when the access token sent is not valid

com.fasterxml.jackson.core.JsonProcessingException

getIdentityProvider

IdentityProvider getIdentityProvider()

Method returns the IdentityProvider implementation for generating and validating OAuth token.

Returns:

IdentityProvider instance