Package io.micronaut.http.client

Class ServiceHttpClientConfiguration

java.lang.Object

io.micronaut.http.client.HttpClientConfiguration

io.micronaut.http.client.ServiceHttpClientConfiguration

All Implemented Interfaces:

ClientContextPathProvider

@EachProperty("micronaut.http.services")
public class ServiceHttpClientConfiguration
extends HttpClientConfiguration
implements ClientContextPathProvider

Allows defining HTTP client configurations via the micronaut.http.services setting.

Since:

1.0

Author:

graemerocher

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServiceHttpClientConfiguration.ServiceConnectionPoolConfiguration	The default connection pool configuration.
static class	ServiceHttpClientConfiguration.ServiceSslClientConfiguration	The default connection pool configuration.
static class	ServiceHttpClientConfiguration.ServiceWebSocketCompressionConfiguration	The default WebSocket compression configuration.

Nested classes/interfaces inherited from class io.micronaut.http.client.HttpClientConfiguration

HttpClientConfiguration.ConnectionPoolConfiguration, HttpClientConfiguration.WebSocketCompressionConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_HEALTHCHECK	The default health check value.
static final long	DEFAULT_HEALTHCHECKINTERVAL_SECONDS	The default health check interval in seconds.
static final String	DEFAULT_HEALTHCHECKURI	The default health check uri.
static final String	PREFIX	Prefix for HTTP Client settings.

Fields inherited from class io.micronaut.http.client.HttpClientConfiguration

DEFAULT_ALLOW_BLOCK_EVENT_LOOP, DEFAULT_CONNECTION_POOL_IDLE_TIMEOUT_SECONDS, DEFAULT_EXCEPTION_ON_ERROR_STATUS, DEFAULT_FOLLOW_REDIRECTS, DEFAULT_MAX_CONTENT_LENGTH, DEFAULT_READ_IDLE_TIMEOUT_MINUTES, DEFAULT_READ_TIMEOUT_SECONDS, DEFAULT_SHUTDOWN_QUIET_PERIOD_MILLISECONDS, DEFAULT_SHUTDOWN_TIMEOUT_MILLISECONDS

Constructor Summary

Constructors

Constructor	Description
ServiceHttpClientConfiguration(String serviceId, @Nullable ServiceHttpClientConfiguration.ServiceConnectionPoolConfiguration connectionPoolConfiguration, @Nullable ServiceHttpClientConfiguration.ServiceSslClientConfiguration sslConfiguration, HttpClientConfiguration defaultHttpClientConfiguration)	Deprecated. Use ServiceHttpClientConfiguration(java.lang.String,@io.micronaut.core.annotation.Nullable io.micronaut.http.client.ServiceHttpClientConfiguration.ServiceConnectionPoolConfiguration,@io.micronaut.core.annotation.Nullable io.micronaut.http.client.ServiceHttpClientConfiguration.ServiceWebSocketCompressionConfiguration,@io.micronaut.core.annotation.Nullable io.micronaut.http.client.ServiceHttpClientConfiguration.ServiceSslClientConfiguration,io.micronaut.http.client.HttpClientConfiguration) instead.
ServiceHttpClientConfiguration(String serviceId, @Nullable ServiceHttpClientConfiguration.ServiceConnectionPoolConfiguration connectionPoolConfiguration, @Nullable ServiceHttpClientConfiguration.ServiceSslClientConfiguration sslConfiguration, ApplicationConfiguration applicationConfiguration)	Creates a new client configuration for the given service ID.
ServiceHttpClientConfiguration(String serviceId, @Nullable ServiceHttpClientConfiguration.ServiceConnectionPoolConfiguration connectionPoolConfiguration, @Nullable ServiceHttpClientConfiguration.ServiceWebSocketCompressionConfiguration webSocketCompressionConfiguration, @Nullable ServiceHttpClientConfiguration.ServiceSslClientConfiguration sslConfiguration, HttpClientConfiguration defaultHttpClientConfiguration)	Creates a new client configuration for the given service ID.

Method Summary

Modifier and Type	Method	Description
HttpClientConfiguration.ConnectionPoolConfiguration	getConnectionPoolConfiguration()	Obtains the connection pool configuration.
Optional<String>	getContextPath()
Duration	getHealthCheckInterval()	The default duration to check health status.
String	getHealthCheckUri()	The URI to check the service for health status.
Optional<String>	getPath()	The context path to use for requests.
String	getServiceId()	The service id.
List<URI>	getUrls()	The URLs.
HttpClientConfiguration.WebSocketCompressionConfiguration	getWebSocketCompressionConfiguration()	Obtains the WebSocket compression configuration.
boolean	isHealthCheck()	Whether the service health should be checked.
void	setHealthCheck(boolean healthCheck)	Sets whether the service health should be checked.
void	setHealthCheckInterval(Duration healthCheckInterval)	Sets the default duration to check health status.
void	setHealthCheckUri(String healthCheckUri)	Sets the health check URI.
void	setPath(String path)	Sets the context path to use for requests.
void	setUrl(URI url)	Sets the URL of the service.
void	setUrls(List<URI> urls)	Sets the URIs of the service.

Methods inherited from class io.micronaut.http.client.HttpClientConfiguration

getAlpnModes, getChannelOptions, getConnectionPoolIdleTimeout, getConnectTimeout, getConnectTtl, getDefaultCharset, getEventLoopGroup, getHttpVersion, getLoggerName, getLogLevel, getMaxContentLength, getNumOfThreads, getPlaintextMode, getProxyAddress, getProxyPassword, getProxySelector, getProxyType, getProxyUsername, getReadIdleTimeout, getReadTimeout, getShutdownQuietPeriod, getShutdownTimeout, getSslConfiguration, getThreadFactory, isAllowBlockEventLoop, isExceptionOnErrorStatus, isFollowRedirects, resolveProxy, setAllowBlockEventLoop, setAlpnModes, setChannelOptions, setConnectionPoolIdleTimeout, setConnectTimeout, setConnectTtl, setDefaultCharset, setEventLoopGroup, setExceptionOnErrorStatus, setFollowRedirects, setHttpVersion, setLoggerName, setLogLevel, setMaxContentLength, setNumOfThreads, setPlaintextMode, setProxyAddress, setProxyPassword, setProxySelector, setProxyType, setProxyUsername, setReadIdleTimeout, setReadTimeout, setShutdownQuietPeriod, setShutdownTimeout, setSslConfiguration, setThreadFactory

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

Prefix for HTTP Client settings.

See Also:

• Constant Field Values

DEFAULT_HEALTHCHECKURI

public static final String DEFAULT_HEALTHCHECKURI

The default health check uri.

See Also:

• Constant Field Values

DEFAULT_HEALTHCHECK

public static final boolean DEFAULT_HEALTHCHECK

The default health check value.

See Also:

• Constant Field Values

DEFAULT_HEALTHCHECKINTERVAL_SECONDS

public static final long DEFAULT_HEALTHCHECKINTERVAL_SECONDS

The default health check interval in seconds.

See Also:

• Constant Field Values

Constructor Details

ServiceHttpClientConfiguration

public ServiceHttpClientConfiguration(@Parameter
 String serviceId,
 @Nullable
 @Nullable ServiceHttpClientConfiguration.ServiceConnectionPoolConfiguration connectionPoolConfiguration,
 @Nullable
 @Nullable ServiceHttpClientConfiguration.ServiceSslClientConfiguration sslConfiguration,
 ApplicationConfiguration applicationConfiguration)

Creates a new client configuration for the given service ID.

Parameters:

serviceId - The service id

connectionPoolConfiguration - The connection pool configuration

sslConfiguration - The SSL configuration

applicationConfiguration - The application configuration

ServiceHttpClientConfiguration

@Deprecated(since="4.3.0")
public ServiceHttpClientConfiguration(@Parameter
 String serviceId,
 @Nullable
 @Nullable ServiceHttpClientConfiguration.ServiceConnectionPoolConfiguration connectionPoolConfiguration,
 @Nullable
 @Nullable ServiceHttpClientConfiguration.ServiceSslClientConfiguration sslConfiguration,
 HttpClientConfiguration defaultHttpClientConfiguration)

Deprecated.

Use ServiceHttpClientConfiguration(java.lang.String,@io.micronaut.core.annotation.Nullable io.micronaut.http.client.ServiceHttpClientConfiguration.ServiceConnectionPoolConfiguration,@io.micronaut.core.annotation.Nullable io.micronaut.http.client.ServiceHttpClientConfiguration.ServiceWebSocketCompressionConfiguration,@io.micronaut.core.annotation.Nullable io.micronaut.http.client.ServiceHttpClientConfiguration.ServiceSslClientConfiguration,io.micronaut.http.client.HttpClientConfiguration) instead.

Creates a new client configuration for the given service ID.

Parameters:

serviceId - The service id

connectionPoolConfiguration - The connection pool configuration

sslConfiguration - The SSL configuration

defaultHttpClientConfiguration - The default HTTP client configuration

ServiceHttpClientConfiguration

@Inject
public ServiceHttpClientConfiguration(@Parameter
 String serviceId,
 @Nullable
 @Nullable ServiceHttpClientConfiguration.ServiceConnectionPoolConfiguration connectionPoolConfiguration,
 @Nullable
 @Nullable ServiceHttpClientConfiguration.ServiceWebSocketCompressionConfiguration webSocketCompressionConfiguration,
 @Nullable
 @Nullable ServiceHttpClientConfiguration.ServiceSslClientConfiguration sslConfiguration,
 HttpClientConfiguration defaultHttpClientConfiguration)

Creates a new client configuration for the given service ID.

Parameters:

serviceId - The service id

connectionPoolConfiguration - The connection pool configuration

webSocketCompressionConfiguration - The WebSocket compression configuration

sslConfiguration - The SSL configuration

defaultHttpClientConfiguration - The default HTTP client configuration

Method Details

getServiceId

public String getServiceId()

The service id.

Returns:

The ID of the service

getUrls

public List<URI> getUrls()

The URLs.

Returns:

The URLs of the service

setUrls

public void setUrls(List<URI> urls)

Sets the URIs of the service.

Parameters:

urls - The URIs

setUrl

public void setUrl(URI url)

Sets the URL of the service.

Parameters:

url - The URI

getHealthCheckUri

public String getHealthCheckUri()

The URI to check the service for health status.

Returns:

The health status uri

setHealthCheckUri

public void setHealthCheckUri(String healthCheckUri)

Sets the health check URI. Default value ("/health").

Parameters:

healthCheckUri - The health check URI

isHealthCheck

public boolean isHealthCheck()

Whether the service health should be checked.

Returns:

True if the health should be checked

setHealthCheck

public void setHealthCheck(boolean healthCheck)

Sets whether the service health should be checked. Default value (false).

Parameters:

healthCheck - True if the health should be checked

getPath

public Optional<String> getPath()

The context path to use for requests.

Returns:

The context path

setPath

public void setPath(String path)

Sets the context path to use for requests.

Parameters:

path - The context path

getContextPath

public Optional<String> getContextPath()

Specified by:

getContextPath in interface ClientContextPathProvider

Returns:

An optional context path

getHealthCheckInterval

public Duration getHealthCheckInterval()

The default duration to check health status.

Returns:

The duration

setHealthCheckInterval

public void setHealthCheckInterval(Duration healthCheckInterval)

Sets the default duration to check health status. Default value (30L seconds).

Parameters:

healthCheckInterval - The duration

getConnectionPoolConfiguration

public HttpClientConfiguration.ConnectionPoolConfiguration getConnectionPoolConfiguration()

Description copied from class: HttpClientConfiguration

Obtains the connection pool configuration.

Specified by:

getConnectionPoolConfiguration in class HttpClientConfiguration

Returns:

The connection pool configuration.

getWebSocketCompressionConfiguration

public HttpClientConfiguration.WebSocketCompressionConfiguration getWebSocketCompressionConfiguration()

Description copied from class: HttpClientConfiguration

Obtains the WebSocket compression configuration.

Overrides:

getWebSocketCompressionConfiguration in class HttpClientConfiguration

Returns:

The WebSocket compression configuration.