ReferrerPolicyServerHttpHeadersWriter (spring-security-docs 5.6.7 API)

java.lang.Object
- org.springframework.security.web.server.header.ReferrerPolicyServerHttpHeadersWriter

All Implemented Interfaces:: ServerHttpHeadersWriter

public final class ReferrerPolicyServerHttpHeadersWriter
extends java.lang.Object
implements ServerHttpHeadersWriter

Writes the Referrer-Policy response header.

Since:: 5.1

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ReferrerPolicyServerHttpHeadersWriter.ReferrerPolicy

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String REFERRER_POLICY

Constructor Summary

Constructors
Constructor Description

ReferrerPolicyServerHttpHeadersWriter()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`setPolicy(ReferrerPolicyServerHttpHeadersWriter.ReferrerPolicy policy)`	Set the policy to be used in the response header.
`reactor.core.publisher.Mono<java.lang.Void>`	`writeHttpHeaders(org.springframework.web.server.ServerWebExchange exchange)`	Write the headers to the response.

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

- Field Detail
  - REFERRER_POLICY
```
public static final java.lang.String REFERRER_POLICY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ReferrerPolicyServerHttpHeadersWriter
```
public ReferrerPolicyServerHttpHeadersWriter()
```
- Method Detail
  - writeHttpHeaders
```
public reactor.core.publisher.Mono<java.lang.Void> writeHttpHeaders(org.springframework.web.server.ServerWebExchange exchange)
```
    Description copied from interface: ServerHttpHeadersWriter
    
    Write the headers to the response.
    
    Specified by:
    
    writeHttpHeaders in interface ServerHttpHeadersWriter
    
    Returns:
    
    A Mono which is returned to the Supplier of the ReactiveHttpOutputMessage.beforeCommit(Supplier).
  - setPolicy
```
public void setPolicy(ReferrerPolicyServerHttpHeadersWriter.ReferrerPolicy policy)
```
    Set the policy to be used in the response header.
    
    Parameters:
    
    policy - the policy
    
    Throws:
    
    java.lang.IllegalArgumentException - if policy is null