Top Description Inners Fields Constructors Methods
io.undertow.server.handlers

public Class SameSiteCookieHandler

extends Object
implements HttpHandler
Class Inheritance
All Implemented Interfaces
io.undertow.server.HttpHandler
Imports
java.util.Collections, .HashMap, .Map, .Set, java.util.regex.Pattern, io.undertow.server.HandlerWrapper, .HttpHandler, .HttpServerExchange, .ResponseCommitListener, io.undertow.server.handlers.builder.HandlerBuilder, io.undertow.util.Headers, .SameSiteNoneIncompatibleClientChecker
Handler that will set the SameSite flag to response cookies
Author
Richard Opalka

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
SameSiteCookieHandler.Builder

Field Summary

Modifier and TypeField and Description
private final boolean
addSecureForNone

private final Pattern
cookiePattern

private final boolean
enableClientChecker

private final String
mode

private final HttpHandler
next

Constructor Summary

AccessConstructor and Description
public
SameSiteCookieHandler(final HttpHandler next, final String mode)

public
SameSiteCookieHandler(final HttpHandler next, final String mode, final String cookiePattern)

public
SameSiteCookieHandler(final HttpHandler next, final String mode, final String cookiePattern, final boolean caseSensitive)

public
SameSiteCookieHandler(final HttpHandler next, final String mode, final String cookiePattern, final boolean caseSensitive, final boolean enableClientChecker, final boolean addSecureForNone)

Method Summary

Modifier and TypeMethod and Description
public void
handleRequest(HttpServerExchange
the HTTP request/response exchange
exchange)

Implements io.undertow.server.HttpHandler.handleRequest.

Handle the request.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

addSecureForNoneback to summary
private final boolean addSecureForNone
cookiePatternback to summary
private final Pattern cookiePattern
enableClientCheckerback to summary
private final boolean enableClientChecker
modeback to summary
private final String mode
nextback to summary
private final HttpHandler next

Constructor Detail

SameSiteCookieHandlerback to summary
public SameSiteCookieHandler(final HttpHandler next, final String mode)
SameSiteCookieHandlerback to summary
public SameSiteCookieHandler(final HttpHandler next, final String mode, final String cookiePattern)
SameSiteCookieHandlerback to summary
public SameSiteCookieHandler(final HttpHandler next, final String mode, final String cookiePattern, final boolean caseSensitive)
SameSiteCookieHandlerback to summary
public SameSiteCookieHandler(final HttpHandler next, final String mode, final String cookiePattern, final boolean caseSensitive, final boolean enableClientChecker, final boolean addSecureForNone)

Method Detail

handleRequestback to summary
public void handleRequest(HttpServerExchange exchange) throws Exception

Implements io.undertow.server.HttpHandler.handleRequest.

Doc from io.undertow.server.HttpHandler.handleRequest.

Handle the request.

Parameters
exchange:HttpServerExchange

the HTTP request/response exchange

Annotations
@Override
io.undertow.server.handlers back to summary

public Class SameSiteCookieHandler.Builder

extends Object
implements HandlerBuilder
Class Inheritance
All Implemented Interfaces
io.undertow.server.handlers.builder.HandlerBuilder

Constructor Summary

AccessConstructor and Description
public
Builder()

Method Summary

Modifier and TypeMethod and Description
public HandlerWrapper
build(Map<String, Object>
The handler config
config)

Implements io.undertow.server.handlers.builder.HandlerBuilder.build.

Creates the handler

public String
defaultParameter()

Implements io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter.

public String
name()

Implements io.undertow.server.handlers.builder.HandlerBuilder.name.

The string representation of the handler name.

public Map<String, Class<?>>
parameters()

Implements io.undertow.server.handlers.builder.HandlerBuilder.parameters.

Returns a map of parameters and their types.

public Set<String>
requiredParameters()

Implements io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Builderback to summary
public Builder()

Method Detail

buildback to summary
public HandlerWrapper build(Map<String, Object> config)

Implements io.undertow.server.handlers.builder.HandlerBuilder.build.

Doc from io.undertow.server.handlers.builder.HandlerBuilder.build.

Creates the handler

Parameters
config:Map<String, Object>

The handler config

Returns:HandlerWrapper

The new predicate

Annotations
@Override
defaultParameterback to summary
public String defaultParameter()

Implements io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter.

Returns:String

Doc from io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter.

The default parameter name, or null if it does not have a default parameter

Annotations
@Override
nameback to summary
public String name()

Implements io.undertow.server.handlers.builder.HandlerBuilder.name.

Doc from io.undertow.server.handlers.builder.HandlerBuilder.name.

The string representation of the handler name.

Returns:String

The handler name

Annotations
@Override
parametersback to summary
public Map<String, Class<?>> parameters()

Implements io.undertow.server.handlers.builder.HandlerBuilder.parameters.

Doc from io.undertow.server.handlers.builder.HandlerBuilder.parameters.

Returns a map of parameters and their types.

Annotations
@Override
requiredParametersback to summary
public Set<String> requiredParameters()

Implements io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters.

Returns:Set<String>

Doc from io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters.

The required parameters

Annotations
@Override