com.netflix.zuul

Class FilterProcessor

java.lang.Object

com.netflix.zuul.FilterProcessor

public class FilterProcessor
extends java.lang.Object

This the the core class to execute filters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterProcessor.BasicFilterUsageNotifier Publishes a counter metric for each filter on each use.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
FilterProcessor()

Method Summary

Modifier and Type	Method and Description
void	error() runs all "error" filters.
static FilterProcessor	getInstance()
void	postRoute() runs "post" filters which are called after "route" filters.
void	preRoute() runs all "pre" filters.
java.lang.Object	processZuulFilter(ZuulFilter filter) Processes an individual ZuulFilter.
void	route() Runs all "route" filters.
java.lang.Object	runFilters(java.lang.String sType) runs all filters of the filterType sType/ Use this method within filters to run custom filters by type
void	setFilterUsageNotifier(FilterUsageNotifier notifier) Override the default filter usage notification impl.
static void	setProcessor(FilterProcessor processor) sets a singleton processor in case of a need to override default behavior

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Constructor Detail

FilterProcessor

public FilterProcessor()

Method Detail

getInstance

public static FilterProcessor getInstance()

Returns:

the singleton FilterProcessor

setProcessor

public static void setProcessor(FilterProcessor processor)

sets a singleton processor in case of a need to override default behavior

Parameters:

processor -

setFilterUsageNotifier

public void setFilterUsageNotifier(FilterUsageNotifier notifier)

Override the default filter usage notification impl.

Parameters:

notifier -

postRoute

public void postRoute()
               throws ZuulException

runs "post" filters which are called after "route" filters. ZuulExceptions from ZuulFilters are thrown. Any other Throwables are caught and a ZuulException is thrown out with a 500 status code

Throws:

ZuulException

error

public void error()

runs all "error" filters. These are called only if an exception occurs. Exceptions from this are swallowed and logged so as not to bubble up.

route

public void route()
           throws ZuulException

Runs all "route" filters. These filters route calls to an origin.

Throws:

ZuulException - if an exception occurs.

preRoute

public void preRoute()
              throws ZuulException

runs all "pre" filters. These filters are run before routing to the orgin.

Throws:

ZuulException

runFilters

public java.lang.Object runFilters(java.lang.String sType)
                            throws java.lang.Throwable

runs all filters of the filterType sType/ Use this method within filters to run custom filters by type

Parameters:

sType - the filterType.

Returns:

Throws:

java.lang.Throwable - throws up an arbitrary exception

processZuulFilter

public java.lang.Object processZuulFilter(ZuulFilter filter)
                                   throws ZuulException

Processes an individual ZuulFilter. This method adds Debug information. Any uncaught Thowables are caught by this method and converted to a ZuulException with a 500 status code.

Parameters:

filter -

Returns:

the return value for that filter

Throws:

ZuulException