com.netflix.zuul

Interface IZuulFilter

All Known Implementing Classes:

FilterLoader.TestZuulFilter, ZuulFilter

public interface IZuulFilter

BAse interface for ZuulFilters

Method Summary

Modifier and Type	Method and Description
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

Method Detail

shouldFilter

boolean shouldFilter()

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

java.lang.Object run()
              throws ZuulException

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.

Throws:

ZuulException - if an error occurs during execution.