com.netflix.zuul

Class FilterLoader.TestZuulFilter

java.lang.Object

com.netflix.zuul.ZuulFilter

com.netflix.zuul.FilterLoader.TestZuulFilter

All Implemented Interfaces:

IZuulFilter, java.lang.Comparable<ZuulFilter>

Enclosing class:

FilterLoader

public static class FilterLoader.TestZuulFilter
extends ZuulFilter

Nested Class Summary

Nested classes/interfaces inherited from class com.netflix.zuul.ZuulFilter

ZuulFilter.TestUnit

Constructor Summary

Constructors

Constructor and Description
FilterLoader.TestZuulFilter()

Method Summary

Methods

Modifier and Type	Method and Description
int	filterOrder() filterOrder() must also be defined for a filter.
java.lang.String	filterType() to classify a filter by type.
java.lang.Object	run() if shouldFilter() is true, this method will be invoked.
boolean	shouldFilter() a "true" return from this method means that the run() method should be invoked

Methods inherited from class com.netflix.zuul.ZuulFilter

compareTo, disablePropertyName, isFilterDisabled, isStaticFilter, runFilter

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterLoader.TestZuulFilter

public FilterLoader.TestZuulFilter()

Method Detail

filterType

public java.lang.String filterType()

Description copied from class: ZuulFilter

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)

Specified by:

filterType in class ZuulFilter

Returns:

A String representing that type

filterOrder

public int filterOrder()

Description copied from class: ZuulFilter

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.

Specified by:

filterOrder in class ZuulFilter

Returns:

the int order of a filter

shouldFilter

public boolean shouldFilter()

Description copied from interface: IZuulFilter

a "true" return from this method means that the run() method should be invoked

Returns:

true if the run() method should be invoked. false will not invoke the run() method

run

public java.lang.Object run()

Description copied from interface: IZuulFilter

if shouldFilter() is true, this method will be invoked. this method is the core method of a ZuulFilter

Returns:

Some arbitrary artifact may be returned. Current implementation ignores it.