public interface SsoProvider
SsoProvider
class and the class name needs to be specified in the jps configuration using property sso.provider.class
.Modifier and Type | Interface and Description |
---|---|
static class |
SsoProvider.SsoOpType
The supported type of SSO extended operations.
|
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.
|
void initialize(SsoServiceConfig serviceConfig) throws SsoServiceException
serviceConfig
- encapsulates the service settings specified in the JPS configurationSsoServiceException
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
request
- the client's request to access a resource which requires authentication to be performedresponse
- the response associated with the client's requestendpointUrl
- 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 presentsuccessUrl
- the URL that the user agent must be taken to upon successful authenticationcancelUrl
- the URL that the user agent must be taken to if the user chooses to cancel the loginprops
- carries any information relevant to the login process. It is mainly for extensibilitySsoServiceException
- thrown if failed to create a dispatcherResponseDispatcher 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
request
- the client's request which requires automatically logging in the user after self registrationresponse
- the response associated with the client's requestendpointUrl
- the SSO agent's endpoint url for auto logintoken
-targetUrl
- the landing page URL that the user agent must be taken to upon successful authentication after self-registrationprops
- carries any information relevant to the auto login process. It is mainly for extensibilitySsoServiceException
- if failed to create a dispatcherResponseDispatcher 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
request
- the client's request for logoutresponse
- the response associated with the client's requestendpointUrl
- the SSO agent's endpoint url for logouttargetUrl
- the URL that the user agent must be taken to upon successful logoutprops
- carries any information relevant to the logout process. It is mainly for extensibilitySsoServiceException
- if failed to create a dispatcherResponseDispatcher 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
request
- the client's request that requires the specified SSO process to be performedresponse
- the response associated with the client's requestendpointUrl
- the configured SSO agent's endpoint url for initiating the specified SSO processopType
- the SSO operation typeprops
- carries any information relevant to initiating the specified SSO process. It is mainly for extensibilitySsoServiceException
- thrown if failed to create a dispatcher