Class AddRequestHeadersIfNotPresentGatewayFilterFactory

java.lang.Object

org.springframework.cloud.gateway.support.AbstractConfigurable<KeyValueConfig>

org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory<KeyValueConfig>

org.springframework.cloud.gateway.filter.factory.AddRequestHeadersIfNotPresentGatewayFilterFactory

All Implemented Interfaces:

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

public class AddRequestHeadersIfNotPresentGatewayFilterFactory
extends AbstractGatewayFilterFactory<KeyValueConfig>

Adds one or more headers to the downstream request’s headers without overriding previous values. If the header is are already present, value(s) will not be set.

Author:

Abel Salgado Romero

Nested Class Summary

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
AddRequestHeadersIfNotPresentGatewayFilterFactory()

Method Summary

Modifier and Type	Method	Description
GatewayFilter	apply(KeyValueConfig config)
Class<KeyValueConfig>	getConfigClass()
KeyValueConfig	newConfig()
List<String>	shortcutFieldOrder()	Returns hints about the number of args and the order for shortcut parsing.
ShortcutConfigurable.ShortcutType	shortcutType()

Methods inherited from class AbstractGatewayFilterFactory

enableBodyCaching, getPublisher, setApplicationEventPublisher

Methods inherited from class AbstractConfigurable

toString

Methods inherited from class Object

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

Methods inherited from interface GatewayFilterFactory

apply, apply, apply, name

Methods inherited from interface ShortcutConfigurable

shortcutFieldPrefix

Constructor Details

AddRequestHeadersIfNotPresentGatewayFilterFactory

public AddRequestHeadersIfNotPresentGatewayFilterFactory()

Method Details

apply

public GatewayFilter apply(KeyValueConfig config)

shortcutType

public ShortcutConfigurable.ShortcutType shortcutType()

shortcutFieldOrder

public List<String> shortcutFieldOrder()

Description copied from interface: ShortcutConfigurable

Returns hints about the number of args and the order for shortcut parsing.

Returns:

the list of hints

newConfig

public KeyValueConfig newConfig()

Specified by:

newConfig in interface Configurable<KeyValueConfig>

Specified by:

newConfig in interface GatewayFilterFactory<KeyValueConfig>

Overrides:

newConfig in class AbstractConfigurable<KeyValueConfig>

getConfigClass

public Class<KeyValueConfig> getConfigClass()

Specified by:

getConfigClass in interface Configurable<KeyValueConfig>

Specified by:

getConfigClass in interface GatewayFilterFactory<KeyValueConfig>

Overrides:

getConfigClass in class AbstractConfigurable<KeyValueConfig>