Package com.sun.identity.saml2.plugins

Class DefaultFedletAdapter

java.lang.Object

com.sun.identity.saml2.plugins.FedletAdapter

com.sun.identity.saml2.plugins.DefaultFedletAdapter

public class DefaultFedletAdapter
extends FedletAdapter

The DefaultFedletAdapter class provides default implementation for FedletAdapter.

Field Summary

Fields inherited from class com.sun.identity.saml2.plugins.FedletAdapter

HOSTED_ENTITY_ID

Constructor Summary

Constructors

Constructor	Description
DefaultFedletAdapter()

Method Summary

Modifier and Type	Method	Description
boolean	doFedletSLO(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, LogoutRequest logoutReq, String hostedEntityID, String idpEntityID, List siList, String nameIDValue, String binding)	Invokes after Fedlet receives SLO request from IDP.
void	initialize(Map initParams)	Initializes the fedlet adapter, this method will only be executed once after creation of the adapter instance.
void	onFedletSLOFailure(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, LogoutRequest logoutReq, LogoutResponse logoutRes, String hostedEntityID, String idpEntityID, String binding)	Invokes after Fedlet receives SLO response from IDP and the SLO status is not success.
void	onFedletSLOSuccess(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, LogoutRequest logoutReq, LogoutResponse logoutRes, String hostedEntityID, String idpEntityID, String binding)	Invokes after Fedlet receives SLO response from IDP and the SLO status is success.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultFedletAdapter

public DefaultFedletAdapter()

Method Detail

initialize

public void initialize(Map initParams)

Initializes the fedlet adapter, this method will only be executed once after creation of the adapter instance.

Specified by:

initialize in class FedletAdapter

Parameters:

initParams - initial set of parameters configured in the fedlet for this adapter. One of the parameters named HOSTED_ENTITY_ID refers to the ID of this fedlet entity.

doFedletSLO

public boolean doFedletSLO(jakarta.servlet.http.HttpServletRequest request,
                           jakarta.servlet.http.HttpServletResponse response,
                           LogoutRequest logoutReq,
                           String hostedEntityID,
                           String idpEntityID,
                           List siList,
                           String nameIDValue,
                           String binding)
                    throws SAML2Exception

Invokes after Fedlet receives SLO request from IDP. It does the work of logout the user.

Overrides:

doFedletSLO in class FedletAdapter

Parameters:

request - servlet request

response - servlet response

hostedEntityID - entity ID for the fedlet

idpEntityID - entity id for the IDP to which the request is received from.

siList - List of SessionIndex whose session to be logged out

nameIDValue - nameID value whose session to be logged out

binding - Single Logout binding used, one of following values: SAML2Constants.SOAP, SAML2Constants.HTTP_POST, SAML2Constants.HTTP_REDIRECT

Returns:

true if user is logged out successfully; false otherwise.

Throws:

SAML2Exception - if user want to fail the process.

onFedletSLOSuccess

public void onFedletSLOSuccess(jakarta.servlet.http.HttpServletRequest request,
                               jakarta.servlet.http.HttpServletResponse response,
                               LogoutRequest logoutReq,
                               LogoutResponse logoutRes,
                               String hostedEntityID,
                               String idpEntityID,
                               String binding)
                        throws SAML2Exception

Invokes after Fedlet receives SLO response from IDP and the SLO status is success.

Overrides:

onFedletSLOSuccess in class FedletAdapter

Parameters:

request - servlet request

response - servlet response

logoutReq - SAML2 LogoutRequest object

logoutRes - SAML2 LogoutResponse object

hostedEntityID - entity ID for the fedlet

idpEntityID - entity id for the IDP to which the logout response is received from.

binding - Single Logout binding used, one of following values: SAML2Constants.SOAP, SAML2Constants.HTTP_POST, SAML2Constants.HTTP_REDIRECT

Throws:

SAML2Exception - if user want to fail the process.

onFedletSLOFailure

public void onFedletSLOFailure(jakarta.servlet.http.HttpServletRequest request,
                               jakarta.servlet.http.HttpServletResponse response,
                               LogoutRequest logoutReq,
                               LogoutResponse logoutRes,
                               String hostedEntityID,
                               String idpEntityID,
                               String binding)
                        throws SAML2Exception

Invokes after Fedlet receives SLO response from IDP and the SLO status is not success.

Overrides:

onFedletSLOFailure in class FedletAdapter

Parameters:

request - servlet request

response - servlet response

logoutReq - SAML2 LogoutRequest object

logoutRes - SAML2 LogoutResponse object

hostedEntityID - entity ID for the fedlet

idpEntityID - entity id for the IDP to which the logout response is received from.

binding - Single Logout binding used, one of following values: SAML2Constants.SOAP, SAML2Constants.HTTP_POST, SAML2Constants.HTTP_REDIRECT

Throws:

SAML2Exception - if user want to fail the process.