Package com.linecorp.armeria.spring

Class AbstractArmeriaAutoConfiguration

java.lang.Object

com.linecorp.armeria.spring.AbstractArmeriaAutoConfiguration

Direct Known Subclasses:

ArmeriaAutoConfiguration

public abstract class AbstractArmeriaAutoConfiguration
extends Object

Abstract class for implementing ArmeriaAutoConfiguration.

Constructor Summary

Constructors

Constructor	Description
AbstractArmeriaAutoConfiguration()

Method Summary

Modifier and Type	Method	Description
com.linecorp.armeria.server.Server	armeriaServer(ArmeriaSettings armeriaSettings, InternalServices internalService, Optional<MeterRegistry> meterRegistry, ObjectProvider<MetricCollectingServiceConfigurator> metricCollectingServiceConfigurators, Optional<com.linecorp.armeria.common.metric.MeterIdPrefixFunction> meterIdPrefixFunction, ObjectProvider<ArmeriaServerConfigurator> armeriaServerConfigurators, ObjectProvider<Consumer<com.linecorp.armeria.server.ServerBuilder>> armeriaServerBuilderConsumers, ObjectProvider<com.linecorp.armeria.common.DependencyInjector> dependencyInjectors, ObjectProvider<com.linecorp.armeria.server.ServerErrorHandler> serverErrorHandlers, BeanFactory beanFactory)	Creates a started Server bean.
SmartLifecycle	armeriaServerGracefulShutdownLifecycle(com.linecorp.armeria.server.Server server)	Wrap Server with SmartLifecycle.
ArmeriaServerConfigurator	gracefulShutdownServerConfigurator(String shutdown, Duration duration)	A user can configure a Server by providing an ArmeriaServerConfigurator bean.
InternalServices	internalServices(ArmeriaSettings settings, Optional<MeterRegistry> meterRegistry, ObjectProvider<com.linecorp.armeria.server.healthcheck.HealthChecker> healthCheckers, ObjectProvider<HealthCheckServiceConfigurator> healthCheckServiceConfigurators, ObjectProvider<DocServiceConfigurator> docServiceConfigurators, @Nullable Integer managementServerPort, @Nullable InetAddress managementServerAddress, boolean enableManagementServerSsl)	Creates internal services that should not be exposed to the external network such as DocService, PrometheusExpositionService and HealthCheckService.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractArmeriaAutoConfiguration

public AbstractArmeriaAutoConfiguration()

Method Details

armeriaServer

@Bean
@ConditionalOnMissingBean(com.linecorp.armeria.server.Server.class)
public com.linecorp.armeria.server.Server armeriaServer(ArmeriaSettings armeriaSettings,
 InternalServices internalService,
 Optional<MeterRegistry> meterRegistry,
 ObjectProvider<MetricCollectingServiceConfigurator> metricCollectingServiceConfigurators,
 Optional<com.linecorp.armeria.common.metric.MeterIdPrefixFunction> meterIdPrefixFunction,
 ObjectProvider<ArmeriaServerConfigurator> armeriaServerConfigurators,
 ObjectProvider<Consumer<com.linecorp.armeria.server.ServerBuilder>> armeriaServerBuilderConsumers,
 ObjectProvider<com.linecorp.armeria.common.DependencyInjector> dependencyInjectors,
 ObjectProvider<com.linecorp.armeria.server.ServerErrorHandler> serverErrorHandlers,
 BeanFactory beanFactory)

Creates a started Server bean.

armeriaServerGracefulShutdownLifecycle

@Bean
@ConditionalOnMissingBean(ArmeriaServerSmartLifecycle.class)
public SmartLifecycle armeriaServerGracefulShutdownLifecycle(com.linecorp.armeria.server.Server server)

Wrap Server with SmartLifecycle.

internalServices

@Bean
public InternalServices internalServices(ArmeriaSettings settings,
 Optional<MeterRegistry> meterRegistry,
 ObjectProvider<com.linecorp.armeria.server.healthcheck.HealthChecker> healthCheckers,
 ObjectProvider<HealthCheckServiceConfigurator> healthCheckServiceConfigurators,
 ObjectProvider<DocServiceConfigurator> docServiceConfigurators,
 @Value("${management.server.port:#{null}}") @Nullable
 @Nullable Integer managementServerPort,
 @Value("${management.server.address:#{null}}") @Nullable
 @Nullable InetAddress managementServerAddress,
 @Value("${management.server.ssl.enabled:#{false}}")
 boolean enableManagementServerSsl)

Creates internal services that should not be exposed to the external network such as DocService, PrometheusExpositionService and HealthCheckService.

Note that if a service path is either null or empty, the associated service will not be initiated. For example, ArmeriaSettings.getHealthCheckPath() is null, HealthCheckService will not be created automatically.

See Also:

• ArmeriaSettings.getDocsPath()
• ArmeriaSettings.getMetricsPath()
• ArmeriaSettings.getHealthCheckPath()

gracefulShutdownServerConfigurator

@Bean
@ConditionalOnProperty("server.shutdown")
public ArmeriaServerConfigurator gracefulShutdownServerConfigurator(@Value("${server.shutdown}")
 String shutdown,
 @Value("${spring.lifecycle.timeout-per-shutdown-phase:30s}")
 Duration duration)

A user can configure a Server by providing an ArmeriaServerConfigurator bean.