io.buji.pac4j.filter

Class LogoutFilter

java.lang.Object

io.buji.pac4j.filter.LogoutFilter

All Implemented Interfaces:

javax.servlet.Filter

public class LogoutFilter
extends Object
implements javax.servlet.Filter

This filter handles the (application + identity provider) logout process, based on the logoutLogic.

The configuration can be provided via setter methods: setConfig(Config) (security configuration), setDefaultUrl(String) (default logourl url), setLogoutUrlPattern(String) (pattern that logout urls must match), setLocalLogout(Boolean) (whether the application logout must be performed) and setCentralLogout(Boolean) (whether the centralLogout must be performed).

Since:

3.0.0

Author:

Jerome Leleu

Constructor Summary

Constructors

Constructor and Description
LogoutFilter()

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, javax.servlet.FilterChain filterChain)
Boolean	getCentralLogout()
org.pac4j.core.config.Config	getConfig()
String	getDefaultUrl()
Boolean	getLocalLogout()
org.pac4j.core.engine.LogoutLogic<Object,org.pac4j.core.context.J2EContext>	getLogoutLogic()
String	getLogoutUrlPattern()
void	init(javax.servlet.FilterConfig filterConfig)
void	setCentralLogout(Boolean centralLogout)
void	setConfig(org.pac4j.core.config.Config config)
void	setDefaultUrl(String defaultUrl)
void	setLocalLogout(Boolean localLogout)
void	setLogoutLogic(org.pac4j.core.engine.LogoutLogic<Object,org.pac4j.core.context.J2EContext> logoutLogic)
void	setLogoutUrlPattern(String logoutUrlPattern)

Methods inherited from class java.lang.Object

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

Constructor Detail

LogoutFilter

public LogoutFilter()

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

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

Throws:

IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

getConfig

public org.pac4j.core.config.Config getConfig()

setConfig

public void setConfig(org.pac4j.core.config.Config config)

getDefaultUrl

public String getDefaultUrl()

setDefaultUrl

public void setDefaultUrl(String defaultUrl)

getLogoutUrlPattern

public String getLogoutUrlPattern()

setLogoutUrlPattern

public void setLogoutUrlPattern(String logoutUrlPattern)

getLogoutLogic

public org.pac4j.core.engine.LogoutLogic<Object,org.pac4j.core.context.J2EContext> getLogoutLogic()

setLogoutLogic

public void setLogoutLogic(org.pac4j.core.engine.LogoutLogic<Object,org.pac4j.core.context.J2EContext> logoutLogic)

getLocalLogout

public Boolean getLocalLogout()

setLocalLogout

public void setLocalLogout(Boolean localLogout)

getCentralLogout

public Boolean getCentralLogout()

setCentralLogout

public void setCentralLogout(Boolean centralLogout)