Class ModifyResponseBodyGatewayFilterFactory

java.lang.Object

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

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

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

All Implemented Interfaces:

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

public class ModifyResponseBodyGatewayFilterFactory
extends AbstractGatewayFilterFactory<ModifyResponseBodyGatewayFilterFactory.Config>

GatewayFilter that modifies the response body.

When the response 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	ModifyResponseBodyGatewayFilterFactory.Config
protected class	ModifyResponseBodyGatewayFilterFactory.ModifiedServerHttpResponse
class	ModifyResponseBodyGatewayFilterFactory.ModifyResponseGatewayFilter

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
ModifyResponseBodyGatewayFilterFactory(List<org.springframework.http.codec.HttpMessageReader<?>> messageReaders, Set<MessageBodyDecoder> messageBodyDecoders, Set<MessageBodyEncoder> messageBodyEncoders)
ModifyResponseBodyGatewayFilterFactory(List<org.springframework.http.codec.HttpMessageReader<?>> messageReaders, Set<MessageBodyDecoder> messageBodyDecoders, Set<MessageBodyEncoder> messageBodyEncoders, List<org.springframework.boot.http.codec.CodecCustomizer> codecCustomizers)

Method Summary

Modifier and Type	Method	Description
GatewayFilter	apply(ModifyResponseBodyGatewayFilterFactory.Config config)

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

ModifyResponseBodyGatewayFilterFactory

public ModifyResponseBodyGatewayFilterFactory(List<org.springframework.http.codec.HttpMessageReader<?>> messageReaders,
 Set<MessageBodyDecoder> messageBodyDecoders,
 Set<MessageBodyEncoder> messageBodyEncoders)

ModifyResponseBodyGatewayFilterFactory

public ModifyResponseBodyGatewayFilterFactory(List<org.springframework.http.codec.HttpMessageReader<?>> messageReaders,
 Set<MessageBodyDecoder> messageBodyDecoders,
 Set<MessageBodyEncoder> messageBodyEncoders,
 List<org.springframework.boot.http.codec.CodecCustomizer> codecCustomizers)

Method Details

apply

public GatewayFilter apply(ModifyResponseBodyGatewayFilterFactory.Config config)