X509AuthenticationFilter (spring-security-docs-manual 5.5.8 API)

java.lang.Object
- org.springframework.web.filter.GenericFilterBean
- - org.springframework.security.web.authentication.preauth.AbstractPreAuthenticatedProcessingFilter
  - - org.springframework.security.web.authentication.preauth.x509.X509AuthenticationFilter

All Implemented Interfaces:

javax.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationEventPublisherAware, org.springframework.context.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.web.context.ServletContextAware
```
public class X509AuthenticationFilter
extends AbstractPreAuthenticatedProcessingFilter
```

Field Summary
- Fields inherited from class org.springframework.web.filter.GenericFilterBean
  logger

Constructor Summary

Constructors
Constructor Description

X509AuthenticationFilter()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected java.lang.Object`	`getPreAuthenticatedCredentials(javax.servlet.http.HttpServletRequest request)`	Override to extract the credentials (if applicable) from the current request.
`protected java.lang.Object`	`getPreAuthenticatedPrincipal(javax.servlet.http.HttpServletRequest request)`	Override to extract the principal information from the current request
`void`	`setPrincipalExtractor(X509PrincipalExtractor principalExtractor)`

Methods inherited from class org.springframework.security.web.authentication.preauth.AbstractPreAuthenticatedProcessingFilter
afterPropertiesSet, doFilter, getAuthenticationDetailsSource, principalChanged, setApplicationEventPublisher, setAuthenticationDetailsSource, setAuthenticationFailureHandler, setAuthenticationManager, setAuthenticationSuccessHandler, setCheckForPrincipalChanges, setContinueFilterChainOnUnsuccessfulAuthentication, setInvalidateSessionOnPrincipalChange, setRequiresAuthenticationRequestMatcher, successfulAuthentication, unsuccessfulAuthentication

Methods inherited from class org.springframework.web.filter.GenericFilterBean
addRequiredProperty, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - X509AuthenticationFilter
```
public X509AuthenticationFilter()
```
- Method Detail
  - getPreAuthenticatedPrincipal
```
protected java.lang.Object getPreAuthenticatedPrincipal(javax.servlet.http.HttpServletRequest request)
```
    Description copied from class: AbstractPreAuthenticatedProcessingFilter
    
    Override to extract the principal information from the current request
    
    Specified by:
    
    getPreAuthenticatedPrincipal in class AbstractPreAuthenticatedProcessingFilter
  - getPreAuthenticatedCredentials
```
protected java.lang.Object getPreAuthenticatedCredentials(javax.servlet.http.HttpServletRequest request)
```
    Description copied from class: AbstractPreAuthenticatedProcessingFilter
    
    Override to extract the credentials (if applicable) from the current request. Should not return null for a valid principal, though some implementations may return a dummy value.
    
    Specified by:
    
    getPreAuthenticatedCredentials in class AbstractPreAuthenticatedProcessingFilter
  - setPrincipalExtractor
```
public void setPrincipalExtractor(X509PrincipalExtractor principalExtractor)
```