Package hudson.security

Class HudsonFilter

java.lang.Object

hudson.security.HudsonFilter

All Implemented Interfaces:

jakarta.servlet.Filter, org.kohsuke.stapler.CompatibleFilter

public class HudsonFilter
extends Object
implements org.kohsuke.stapler.CompatibleFilter

Filter that Jenkins uses to implement security support.

This is the instance the servlet container creates, but internally this just acts as a proxy to the real Filter, created by SecurityRealm.createFilter(FilterConfig).

Since:

1.160

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field	Description
static final AuthenticationManagerProxy	AUTHENTICATION_MANAGER	Deprecated. in 1.271.
static final RememberMeServicesProxy	REMEMBER_ME_SERVICES_PROXY	Deprecated. in 1.271.
static final UserDetailsServiceProxy	USER_DETAILS_SERVICE_PROXY	Deprecated. in 1.271.

Constructor Summary

Constructors

Constructor	Description
HudsonFilter()

Method Summary

Modifier and Type	Method	Description
void	destroy()
void	doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain)
static HudsonFilter	get(jakarta.servlet.ServletContext context)	Gets the HudsonFilter created for the given ServletContext.
void	init(jakarta.servlet.FilterConfig filterConfig)
void	reset(SecurityRealm securityRealm)	Reset the proxies and filter for a change in SecurityRealm.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kohsuke.stapler.CompatibleFilter

doFilter, init

Field Details

AUTHENTICATION_MANAGER

@Deprecated
public static final AuthenticationManagerProxy AUTHENTICATION_MANAGER

Deprecated.

in 1.271. This proxy always delegate to Hudson.getInstance().getSecurityRealm().getSecurityComponents().manager, so use that instead.

AuthenticationManager proxy so that the Spring Security filter chain can stay the same even when security setting is reconfigured.

USER_DETAILS_SERVICE_PROXY

@Deprecated
public static final UserDetailsServiceProxy USER_DETAILS_SERVICE_PROXY

Deprecated.

in 1.271. This proxy always delegate to Hudson.getInstance().getSecurityRealm().getSecurityComponents().userDetails, so use that instead.

UserDetailsService proxy so that the Spring Security filter chain can stay the same even when security setting is reconfigured.

REMEMBER_ME_SERVICES_PROXY

@Deprecated
public static final RememberMeServicesProxy REMEMBER_ME_SERVICES_PROXY

Deprecated.

in 1.271. This proxy always delegate to Hudson.getInstance().getSecurityRealm().getSecurityComponents().rememberMe, so use that instead.

RememberMeServices proxy so that the Spring Security filter chain can stay the same even when security setting is reconfigured.

Constructor Details

HudsonFilter

public HudsonFilter()

Method Details

init

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

Specified by:

init in interface jakarta.servlet.Filter

Throws:

jakarta.servlet.ServletException

get

public static HudsonFilter get(jakarta.servlet.ServletContext context)

Gets the HudsonFilter created for the given ServletContext.

reset

public void reset(SecurityRealm securityRealm)
           throws jakarta.servlet.ServletException

Reset the proxies and filter for a change in SecurityRealm.

Throws:

jakarta.servlet.ServletException

doFilter

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

Specified by:

doFilter in interface jakarta.servlet.Filter

Throws:

IOException

jakarta.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface jakarta.servlet.Filter