feign

Class Request.Options

java.lang.Object

feign.Request.Options

Enclosing class:

Request

public static class Request.Options
extends Object

Controls the per-request settings currently required to be implemented by all clients

Constructor Summary

Constructors

Constructor and Description
Options() Creates the new Options instance using the following defaults: Connect Timeout: 10 seconds Read Timeout: 60 seconds Follow all 3xx redirects
Options(Duration connectTimeout, Duration readTimeout, boolean followRedirects) Creates a new Options Instance.
Options(int connectTimeoutMillis, int readTimeoutMillis) Deprecated. please use Options(long, TimeUnit, long, TimeUnit, boolean)
Options(int connectTimeoutMillis, int readTimeoutMillis, boolean followRedirects) Deprecated. please use Options(long, TimeUnit, long, TimeUnit, boolean)
Options(long connectTimeout, TimeUnit connectTimeoutUnit, long readTimeout, TimeUnit readTimeoutUnit, boolean followRedirects) Creates a new Options Instance.

Method Summary

Modifier and Type	Method and Description
long	connectTimeout() Connect Timeout Value.
int	connectTimeoutMillis() Defaults to 10 seconds.
TimeUnit	connectTimeoutUnit() TimeUnit for the Connection Timeout value.
Request.Options	getMethodOptions(String methodName) Get an Options by methodName
boolean	isFollowRedirects() Defaults to true.
long	readTimeout() Read Timeout value.
int	readTimeoutMillis() Defaults to 60 seconds.
TimeUnit	readTimeoutUnit() TimeUnit for the Read Timeout value.
void	setMethodOptions(String methodName, Request.Options options) Set methodOptions by methodKey and options

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

@Deprecated
public Options(int connectTimeoutMillis,
                           int readTimeoutMillis,
                           boolean followRedirects)

Deprecated. please use Options(long, TimeUnit, long, TimeUnit, boolean)

Creates a new Options instance.

Parameters:

connectTimeoutMillis - connection timeout in milliseconds.

readTimeoutMillis - read timeout in milliseconds.

followRedirects - if the request should follow 3xx redirections.

Options

public Options(long connectTimeout,
               TimeUnit connectTimeoutUnit,
               long readTimeout,
               TimeUnit readTimeoutUnit,
               boolean followRedirects)

Creates a new Options Instance.

Parameters:

connectTimeout - value.

connectTimeoutUnit - with the TimeUnit for the timeout value.

readTimeout - value.

readTimeoutUnit - with the TimeUnit for the timeout value.

followRedirects - if the request should follow 3xx redirections.

Options

@Deprecated
public Options(int connectTimeoutMillis,
                           int readTimeoutMillis)

Deprecated. please use Options(long, TimeUnit, long, TimeUnit, boolean)

Creates a new Options instance that follows redirects by default.

Parameters:

connectTimeoutMillis - connection timeout in milliseconds.

readTimeoutMillis - read timeout in milliseconds.

Options

public Options(Duration connectTimeout,
               Duration readTimeout,
               boolean followRedirects)

Creates a new Options Instance.

Parameters:

connectTimeout - value.

readTimeout - value.

followRedirects - if the request should follow 3xx redirections.

Options

public Options()

Creates the new Options instance using the following defaults:

• Connect Timeout: 10 seconds
• Read Timeout: 60 seconds
• Follow all 3xx redirects

Method Detail

getMethodOptions

@Experimental
public Request.Options getMethodOptions(String methodName)

Get an Options by methodName

Parameters:

methodName - it's your FeignInterface method name.

Returns:

method Options

setMethodOptions

@Experimental
public void setMethodOptions(String methodName,
                                           Request.Options options)

Set methodOptions by methodKey and options

Parameters:

methodName - it's your FeignInterface method name.

options - it's the Options for this method.

connectTimeoutMillis

public int connectTimeoutMillis()

Defaults to 10 seconds. 0 implies no timeout.

See Also:

URLConnection.getConnectTimeout()

readTimeoutMillis

public int readTimeoutMillis()

Defaults to 60 seconds. 0 implies no timeout.

See Also:

URLConnection.getReadTimeout()

isFollowRedirects

public boolean isFollowRedirects()

Defaults to true. false tells the client to not follow the redirections.

See Also:

HttpURLConnection.getFollowRedirects()

connectTimeout

public long connectTimeout()

Connect Timeout Value.

Returns:

current timeout value.

connectTimeoutUnit

public TimeUnit connectTimeoutUnit()

TimeUnit for the Connection Timeout value.

Returns:

TimeUnit

readTimeout

public long readTimeout()

Read Timeout value.

Returns:

current read timeout value.

readTimeoutUnit

public TimeUnit readTimeoutUnit()

TimeUnit for the Read Timeout value.

Returns:

TimeUnit