com.netflix.ribbon.http

Class HttpRequestTemplate<T>

java.lang.Object

com.netflix.ribbon.RequestTemplate<T,io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>>

com.netflix.ribbon.http.HttpRequestTemplate<T>

Type Parameters:

T - Type for the return Object of the Http resource

public class HttpRequestTemplate<T>
extends RequestTemplate<T,io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>>

Provides API to construct a request template for HTTP resource.

Note: This class is not thread safe. It is advised that the template is created and constructed in same thread at initialization of the application. Users can call requestBuilder() later on which returns a RequestBuilder which is thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpRequestTemplate.Builder<T>
static class	HttpRequestTemplate.CacheProviderWithKeyTemplate<T>

Nested classes/interfaces inherited from class com.netflix.ribbon.RequestTemplate

RequestTemplate.RequestBuilder<T>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CACHE_HYSTRIX_COMMAND_SUFFIX
static int	DEFAULT_CACHE_TIMEOUT

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

HttpRequestTemplate(java.lang.String name, HttpResourceGroup group, java.lang.Class<? extends T> classType, com.netflix.hystrix.HystrixObservableCommand.Setter setter, io.netty.handler.codec.http.HttpMethod method, io.netty.handler.codec.http.HttpHeaders headers, ParsedTemplate uriTemplate, FallbackHandler<T> fallbackHandler, ResponseValidator<io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>> validator, HttpRequestTemplate.CacheProviderWithKeyTemplate<T> cacheProvider, ParsedTemplate hystrixCacheKeyTemplate)

Method Summary

Modifier and Type	Method and Description
protected com.netflix.hystrix.HystrixObservableCommand.Setter	cacheHystrixProperties()
protected HttpRequestTemplate.CacheProviderWithKeyTemplate<T>	cacheProvider()
HttpRequestTemplate<T>	copy(java.lang.String name)
protected FallbackHandler<T>	fallbackHandler()
protected java.lang.Class<? extends T>	getClassType()
protected io.reactivex.netty.protocol.http.client.HttpClient<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf>	getClient()
protected io.netty.handler.codec.http.HttpHeaders	getHeaders()
protected ParsedTemplate	hystrixCacheKeyTemplate()
protected com.netflix.hystrix.HystrixObservableCommand.Setter	hystrixProperties()
protected io.netty.handler.codec.http.HttpMethod	method()
java.lang.String	name()
HttpRequestBuilder<T>	requestBuilder()
protected ResponseValidator<io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>>	responseValidator()
protected ParsedTemplate	uriTemplate()

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_HYSTRIX_COMMAND_SUFFIX

public static final java.lang.String CACHE_HYSTRIX_COMMAND_SUFFIX

See Also:

Constant Field Values

DEFAULT_CACHE_TIMEOUT

public static final int DEFAULT_CACHE_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

HttpRequestTemplate

protected HttpRequestTemplate(java.lang.String name,
                              HttpResourceGroup group,
                              java.lang.Class<? extends T> classType,
                              com.netflix.hystrix.HystrixObservableCommand.Setter setter,
                              io.netty.handler.codec.http.HttpMethod method,
                              io.netty.handler.codec.http.HttpHeaders headers,
                              ParsedTemplate uriTemplate,
                              FallbackHandler<T> fallbackHandler,
                              ResponseValidator<io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>> validator,
                              HttpRequestTemplate.CacheProviderWithKeyTemplate<T> cacheProvider,
                              ParsedTemplate hystrixCacheKeyTemplate)

Method Detail

requestBuilder

public HttpRequestBuilder<T> requestBuilder()

Specified by:

requestBuilder in class RequestTemplate<T,io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>>

hystrixCacheKeyTemplate

protected final ParsedTemplate hystrixCacheKeyTemplate()

cacheProvider

protected final HttpRequestTemplate.CacheProviderWithKeyTemplate<T> cacheProvider()

responseValidator

protected final ResponseValidator<io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>> responseValidator()

fallbackHandler

protected final FallbackHandler<T> fallbackHandler()

uriTemplate

protected final ParsedTemplate uriTemplate()

method

protected final io.netty.handler.codec.http.HttpMethod method()

getClassType

protected final java.lang.Class<? extends T> getClassType()

getHeaders

protected final io.netty.handler.codec.http.HttpHeaders getHeaders()

name

public java.lang.String name()

Specified by:

name in class RequestTemplate<T,io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>>

copy

public HttpRequestTemplate<T> copy(java.lang.String name)

Specified by:

copy in class RequestTemplate<T,io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>>

hystrixProperties

protected final com.netflix.hystrix.HystrixObservableCommand.Setter hystrixProperties()

cacheHystrixProperties

protected final com.netflix.hystrix.HystrixObservableCommand.Setter cacheHystrixProperties()

getClient

protected final io.reactivex.netty.protocol.http.client.HttpClient<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> getClient()