org.gatein.sso.saml.plugin.filter

Class PortalIDPWebBrowserSSOFilter

java.lang.Object

org.picketlink.identity.federation.web.filters.IDPFilter

org.gatein.sso.saml.plugin.filter.PortalIDPWebBrowserSSOFilter

All Implemented Interfaces:

javax.servlet.Filter, SSOInterceptor

public class PortalIDPWebBrowserSSOFilter
extends org.picketlink.identity.federation.web.filters.IDPFilter
implements SSOInterceptor

Field Summary

Fields

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

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

auditHelper, authMethod, configProvider, enableAudit, idpConfiguration, picketLinkConfiguration, servletContext, timer, timerInterval

Constructor Summary

Constructors

Constructor and Description
PortalIDPWebBrowserSSOFilter()

Method Summary

Modifier and Type	Method and Description
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
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
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.IDPFilter

cleanUpSessionNote, destroy, determineLoginType, getConfigProvider, getConfiguration, getIdentityURL, handleSAML11UnsolicitedResponse, initHandlersChain, initIdentityServer, initIDPConfiguration, initKeyManager, initSTSConfiguration, processSAMLRequestMessage, processSAMLResponseMessage, sendErrorResponseToSP, startPicketLink

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

ORIGINAL_HTTP_SERVLET_REQUEST_PARAM

public static final String ORIGINAL_HTTP_SERVLET_REQUEST_PARAM

See Also:

Constant Field Values

config

protected javax.servlet.FilterConfig config

The filter configuration

servletContextName

protected String servletContextName

The Servlet context name

Constructor Detail

PortalIDPWebBrowserSSOFilter

public PortalIDPWebBrowserSSOFilter()

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.IDPFilter

Throws:

javax.servlet.ServletException

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Overrides:

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

Throws:

IOException

javax.servlet.ServletException

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