Skip navigation links

oracle.security.idaas.rp.spi
Interface IdentityProvider

public interface IdentityProvider

Since:

release specific (what release of product did this appear in)

Version:

$Header: IdentityProvider.java 24-oct-2011.13:44:42 sevani Exp $

Author:

sevani

Method Summary

boolean	authenticateUser(RequestContext context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext servletContext, java.lang.String returnURL, java.util.Map<java.lang.String,java.lang.String> idpAttributes, java.util.Map<java.lang.String,java.lang.String> idpUserAttributes) This method is invoked to authenticate user with IDP.
OAuthToken	getAccessToken(RequestContext context, javax.servlet.http.HttpServletRequest request, java.lang.String returnURL, java.util.Map<java.lang.String,java.lang.String> idpAttributes) Gets access token using the authorization code returned by provider
java.util.Map<java.lang.String,java.lang.String>	getUserProfile(RequestContext context, javax.servlet.http.HttpServletRequest request, OAuthToken idpAccessToken, java.util.Map<java.lang.String,java.lang.String> idpAttributes, java.util.Map<java.lang.String,java.lang.String> idpUserAttributes) This method is invoked after the authentication of the user to retrieve user profile from the IDP.

Method Detail

authenticateUser

boolean authenticateUser(RequestContext context,
                         javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         javax.servlet.ServletContext servletContext,
                         java.lang.String returnURL,
                         java.util.Map<java.lang.String,java.lang.String> idpAttributes,
                         java.util.Map<java.lang.String,java.lang.String> idpUserAttributes)
                         throws RPException

This method is invoked to authenticate user with IDP.

Parameters:

context - the request context that is established from the application.

request - the HTTP request object.

response - the HTTP response object.

servletContext - the ServletContext object.

returnURL - RP's return url.

idpAttributes - the attributes map of the IDP

idpUserAttributes - the user attributes map of the IDP

Returns:

boolean user authenticate action with idp success or failure.

Throws:

RPException - if the authentication processing fails for any errors.

getUserProfile

java.util.Map<java.lang.String,java.lang.String> getUserProfile(RequestContext context,
                                                                javax.servlet.http.HttpServletRequest request,
                                                                OAuthToken idpAccessToken,
                                                                java.util.Map<java.lang.String,java.lang.String> idpAttributes,
                                                                java.util.Map<java.lang.String,java.lang.String> idpUserAttributes)
                                                                throws RPException

This method is invoked after the authentication of the user to retrieve user profile from the IDP.

Parameters:

context - the request context that is established from the application.

request - the HTTP request object.

idpAccessToken - containing the idp's access token

idpAttributes - the attributes map of the IDP

idpUserAttributes - the user attributes map of the IDP

Returns:

Map the user attributes received from IDP

Throws:

RPException - if the post authentication processing fails for any exceptions.

getAccessToken

OAuthToken getAccessToken(RequestContext context,
                          javax.servlet.http.HttpServletRequest request,
                          java.lang.String returnURL,
                          java.util.Map<java.lang.String,java.lang.String> idpAttributes)
                          throws RPException

Gets access token using the authorization code returned by provider

Parameters:

context - the request context that is established from the application.

request - HttpServletRequest object is received from the provider

returnURL - RP's return url.

idpAttributes - the attributes map of the IDP

Returns:

OAuthToken containing the access token

Throws:

java.lang.Exception

RPException

Skip navigation links