org.springframework.cloud.gateway.filter.factory

Class RequestHeaderToRequestUriGatewayFilterFactory

java.lang.Object

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

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

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 org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory

AbstractGatewayFilterFactory.NameConfig

Nested classes/interfaces inherited from interface org.springframework.cloud.gateway.support.ShortcutConfigurable

ShortcutConfigurable.ShortcutType

Field Summary

Fields inherited from interface org.springframework.cloud.gateway.filter.factory.GatewayFilterFactory

NAME_KEY, VALUE_KEY

Constructor Summary

Constructors

Constructor and Description
RequestHeaderToRequestUriGatewayFilterFactory()

Method Summary

Modifier and Type	Method and 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 org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory

getPublisher, setApplicationEventPublisher

Methods inherited from class org.springframework.cloud.gateway.support.AbstractConfigurable

getConfigClass, newConfig, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cloud.gateway.filter.factory.GatewayFilterFactory

apply, apply, apply, getConfigClass, mutate, name, newConfig

Methods inherited from interface org.springframework.cloud.gateway.support.ShortcutConfigurable

getValue, normalizeKey, shortcutFieldPrefix, shortcutType

Constructor Detail

RequestHeaderToRequestUriGatewayFilterFactory

public RequestHeaderToRequestUriGatewayFilterFactory()

Method Detail

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>