oracle.security.jps.service.sso

Interface SsoProvider

public interface SsoProvider

This interface defines the SPIs for underlying SSO providers to plug into JPS SSO framework. It is expected that each SSO provider supplies a concrete SsoProvider class and the class name needs to be specified in the jps configuration using property sso.provider.class.

Since:

11gR1+

Version:

1.0

Author:

yiwawang

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SsoProvider.SsoOpType The supported type of SSO extended operations.

Method Summary

Methods

Modifier and Type	Method and Description
ResponseDispatcher	getAutoLoginDispatcher(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String endpointUrl, java.lang.Object token, java.lang.String targetUrl, java.util.Map<java.lang.String,?> props) Gets the dispatcher used to send the response to an SSO agent to initiate the auto login process.
ResponseDispatcher	getExtOpDispatcher(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String endpointUrl, SsoProvider.SsoOpType opType, java.util.Map<java.lang.String,?> props) Gets the dispatcher used to send the response to an SSO agent to initiate the specified SSO process.
ResponseDispatcher	getLoginDispatcher(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String endpointUrl, java.lang.String successUrl, java.lang.String cancelUrl, java.util.Map<java.lang.String,?> props) Gets the dispatcher used to send the response to an SSO agent to initiate the login process.
ResponseDispatcher	getLogoutDispatcher(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String endpointUrl, java.lang.String targetUrl, java.util.Map<java.lang.String,?> props) Gets the dispatcher used to send the response to an SSO agent to initiate the log out process.
void	initialize(SsoServiceConfig serviceConfig) Initializes the SSO Provider.

Method Detail

initialize

void initialize(SsoServiceConfig serviceConfig)
                throws SsoServiceException

Initializes the SSO Provider.

Parameters:

serviceConfig - encapsulates the service settings specified in the JPS configuration

Throws:

SsoServiceException

getLoginDispatcher

ResponseDispatcher getLoginDispatcher(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response,
                                    java.lang.String endpointUrl,
                                    java.lang.String successUrl,
                                    java.lang.String cancelUrl,
                                    java.util.Map<java.lang.String,?> props)
                                      throws SsoServiceException

Gets the dispatcher used to send the response to an SSO agent to initiate the login process.

Parameters:

request - the client's request to access a resource which requires authentication to be performed

response - the response associated with the client's request

endpointUrl - the SSO agent's endpoint url for login, it corresponds to the configured login url for a specific auth level with app.context variable substituted if present

successUrl - the URL that the user agent must be taken to upon successful authentication

cancelUrl - the URL that the user agent must be taken to if the user chooses to cancel the login

props - carries any information relevant to the login process. It is mainly for extensibility

Returns:

the dispatcher used to send the response to initiate the login process, should not return null

Throws:

SsoServiceException - thrown if failed to create a dispatcher

getAutoLoginDispatcher

ResponseDispatcher getAutoLoginDispatcher(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response,
                                        java.lang.String endpointUrl,
                                        java.lang.Object token,
                                        java.lang.String targetUrl,
                                        java.util.Map<java.lang.String,?> props)
                                          throws SsoServiceException

Gets the dispatcher used to send the response to an SSO agent to initiate the auto login process.

Parameters:

request - the client's request which requires automatically logging in the user after self registration

response - the response associated with the client's request

endpointUrl - the SSO agent's endpoint url for auto login

token -

targetUrl - the landing page URL that the user agent must be taken to upon successful authentication after self-registration

props - carries any information relevant to the auto login process. It is mainly for extensibility

Returns:

the dispatcher used to send the response to initiate the auto login process, should not return null

Throws:

SsoServiceException - if failed to create a dispatcher

getLogoutDispatcher

ResponseDispatcher getLogoutDispatcher(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response,
                                     java.lang.String endpointUrl,
                                     java.lang.String targetUrl,
                                     java.util.Map<java.lang.String,?> props)
                                       throws SsoServiceException

Gets the dispatcher used to send the response to an SSO agent to initiate the log out process.

Parameters:

request - the client's request for logout

response - the response associated with the client's request

endpointUrl - the SSO agent's endpoint url for logout

targetUrl - the URL that the user agent must be taken to upon successful logout

props - carries any information relevant to the logout process. It is mainly for extensibility

Returns:

the dispatcher used to send the response to initiate the logout process, should not return null

Throws:

SsoServiceException - if failed to create a dispatcher

getExtOpDispatcher

ResponseDispatcher getExtOpDispatcher(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response,
                                    java.lang.String endpointUrl,
                                    SsoProvider.SsoOpType opType,
                                    java.util.Map<java.lang.String,?> props)
                                      throws SsoServiceException

Gets the dispatcher used to send the response to an SSO agent to initiate the specified SSO process.

Parameters:

request - the client's request that requires the specified SSO process to be performed

response - the response associated with the client's request

endpointUrl - the configured SSO agent's endpoint url for initiating the specified SSO process

opType - the SSO operation type

props - carries any information relevant to initiating the specified SSO process. It is mainly for extensibility

Returns:

the dispatcher used to send the response to initiate the specified SSO process, should not return null

Throws:

SsoServiceException - thrown if failed to create a dispatcher