Package com.linecorp.armeria.spring

Class ArmeriaSettings

java.lang.Object

com.linecorp.armeria.spring.ArmeriaSettings

@ConfigurationProperties(prefix="armeria")
@Validated
public class ArmeriaSettings
extends Object

Settings for armeria servers. For example:

 armeria:
   ports:
     - port: 8080
       protocol: HTTP
     - ip: 127.0.0.1
       port: 8081
       protocol:HTTP
     - port: 8443
       protocol: HTTPS
   ssl:
     key-alias: "host.name.com"
     key-store: "keystore.jks"
     key-store-password: "changeme"
     trust-store: "truststore.jks"
     trust-store-password: "changeme"
   compression:
     enabled: true
     mime-types: text/*, application/json
     excluded-user-agents: some-user-agent, another-user-agent
     min-response-size: 1KB
 

TODO(ide) Adds virtualhost settings

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ArmeriaSettings.Compression	Configurations for the HTTP content encoding.
static class	ArmeriaSettings.Port	Port and protocol settings.

Constructor Summary

Constructors

Constructor	Description
ArmeriaSettings()

Method Summary

Modifier and Type	Method	Description
ArmeriaSettings.Compression	getCompression()	Returns the HTTP content encoding configuration that the Server uses.
String	getDocsPath()	Returns the path of the DocService.
long	getGracefulShutdownQuietPeriodMillis()	Returns the number of milliseconds to wait for active requests to go end before shutting down.
long	getGracefulShutdownTimeoutMillis()	Returns the number of milliseconds to wait before shutting down the server regardless of active requests.
String	getHealthCheckPath()	Returns the path of the HealthCheckService.
String	getMetricsPath()	Returns the path of the metrics exposition service.
List<ArmeriaSettings.Port>	getPorts()	Returns the ArmeriaSettings.Ports of the Server.
Ssl	getSsl()	Returns the Ssl configuration that the Server uses.
boolean	isEnableMetrics()	Returns whether to enable metrics exposition service at the path specified via setMetricsPath(String).
void	setCompression(ArmeriaSettings.Compression compression)	Sets the HTTP content encoding configuration that the Server uses.
void	setDocsPath(String docsPath)	Sets the path of the DocService.
void	setEnableMetrics(boolean enableMetrics)	Sets whether to enable metrics exposition service at the path specified via setMetricsPath(String).
void	setGracefulShutdownQuietPeriodMillis(long gracefulShutdownQuietPeriodMillis)	Sets the number of milliseconds to wait for active requests to go end before shutting down.
void	setGracefulShutdownTimeoutMillis(long gracefulShutdownTimeoutMillis)	Sets the number of milliseconds to wait before shutting down the server regardless of active requests.
void	setHealthCheckPath(String healthCheckPath)	Sets the path of the HealthCheckService.
void	setMetricsPath(String metricsPath)	Sets the path of the metrics exposition service.
void	setPorts(List<ArmeriaSettings.Port> ports)	Sets the ArmeriaSettings.Ports of the Server.
void	setSsl(Ssl ssl)	Sets the Ssl configuration that the Server uses.

Methods inherited from class java.lang.Object

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

Constructor Details

ArmeriaSettings

public ArmeriaSettings()

Method Details

getPorts

public List<ArmeriaSettings.Port> getPorts()

Returns the ArmeriaSettings.Ports of the Server.

setPorts

public void setPorts(List<ArmeriaSettings.Port> ports)

Sets the ArmeriaSettings.Ports of the Server.

getHealthCheckPath

@Nullable public String getHealthCheckPath()

Returns the path of the HealthCheckService.

setHealthCheckPath

public void setHealthCheckPath(@Nullable String healthCheckPath)

Sets the path of the HealthCheckService.

getDocsPath

@Nullable public String getDocsPath()

Returns the path of the DocService.

setDocsPath

public void setDocsPath(@Nullable String docsPath)

Sets the path of the DocService.

getMetricsPath

@Nullable public String getMetricsPath()

Returns the path of the metrics exposition service. PrometheusExpositionService will be used if PrometheusMeterRegistry is available. Otherwise, Dropwizard's MetricsModule will be used if DropwizardMeterRegistry is available.

setMetricsPath

public void setMetricsPath(@Nullable String metricsPath)

Sets the path of the metrics exposition service. PrometheusExpositionService will be used if PrometheusMeterRegistry is available. Otherwise, Dropwizard's MetricsModule will be used if DropwizardMeterRegistry is available.

getGracefulShutdownQuietPeriodMillis

public long getGracefulShutdownQuietPeriodMillis()

Returns the number of milliseconds to wait for active requests to go end before shutting down.

See Also:

getGracefulShutdownTimeoutMillis(), ServerBuilder.gracefulShutdownTimeout(Duration, Duration)

setGracefulShutdownQuietPeriodMillis

public void setGracefulShutdownQuietPeriodMillis(long gracefulShutdownQuietPeriodMillis)

Sets the number of milliseconds to wait for active requests to go end before shutting down.

See Also:

setGracefulShutdownTimeoutMillis(long), ServerBuilder.gracefulShutdownTimeout(Duration, Duration)

getGracefulShutdownTimeoutMillis

public long getGracefulShutdownTimeoutMillis()

Returns the number of milliseconds to wait before shutting down the server regardless of active requests.

See Also:

getGracefulShutdownQuietPeriodMillis(), ServerBuilder.gracefulShutdownTimeout(Duration, Duration)

setGracefulShutdownTimeoutMillis

public void setGracefulShutdownTimeoutMillis(long gracefulShutdownTimeoutMillis)

Sets the number of milliseconds to wait before shutting down the server regardless of active requests.

See Also:

setGracefulShutdownQuietPeriodMillis(long), ServerBuilder.gracefulShutdownTimeout(Duration, Duration)

isEnableMetrics

public boolean isEnableMetrics()

Returns whether to enable metrics exposition service at the path specified via setMetricsPath(String).

setEnableMetrics

public void setEnableMetrics(boolean enableMetrics)

Sets whether to enable metrics exposition service at the path specified via setMetricsPath(String).

getSsl

@Nullable public Ssl getSsl()

Returns the Ssl configuration that the Server uses.

setSsl

public void setSsl(Ssl ssl)

Sets the Ssl configuration that the Server uses.

getCompression

@Nullable public ArmeriaSettings.Compression getCompression()

Returns the HTTP content encoding configuration that the Server uses.

setCompression

public void setCompression(ArmeriaSettings.Compression compression)

Sets the HTTP content encoding configuration that the Server uses.