org.gatein.sso.saml.plugin.filter

Class SAML2LogoutFilter

java.lang.Object

org.picketlink.identity.federation.web.filters.SPFilter

org.gatein.sso.saml.plugin.filter.SAML2LogoutFilter

All Implemented Interfaces:

javax.servlet.Filter, SSOInterceptor

public class SAML2LogoutFilter
extends org.picketlink.identity.federation.web.filters.SPFilter
implements SSOInterceptor

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.servlet.FilterConfig	config The filter configuration
static String	COOKIE_NAME
static String	OAUTH_COOKIE_NAME
static String	SAML_LOGOUT_ATTRIBUTE
protected String	servletContextName The Servlet context name

Fields inherited from class org.picketlink.identity.federation.web.filters.SPFilter

canonicalizationMethod, configFile, identityURL, ignoreSignatures, picketLinkConfiguration, serviceURL, spConfiguration

Constructor Summary

Constructors

Constructor and Description
SAML2LogoutFilter()

Method Summary

Modifier and Type	Method and Description
void	doFilter(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, javax.servlet.FilterChain filterChain)
protected String	getInitParameter(String paramName) Read init parameter (works for both kernel initialization or Servlet API initialization)
protected javax.servlet.ServletContext	getServletContext()
void	init(javax.servlet.FilterConfig config)
protected void	initImpl() This method needs to be implemented by conrete filter.
void	initWithParams(org.exoplatform.container.xml.InitParams params, org.exoplatform.container.ExoContainerContext containerContext) Method is invoked if we are performing initialization through exo kernel
static boolean	isPortalLogoutInProgress(javax.servlet.http.HttpServletRequest request)
static boolean	isSAMLLogoutInProgress(javax.servlet.http.HttpServletRequest request)
protected boolean	requirePortalEnvironment() Indicates if it requires that a full portal environment must be set

Methods inherited from class org.picketlink.identity.federation.web.filters.SPFilter

decryptAssertion, destroy, handleSAMLResponse, isTrusted, sendRequestToIDP, sendToDestination, validate, verifySignature

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.Filter

destroy

Field Detail

SAML_LOGOUT_ATTRIBUTE

public static final String SAML_LOGOUT_ATTRIBUTE

See Also:

Constant Field Values

COOKIE_NAME

public static final String COOKIE_NAME

See Also:

Constant Field Values

OAUTH_COOKIE_NAME

public static final String OAUTH_COOKIE_NAME

See Also:

Constant Field Values

config

protected javax.servlet.FilterConfig config

The filter configuration

servletContextName

protected String servletContextName

The Servlet context name

Constructor Detail

SAML2LogoutFilter

public SAML2LogoutFilter()

Method Detail

init

public final void init(javax.servlet.FilterConfig config)
                throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Overrides:

init in class org.picketlink.identity.federation.web.filters.SPFilter

Throws:

javax.servlet.ServletException

doFilter

public void doFilter(javax.servlet.ServletRequest servletRequest,
                     javax.servlet.ServletResponse servletResponse,
                     javax.servlet.FilterChain filterChain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Overrides:

doFilter in class org.picketlink.identity.federation.web.filters.SPFilter

Throws:

IOException

javax.servlet.ServletException

isPortalLogoutInProgress

public static boolean isPortalLogoutInProgress(javax.servlet.http.HttpServletRequest request)

isSAMLLogoutInProgress

public static boolean isSAMLLogoutInProgress(javax.servlet.http.HttpServletRequest request)

initWithParams

public final void initWithParams(org.exoplatform.container.xml.InitParams params,
                                 org.exoplatform.container.ExoContainerContext containerContext)

Method is invoked if we are performing initialization through exo kernel

Specified by:

initWithParams in interface SSOInterceptor

initImpl

protected void initImpl()
                 throws javax.servlet.ServletException

This method needs to be implemented by conrete filter. Filter should obtain it's init parameters by calling getInitParameter(String). This works in both types of initialization (Case1: Filter initialization through kernel, Case2: initialization through servlet API)

Throws:

javax.servlet.ServletException - an init exception happens when calling super class init method

getInitParameter

protected String getInitParameter(String paramName)

Read init parameter (works for both kernel initialization or Servlet API initialization)

Parameters:

paramName - parameter name

Returns:

parameter value

requirePortalEnvironment

protected boolean requirePortalEnvironment()

Indicates if it requires that a full portal environment must be set

Returns:

true if it requires the portal environment false otherwise.

getServletContext

protected javax.servlet.ServletContext getServletContext()

Returns:

the current ServletContext