HeaderRoutePredicateFactory (Spring Cloud Gateway Server 3.1.9 API)

java.lang.Object
- org.springframework.cloud.gateway.support.AbstractConfigurable<C>
- - org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory<HeaderRoutePredicateFactory.Config>
  - - org.springframework.cloud.gateway.handler.predicate.HeaderRoutePredicateFactory

All Implemented Interfaces:

RoutePredicateFactory<HeaderRoutePredicateFactory.Config>, Configurable<HeaderRoutePredicateFactory.Config>, ShortcutConfigurable
```
public class HeaderRoutePredicateFactory
extends AbstractRoutePredicateFactory<HeaderRoutePredicateFactory.Config>
```
Author:

Spencer Gibb

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class HeaderRoutePredicateFactory.Config
- Nested classes/interfaces inherited from interface org.springframework.cloud.gateway.support.ShortcutConfigurable
  ShortcutConfigurable.GatewayEvaluationContext, ShortcutConfigurable.RestrictivePropertyAccessor, ShortcutConfigurable.ShortcutType

Field Summary

Fields
Modifier and Type Field Description

static String HEADER_KEY
Header key.

static String REGEXP_KEY
Regexp key.
- Fields inherited from interface org.springframework.cloud.gateway.handler.predicate.RoutePredicateFactory
  PATTERN_KEY

Constructor Summary

Constructors
Constructor Description

HeaderRoutePredicateFactory()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Predicate<org.springframework.web.server.ServerWebExchange>`	`apply(HeaderRoutePredicateFactory.Config 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.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.handler.predicate.RoutePredicateFactory
apply, applyAsync, applyAsync, beforeApply, getConfigClass, name, newConfig

Methods inherited from interface org.springframework.cloud.gateway.support.ShortcutConfigurable
shortcutFieldPrefix, shortcutType

- Field Detail
  - HEADER_KEY
```
public static final String HEADER_KEY
```
    Header key.
    
    See Also:
    
    Constant Field Values
  - REGEXP_KEY
```
public static final String REGEXP_KEY
```
    Regexp key.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HeaderRoutePredicateFactory
```
public HeaderRoutePredicateFactory()
```
- 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 Predicate<org.springframework.web.server.ServerWebExchange> apply(HeaderRoutePredicateFactory.Config config)
```