com.netflix.ribbon.http

Class HttpRequestTemplate.Builder<T>

java.lang.Object

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

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

Enclosing class:

HttpRequestTemplate<T>

public static class HttpRequestTemplate.Builder<T>
extends ResourceGroup.TemplateBuilder<T,io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>,HttpRequestTemplate<T>>

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequestTemplate<T>	build()
static <T> HttpRequestTemplate.Builder<T>	newBuilder(java.lang.String templateName, HttpResourceGroup group, java.lang.Class<? extends T> classType)
HttpRequestTemplate.Builder<T>	withCacheProvider(java.lang.String keyTemplate, CacheProvider<T> cacheProvider)
HttpRequestTemplate.Builder<T>	withFallbackProvider(FallbackHandler<T> fallbackHandler)
HttpRequestTemplate.Builder<T>	withHeader(java.lang.String name, java.lang.String value)
HttpRequestTemplate.Builder<T>	withHystrixProperties(com.netflix.hystrix.HystrixObservableCommand.Setter propertiesSetter)
HttpRequestTemplate.Builder<T>	withMethod(java.lang.String method)
HttpRequestTemplate.Builder<T>	withRequestCacheKey(java.lang.String cacheKeyTemplate) Calling this method will enable both Hystrix request cache and supplied external cache providers on the supplied cache key.
HttpRequestTemplate.Builder<T>	withResponseValidator(ResponseValidator<io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>> validator)
HttpRequestTemplate.Builder<T>	withUriTemplate(java.lang.String uriTemplate)

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static <T> HttpRequestTemplate.Builder<T> newBuilder(java.lang.String templateName,
                                            HttpResourceGroup group,
                                            java.lang.Class<? extends T> classType)

withFallbackProvider

public HttpRequestTemplate.Builder<T> withFallbackProvider(FallbackHandler<T> fallbackHandler)

Specified by:

withFallbackProvider in class ResourceGroup.TemplateBuilder<T,io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>,HttpRequestTemplate<T>>

withResponseValidator

public HttpRequestTemplate.Builder<T> withResponseValidator(ResponseValidator<io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>> validator)

Specified by:

withResponseValidator in class ResourceGroup.TemplateBuilder<T,io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>,HttpRequestTemplate<T>>

withMethod

public HttpRequestTemplate.Builder<T> withMethod(java.lang.String method)

withUriTemplate

public HttpRequestTemplate.Builder<T> withUriTemplate(java.lang.String uriTemplate)

withRequestCacheKey

public HttpRequestTemplate.Builder<T> withRequestCacheKey(java.lang.String cacheKeyTemplate)

Description copied from class: ResourceGroup.TemplateBuilder

Calling this method will enable both Hystrix request cache and supplied external cache providers on the supplied cache key. Caller can explicitly disable Hystrix request cache by calling ResourceGroup.TemplateBuilder.withHystrixProperties(com.netflix.hystrix.HystrixObservableCommand.Setter)

Specified by:

withRequestCacheKey in class ResourceGroup.TemplateBuilder<T,io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>,HttpRequestTemplate<T>>

Returns:

withCacheProvider

public HttpRequestTemplate.Builder<T> withCacheProvider(java.lang.String keyTemplate,
                                               CacheProvider<T> cacheProvider)

Specified by:

withCacheProvider in class ResourceGroup.TemplateBuilder<T,io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>,HttpRequestTemplate<T>>

withHeader

public HttpRequestTemplate.Builder<T> withHeader(java.lang.String name,
                                        java.lang.String value)

withHystrixProperties

public HttpRequestTemplate.Builder<T> withHystrixProperties(com.netflix.hystrix.HystrixObservableCommand.Setter propertiesSetter)

Specified by:

withHystrixProperties in class ResourceGroup.TemplateBuilder<T,io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>,HttpRequestTemplate<T>>

build

public HttpRequestTemplate<T> build()

Specified by:

build in class ResourceGroup.TemplateBuilder<T,io.reactivex.netty.protocol.http.client.HttpClientResponse<io.netty.buffer.ByteBuf>,HttpRequestTemplate<T>>