Class RequestHeaderToRequestUriGatewayFilterFactory

java.lang.Object

org.springframework.cloud.gateway.support.AbstractConfigurable<AbstractGatewayFilterFactory.NameConfig>

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

org.springframework.cloud.gateway.filter.factory.AbstractChangeRequestUriGatewayFilterFactory<AbstractGatewayFilterFactory.NameConfig>

org.springframework.cloud.gateway.filter.factory.RequestHeaderToRequestUriGatewayFilterFactory

All Implemented Interfaces:

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

public class RequestHeaderToRequestUriGatewayFilterFactory
extends AbstractChangeRequestUriGatewayFilterFactory<AbstractGatewayFilterFactory.NameConfig>

This filter changes the request uri by a request header.

Author:

Toshiaki Maki

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

Method Summary

Modifier and Type	Method	Description
GatewayFilter	apply(AbstractGatewayFilterFactory.NameConfig config)
protected Optional<URI>	determineRequestUri(org.springframework.web.server.ServerWebExchange exchange, AbstractGatewayFilterFactory.NameConfig config)
List<String>	shortcutFieldOrder()	Returns hints about the number of args and the order for shortcut parsing.

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

shortcutFieldPrefix, shortcutType

Constructor Details

RequestHeaderToRequestUriGatewayFilterFactory

public RequestHeaderToRequestUriGatewayFilterFactory()

Method Details

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

apply

public GatewayFilter apply(AbstractGatewayFilterFactory.NameConfig config)

Specified by:

apply in interface GatewayFilterFactory<AbstractGatewayFilterFactory.NameConfig>

Overrides:

apply in class AbstractChangeRequestUriGatewayFilterFactory<AbstractGatewayFilterFactory.NameConfig>

determineRequestUri

protected Optional<URI> determineRequestUri(org.springframework.web.server.ServerWebExchange exchange,
 AbstractGatewayFilterFactory.NameConfig config)

Specified by:

determineRequestUri in class AbstractChangeRequestUriGatewayFilterFactory<AbstractGatewayFilterFactory.NameConfig>