|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.netflix.zuul.ZuulFilter
public abstract class ZuulFilter
Base abstract class for ZuulFilters. The base class defines abstract methods to define: filterType() - to classify a filter by type. Standard types in Zuul are "pre" for pre-routing filtering, "route" for routing to an origin, "post" for post-routing filters, "error" for error handling. We also support a "static" type for static responses see StaticResponseFilter. Any filterType made be created or added and run by calling FilterProcessor.runFilters(type)
filterOrder() must also be defined for a filter. Filters may have the same filterOrder if precedence is not important for a filter. filterOrders do not need to be sequential. ZuulFilters may be disabled using Archius Properties. By default ZuulFilters are static; they don't carry state. This may be overridden by overriding the isStaticFilter() property to false
Nested Class Summary | |
---|---|
static class |
ZuulFilter.TestUnit
|
Constructor Summary | |
---|---|
ZuulFilter()
|
Method Summary | |
---|---|
int |
compareTo(ZuulFilter filter)
|
java.lang.String |
disablePropertyName()
The name of the Archaius property to disable this filter. |
abstract int |
filterOrder()
filterOrder() must also be defined for a filter. |
abstract java.lang.String |
filterType()
to classify a filter by type. |
boolean |
isFilterDisabled()
If true, the filter has been disabled by archaius and will not be run |
boolean |
isStaticFilter()
By default ZuulFilters are static; they don't carry state. |
java.lang.Object |
runFilter()
runFilter checks !isFilterDisabled() and shouldFilter(). |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.netflix.zuul.IZuulFilter |
---|
run, shouldFilter |
Constructor Detail |
---|
public ZuulFilter()
Method Detail |
---|
public abstract java.lang.String filterType()
public abstract int filterOrder()
public boolean isStaticFilter()
public java.lang.String disablePropertyName()
public boolean isFilterDisabled()
public java.lang.Object runFilter() throws java.lang.Throwable
java.lang.Throwable
public int compareTo(ZuulFilter filter)
compareTo
in interface java.lang.Comparable<ZuulFilter>
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |