com.sun.identity.federation.services.logout

Class FSPreLogoutHandler

java.lang.Object

com.sun.identity.federation.services.logout.FSPreLogoutHandler

public class FSPreLogoutHandler
extends Object

Pre logout handling.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COMMON_ERROR_URL
protected String	currentEntityId
protected com.sun.identity.federation.jaxb.entityconfig.BaseConfigType	hostedConfig
protected com.sun.identity.liberty.ws.meta.jaxb.ProviderDescriptorType	hostedDescriptor
protected String	hostedEntityId
protected String	hostedRole
protected boolean	isCurrentProviderIDPRole
protected boolean	isWMLAgent
protected String	locale
protected static String	LOGOUT_DONE_URL
protected String	metaAlias
protected IDFFMetaManager	metaManager
protected String	realm
protected String	relayState
protected com.sun.identity.liberty.ws.meta.jaxb.ProviderDescriptorType	remoteDescriptor
protected String	remoteEntityID
protected FSLogoutNotification	reqLogout
protected javax.servlet.http.HttpServletRequest	request
protected javax.servlet.http.HttpServletResponse	response
protected Object	ssoToken
protected String	userID

Constructor Summary

Constructors

Constructor and Description
FSPreLogoutHandler() Constructor.

Method Summary

Modifier and Type	Method and Description
FSLogoutStatus	handleSingleLogout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object ssoToken, String sourceCheck) Initiates logout at this provider when the user has clicked on the logout option.
FSLogoutStatus	processHttpSingleLogoutRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object ssoToken) Processes logout request received via HTTP redirect/GET.
FSLogoutStatus	processSingleLogoutRequest(FSLogoutNotification reqLogout) Processes logout request received via SOAP profile.
void	setHostedDescriptor(com.sun.identity.liberty.ws.meta.jaxb.ProviderDescriptorType hostedProviderDesc) Sets the hosted provider details.
void	setHostedDescriptorConfig(com.sun.identity.federation.jaxb.entityconfig.BaseConfigType hostedConfig) Sets hosted provider's extended meta config.
void	setHostedEntityId(String hostedEntityId) Sets hosted provider entity id.
void	setHostedProviderRole(String hostedRole) Sets hosted provider's role.
void	setLogoutRequest(FSLogoutNotification reqLogout)
protected void	setLogoutURL() Invoked to set some commonly used URLs based on hosted provider.
void	setMetaAlias(String metaAlias) Sets hosted provider's meta alias.
void	setRealm(String realm) Sets hosted provider's realm.
void	setRelayState(String relayState) Sets the value of RelayState attribute.
void	setRemoteDescriptor(com.sun.identity.liberty.ws.meta.jaxb.ProviderDescriptorType remoteDesc) Sets the Remote Descriptor.
void	setRemoteEntityId(String remoteEntityId) Sets remote provider's entity id.

Methods inherited from class java.lang.Object

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

Field Detail

response

protected javax.servlet.http.HttpServletResponse response

request

protected javax.servlet.http.HttpServletRequest request

locale

protected String locale

ssoToken

protected Object ssoToken

userID

protected String userID

metaManager

protected IDFFMetaManager metaManager

hostedDescriptor

protected com.sun.identity.liberty.ws.meta.jaxb.ProviderDescriptorType hostedDescriptor

hostedConfig

protected com.sun.identity.federation.jaxb.entityconfig.BaseConfigType hostedConfig

currentEntityId

protected String currentEntityId

isCurrentProviderIDPRole

protected boolean isCurrentProviderIDPRole

reqLogout

protected FSLogoutNotification reqLogout

isWMLAgent

protected boolean isWMLAgent

LOGOUT_DONE_URL

protected static String LOGOUT_DONE_URL

COMMON_ERROR_URL

protected static String COMMON_ERROR_URL

remoteDescriptor

protected com.sun.identity.liberty.ws.meta.jaxb.ProviderDescriptorType remoteDescriptor

remoteEntityID

protected String remoteEntityID

realm

protected String realm

hostedEntityId

protected String hostedEntityId

hostedRole

protected String hostedRole

metaAlias

protected String metaAlias

relayState

protected String relayState

Constructor Detail

FSPreLogoutHandler

public FSPreLogoutHandler()

Constructor. Initializes FSAccountManager, IDFFMetaManager instance.

Method Detail

setLogoutURL

protected void setLogoutURL()

Invoked to set some commonly used URLs based on hosted provider.

setRelayState

public void setRelayState(String relayState)

Sets the value of RelayState attribute.

Parameters:

relayState - the value of RelayState attribute.

setHostedDescriptor

public void setHostedDescriptor(com.sun.identity.liberty.ws.meta.jaxb.ProviderDescriptorType hostedProviderDesc)

Sets the hosted provider details.

Parameters:

hostedProviderDesc - the descriptor of the hosted provider handling logout

setRealm

public void setRealm(String realm)

Sets hosted provider's realm.

Parameters:

realm - the realm in which the provider resides

setHostedEntityId

public void setHostedEntityId(String hostedEntityId)

Sets hosted provider entity id.

Parameters:

hostedEntityId - hosted provider's entity id to be set

setHostedDescriptorConfig

public void setHostedDescriptorConfig(com.sun.identity.federation.jaxb.entityconfig.BaseConfigType hostedConfig)

Sets hosted provider's extended meta config.

Parameters:

hostedConfig - hosted provider's extended meta

setMetaAlias

public void setMetaAlias(String metaAlias)

Sets hosted provider's meta alias.

Parameters:

metaAlias - hosted provider's meta alias to be set

setHostedProviderRole

public void setHostedProviderRole(String hostedRole)

Sets hosted provider's role.

Parameters:

hostedRole - hosted provider's role.

setRemoteEntityId

public void setRemoteEntityId(String remoteEntityId)

Sets remote provider's entity id.

setRemoteDescriptor

public void setRemoteDescriptor(com.sun.identity.liberty.ws.meta.jaxb.ProviderDescriptorType remoteDesc)

Sets the Remote Descriptor.

Parameters:

remoteDesc - Remote Provider Descriptor.

setLogoutRequest

public void setLogoutRequest(FSLogoutNotification reqLogout)

handleSingleLogout

public FSLogoutStatus handleSingleLogout(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response,
                                         Object ssoToken,
                                         String sourceCheck)

Initiates logout at this provider when the user has clicked on the logout option.

Parameters:

request - HttPServletRequest object from the user agent

response - HttPServletRsponse to be sent back to the user agent

ssoToken - used to identify the principal who wants to logout

sourceCheck - where the logout coming from

Returns:

true if the logout is successful; false otherwise.

processHttpSingleLogoutRequest

public FSLogoutStatus processHttpSingleLogoutRequest(javax.servlet.http.HttpServletRequest request,
                                                     javax.servlet.http.HttpServletResponse response,
                                                     Object ssoToken)

Processes logout request received via HTTP redirect/GET.

Parameters:

request - HttpServletRequest object from the user agent

response - HttpServletRsponse to be sent back to the user agent

ssoToken - used to identify the principal who wants to logout

Returns:

FSLogoutStatus object to indicate the status of the logout process.

processSingleLogoutRequest

public FSLogoutStatus processSingleLogoutRequest(FSLogoutNotification reqLogout)

Processes logout request received via SOAP profile.

Parameters:

reqLogout - FSLogoutNotification request received from remote provider

Returns:

FSLogoutStatus object indicates the status of the logout process