Class ModifyRequestBodyGatewayFilterFactory

java.lang.Object

org.springframework.cloud.gateway.support.AbstractConfigurable<ModifyRequestBodyGatewayFilterFactory.Config>

org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory<ModifyRequestBodyGatewayFilterFactory.Config>

org.springframework.cloud.gateway.filter.factory.rewrite.ModifyRequestBodyGatewayFilterFactory

All Implemented Interfaces:

org.springframework.beans.factory.Aware, GatewayFilterFactory<ModifyRequestBodyGatewayFilterFactory.Config>, Configurable<ModifyRequestBodyGatewayFilterFactory.Config>, ShortcutConfigurable, org.springframework.context.ApplicationEventPublisherAware

public class ModifyRequestBodyGatewayFilterFactory
extends AbstractGatewayFilterFactory<ModifyRequestBodyGatewayFilterFactory.Config>

GatewayFilter that modifies the request body.

When the request has no body, the RewriteFunction is invoked with null for the body parameter. Implementations (including Kotlin with a nullable parameter) must handle this case.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModifyRequestBodyGatewayFilterFactory.Config

Nested classes/interfaces inherited from class AbstractGatewayFilterFactory

AbstractGatewayFilterFactory.NameConfig

Nested classes/interfaces inherited from interface ShortcutConfigurable

ShortcutConfigurable.GatewayBeanFactoryResolver, ShortcutConfigurable.GatewayEvaluationContext, ShortcutConfigurable.RestrictivePropertyAccessor, ShortcutConfigurable.ShortcutType

Field Summary

Fields inherited from interface GatewayFilterFactory

NAME_KEY, VALUE_KEY

Constructor Summary

Constructors

Constructor	Description
ModifyRequestBodyGatewayFilterFactory()
ModifyRequestBodyGatewayFilterFactory(List<org.springframework.http.codec.HttpMessageReader<?>> messageReaders)
ModifyRequestBodyGatewayFilterFactory(List<org.springframework.http.codec.HttpMessageReader<?>> messageReaders, List<org.springframework.boot.http.codec.CodecCustomizer> codecCustomizers)

Method Summary

Modifier and Type	Method	Description
GatewayFilter	apply(ModifyRequestBodyGatewayFilterFactory.Config config)
protected reactor.core.publisher.Mono<Void>	release(org.springframework.web.server.ServerWebExchange exchange, CachedBodyOutputMessage outputMessage, Throwable throwable)

Methods inherited from class AbstractGatewayFilterFactory

enableBodyCaching, getPublisher, setApplicationEventPublisher

Methods inherited from class AbstractConfigurable

getConfigClass, newConfig, toString

Methods inherited from class Object

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

Methods inherited from interface GatewayFilterFactory

apply, apply, apply, getConfigClass, name, newConfig

Methods inherited from interface ShortcutConfigurable

shortcutFieldOrder, shortcutFieldPrefix, shortcutType

Constructor Details

ModifyRequestBodyGatewayFilterFactory

public ModifyRequestBodyGatewayFilterFactory()

ModifyRequestBodyGatewayFilterFactory

public ModifyRequestBodyGatewayFilterFactory(List<org.springframework.http.codec.HttpMessageReader<?>> messageReaders)

ModifyRequestBodyGatewayFilterFactory

public ModifyRequestBodyGatewayFilterFactory(List<org.springframework.http.codec.HttpMessageReader<?>> messageReaders,
 List<org.springframework.boot.http.codec.CodecCustomizer> codecCustomizers)

Method Details

apply

public GatewayFilter apply(ModifyRequestBodyGatewayFilterFactory.Config config)

release

protected reactor.core.publisher.Mono<Void> release(org.springframework.web.server.ServerWebExchange exchange,
 CachedBodyOutputMessage outputMessage,
 Throwable throwable)