Package com.netflix.zuul.filters.http

Class HttpSyncEndpoint

java.lang.Object

com.netflix.zuul.filters.BaseFilter<I,O>

com.netflix.zuul.filters.Endpoint<HttpRequestMessage,HttpResponseMessage>

com.netflix.zuul.filters.http.HttpSyncEndpoint

All Implemented Interfaces:

ShouldFilter<HttpRequestMessage>, SyncZuulFilter<HttpRequestMessage,HttpResponseMessage>, ZuulFilter<HttpRequestMessage,HttpResponseMessage>

public abstract class HttpSyncEndpoint
extends Endpoint<HttpRequestMessage,HttpResponseMessage>
implements SyncZuulFilter<HttpRequestMessage,HttpResponseMessage>

User: Mike Smith Date: 6/16/15 Time: 12:23 AM

Constructor Summary

Constructors

Constructor	Description
HttpSyncEndpoint()

Method Summary

Modifier and Type	Method	Description
rx.Observable<HttpResponseMessage>	applyAsync(HttpRequestMessage input)	if shouldFilter() is true, this method will be invoked.
void	decrementConcurrency()	Called by zuul filter after request is processed by this filter.
HttpResponseMessage	getDefaultOutput(HttpRequestMessage request)	Choose a default message to use if the applyAsync() method throws an exception.
void	incrementConcurrency()	Called by zuul filter runner before sending request through this filter.
io.netty.handler.codec.http.HttpContent	processContentChunk(ZuulMessage zuulMessage, io.netty.handler.codec.http.HttpContent chunk)	Optionally transform HTTP content chunk received.

Methods inherited from class com.netflix.zuul.filters.Endpoint

filterOrder, filterType, shouldFilter

Methods inherited from class com.netflix.zuul.filters.BaseFilter

disablePropertyName, filterName, getSyncType, isDisabled, maxConcurrencyPropertyName, needsBodyBuffered, overrideStopFilterProcessing, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.netflix.zuul.filters.ShouldFilter

shouldFilter

Methods inherited from interface com.netflix.zuul.filters.SyncZuulFilter

apply

Methods inherited from interface com.netflix.zuul.filters.ZuulFilter

category, filterName, filterOrder, filterType, getSyncType, isDisabled, needsBodyBuffered, overrideStopFilterProcessing

Constructor Details

HttpSyncEndpoint

public HttpSyncEndpoint()

Method Details

getDefaultOutput

public HttpResponseMessage getDefaultOutput(HttpRequestMessage request)

Description copied from interface: ZuulFilter

Choose a default message to use if the applyAsync() method throws an exception.

Specified by:

getDefaultOutput in interface ZuulFilter<HttpRequestMessage,HttpResponseMessage>

Overrides:

getDefaultOutput in class BaseFilter<HttpRequestMessage,HttpResponseMessage>

Returns:

ZuulMessage

applyAsync

public rx.Observable<HttpResponseMessage> applyAsync(HttpRequestMessage input)

Description copied from interface: ZuulFilter

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

Specified by:

applyAsync in interface ZuulFilter<HttpRequestMessage,HttpResponseMessage>

processContentChunk

public io.netty.handler.codec.http.HttpContent processContentChunk(ZuulMessage zuulMessage,
 io.netty.handler.codec.http.HttpContent chunk)

Description copied from interface: ZuulFilter

Optionally transform HTTP content chunk received.

Specified by:

processContentChunk in interface ZuulFilter<HttpRequestMessage,HttpResponseMessage>

Overrides:

processContentChunk in class BaseFilter<HttpRequestMessage,HttpResponseMessage>

incrementConcurrency

public void incrementConcurrency()

Description copied from interface: ZuulFilter

Called by zuul filter runner before sending request through this filter. The filter can throw ZuulFilterConcurrencyExceededException if it has reached its concurrent requests limit and does not wish to process the request. Generally only useful for async filters.

Specified by:

incrementConcurrency in interface ZuulFilter<HttpRequestMessage,HttpResponseMessage>

Overrides:

incrementConcurrency in class BaseFilter<HttpRequestMessage,HttpResponseMessage>

decrementConcurrency

public void decrementConcurrency()

Description copied from interface: ZuulFilter

Called by zuul filter after request is processed by this filter.

Specified by:

decrementConcurrency in interface ZuulFilter<HttpRequestMessage,HttpResponseMessage>

Overrides:

decrementConcurrency in class BaseFilter<HttpRequestMessage,HttpResponseMessage>