HeaderWriterFilter (spring-security-docs 5.6.7 API)

java.lang.Object
- org.springframework.web.filter.GenericFilterBean
- - org.springframework.web.filter.OncePerRequestFilter
  - - org.springframework.security.web.header.HeaderWriterFilter

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.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.web.context.ServletContextAware
```
public class HeaderWriterFilter
extends org.springframework.web.filter.OncePerRequestFilter
```
Filter implementation to add headers to the current response. Can be useful to add certain headers which enable browser protection. Like X-Frame-Options, X-XSS-Protection and X-Content-Type-Options.

Since:

3.2

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

Constructor Summary

Constructors
Constructor Description

HeaderWriterFilter(java.util.List<HeaderWriter> headerWriters)
Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doFilterInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain filterChain)`
`void`	`setShouldWriteHeadersEagerly(boolean shouldWriteHeadersEagerly)`	Allow writing headers at the beginning of the request.

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter
doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

Methods inherited from class org.springframework.web.filter.GenericFilterBean
addRequiredProperty, afterPropertiesSet, 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
  - HeaderWriterFilter
```
public HeaderWriterFilter(java.util.List<HeaderWriter> headerWriters)
```
    Creates a new instance.
    
    Parameters:
    
    headerWriters - the HeaderWriter instances to write out headers to the HttpServletResponse.
- Method Detail
  - doFilterInternal
```
protected void doFilterInternal(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                javax.servlet.FilterChain filterChain)
                         throws javax.servlet.ServletException,
                                java.io.IOException
```
    Specified by:
    
    doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter
    
    Throws:
    
    javax.servlet.ServletException
    
    java.io.IOException
  - setShouldWriteHeadersEagerly
```
public void setShouldWriteHeadersEagerly(boolean shouldWriteHeadersEagerly)
```
    Allow writing headers at the beginning of the request.
    
    Parameters:
    
    shouldWriteHeadersEagerly - boolean to allow writing headers at the beginning of the request.
    
    Since:
    
    5.2