Filters

Overview

Filter Interface

Filters must extend com.netflix.zuul.groovy.ProxyFilter and implement the following methods:

String filterType();

int filterOrder();

boolean shouldFilter();

Object run();

Filter Types

A Filter's type is a String which can be any value that you desire. There are 2 uses for this:

1. Zuul's primary request lifecycle consists of "pre", "proxy", and "post" phases, in that order. All filters with these types are run for every request.

2. Filters of any type can be explicitly run using the method GroovyProcessor.runFilters(String type).

As stated above, Filters are only run if shouldRun() returns true, and are run in the order specified by filterOrder()

Ordering

To Run, or Maybe Not

Filter Coordination

Special Filter Extensions