Interface Filter

All Known Implementing Classes:

FaultFilter, RbacFilter, RouterFilter

interface Filter

Defines the parsing functionality of an HTTP filter. A Filter may optionally implement either Filter.ClientInterceptorBuilder or Filter.ServerInterceptorBuilder or both, indicating it is capable of working on the client side or server side or both, respectively.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Filter.ClientInterceptorBuilder	Uses the FilterConfigs produced above to produce an HTTP filter interceptor for clients.
static interface	Filter.FilterConfig	Represents an opaque data structure holding configuration for a filter.
static final class	Filter.NamedFilterConfig	Filter config with instance name.
static interface	Filter.ServerInterceptorBuilder	Uses the FilterConfigs produced above to produce an HTTP filter interceptor for the server.

Method Summary

Modifier and Type	Method	Description
ConfigOrError<? extends Filter.FilterConfig>	parseFilterConfig(com.google.protobuf.Message rawProtoMessage)	Parses the top-level filter config from raw proto message.
ConfigOrError<? extends Filter.FilterConfig>	parseFilterConfigOverride(com.google.protobuf.Message rawProtoMessage)	Parses the per-filter override filter config from raw proto message.
String[]	typeUrls()	The proto message types supported by this filter.

Method Details

typeUrls

String[] typeUrls()

The proto message types supported by this filter. A filter will be registered by each of its supported message types.

parseFilterConfig

ConfigOrError<? extends Filter.FilterConfig> parseFilterConfig(com.google.protobuf.Message rawProtoMessage)

Parses the top-level filter config from raw proto message. The message may be either a Any or a Struct.

parseFilterConfigOverride

ConfigOrError<? extends Filter.FilterConfig> parseFilterConfigOverride(com.google.protobuf.Message rawProtoMessage)

Parses the per-filter override filter config from raw proto message. The message may be either a Any or a Struct.