org.springframework.cloud.netflix.zuul.filters

Class SimpleRouteLocator

java.lang.Object

org.springframework.cloud.netflix.zuul.filters.SimpleRouteLocator

All Implemented Interfaces:

RouteLocator, org.springframework.core.Ordered

Direct Known Subclasses:

DiscoveryClientRouteLocator

public class SimpleRouteLocator
extends Object
implements RouteLocator, org.springframework.core.Ordered

Simple RouteLocator based on configuration data held in ZuulProperties.

Author:

Dave Syer

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
SimpleRouteLocator(String servletPath, ZuulProperties properties)

Method Summary

Modifier and Type	Method and Description
protected void	doRefresh() Calculate all the routes and set up a cache for the values.
Collection<String>	getIgnoredPaths() Ignored route paths (or patterns), if any.
Route	getMatchingRoute(String path) Maps a path to an actual route with full metadata.
int	getOrder()
protected Route	getRoute(ZuulProperties.ZuulRoute route, String path)
List<Route>	getRoutes() A map of route path (pattern) to location (e.g.
protected Map<String,ZuulProperties.ZuulRoute>	getRoutesMap()
protected Route	getSimpleMatchingRoute(String path)
protected ZuulProperties.ZuulRoute	getZuulRoute(String adjustedPath)
protected Map<String,ZuulProperties.ZuulRoute>	locateRoutes() Compute a map of path pattern to route.
protected boolean	matchesIgnoredPatterns(String path)
void	setOrder(int order)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleRouteLocator

public SimpleRouteLocator(String servletPath,
                          ZuulProperties properties)

Method Detail

getRoutes

public List<Route> getRoutes()

Description copied from interface: RouteLocator

A map of route path (pattern) to location (e.g. service id or URL).

Specified by:

getRoutes in interface RouteLocator

Returns:

List of routes

getIgnoredPaths

public Collection<String> getIgnoredPaths()

Description copied from interface: RouteLocator

Ignored route paths (or patterns), if any.

Specified by:

getIgnoredPaths in interface RouteLocator

Returns:

Collection of ignored paths

getMatchingRoute

public Route getMatchingRoute(String path)

Description copied from interface: RouteLocator

Maps a path to an actual route with full metadata.

Specified by:

getMatchingRoute in interface RouteLocator

Parameters:

path - used to match the Route

Returns:

matching Route based on the provided path

getRoutesMap

protected Map<String,ZuulProperties.ZuulRoute> getRoutesMap()

getSimpleMatchingRoute

protected Route getSimpleMatchingRoute(String path)

getZuulRoute

protected ZuulProperties.ZuulRoute getZuulRoute(String adjustedPath)

getRoute

protected Route getRoute(ZuulProperties.ZuulRoute route,
                         String path)

doRefresh

protected void doRefresh()

Calculate all the routes and set up a cache for the values. Subclasses can call this method if they need to implement RefreshableRouteLocator.

locateRoutes

protected Map<String,ZuulProperties.ZuulRoute> locateRoutes()

Compute a map of path pattern to route. The default is just a static map from the ZuulProperties, but subclasses can add dynamic calculations.

Returns:

map of Zuul routes

matchesIgnoredPatterns

protected boolean matchesIgnoredPatterns(String path)

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

setOrder

public void setOrder(int order)