All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Please wait. This can take some minutes ...
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.springframework.boot.actuate.autoconfigure.web.server.ChildManagementContextInitializer Maven / Gradle / Ivy
/*
* Copyright 2012-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.actuate.autoconfigure.web.server;
import java.util.List;
import javax.lang.model.element.Modifier;
import org.springframework.aot.generate.GeneratedMethod;
import org.springframework.aot.generate.GenerationContext;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.aot.BeanRegistrationAotContribution;
import org.springframework.beans.factory.aot.BeanRegistrationAotProcessor;
import org.springframework.beans.factory.aot.BeanRegistrationCode;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.support.RegisteredBean;
import org.springframework.boot.LazyInitializationBeanFactoryPostProcessor;
import org.springframework.boot.actuate.autoconfigure.web.ManagementContextFactory;
import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration;
import org.springframework.boot.context.event.ApplicationFailedEvent;
import org.springframework.boot.web.context.ConfigurableWebServerApplicationContext;
import org.springframework.boot.web.context.WebServerApplicationContext;
import org.springframework.boot.web.context.WebServerGracefulShutdownLifecycle;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextInitializer;
import org.springframework.context.ApplicationEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.SmartLifecycle;
import org.springframework.context.annotation.AnnotationConfigRegistry;
import org.springframework.context.aot.ApplicationContextAotGenerator;
import org.springframework.context.event.ContextClosedEvent;
import org.springframework.context.support.AbstractApplicationContext;
import org.springframework.context.support.GenericApplicationContext;
import org.springframework.core.io.DefaultResourceLoader;
import org.springframework.javapoet.ClassName;
import org.springframework.util.Assert;
/**
* {@link ApplicationListener} used to initialize the management context when it's running
* on a different port.
*
* @author Andy Wilkinson
* @author Phillip Webb
*/
class ChildManagementContextInitializer implements BeanRegistrationAotProcessor, SmartLifecycle {
private final ManagementContextFactory managementContextFactory;
private final ApplicationContext parentContext;
private final ApplicationContextInitializer applicationContextInitializer;
private volatile ConfigurableApplicationContext managementContext;
ChildManagementContextInitializer(ManagementContextFactory managementContextFactory,
ApplicationContext parentContext) {
this(managementContextFactory, parentContext, null);
}
@SuppressWarnings("unchecked")
private ChildManagementContextInitializer(ManagementContextFactory managementContextFactory,
ApplicationContext parentContext,
ApplicationContextInitializer applicationContextInitializer) {
this.managementContextFactory = managementContextFactory;
this.parentContext = parentContext;
this.applicationContextInitializer = (ApplicationContextInitializer) applicationContextInitializer;
}
@Override
public void start() {
if (!(this.parentContext instanceof WebServerApplicationContext)) {
return;
}
if (this.managementContext == null) {
ConfigurableApplicationContext managementContext = createManagementContext();
registerBeans(managementContext);
managementContext.refresh();
this.managementContext = managementContext;
}
else {
this.managementContext.start();
}
}
@Override
public void stop() {
if (this.managementContext != null) {
this.managementContext.stop();
}
}
@Override
public boolean isRunning() {
return this.managementContext != null && this.managementContext.isRunning();
}
@Override
public int getPhase() {
return WebServerGracefulShutdownLifecycle.SMART_LIFECYCLE_PHASE + 512;
}
@Override
public BeanRegistrationAotContribution processAheadOfTime(RegisteredBean registeredBean) {
Assert.isInstanceOf(ConfigurableApplicationContext.class, this.parentContext);
BeanFactory parentBeanFactory = ((ConfigurableApplicationContext) this.parentContext).getBeanFactory();
if (registeredBean.getBeanClass().equals(getClass())
&& registeredBean.getBeanFactory().equals(parentBeanFactory)) {
ConfigurableApplicationContext managementContext = createManagementContext();
registerBeans(managementContext);
return new AotContribution(managementContext);
}
return null;
}
@Override
public boolean isBeanExcludedFromAotProcessing() {
return false;
}
private void registerBeans(ConfigurableApplicationContext managementContext) {
if (this.applicationContextInitializer != null) {
this.applicationContextInitializer.initialize(managementContext);
return;
}
Assert.isInstanceOf(AnnotationConfigRegistry.class, managementContext);
AnnotationConfigRegistry registry = (AnnotationConfigRegistry) managementContext;
this.managementContextFactory.registerWebServerFactoryBeans(this.parentContext, managementContext, registry);
registry.register(EnableChildManagementContextConfiguration.class, PropertyPlaceholderAutoConfiguration.class);
if (isLazyInitialization()) {
managementContext.addBeanFactoryPostProcessor(new LazyInitializationBeanFactoryPostProcessor());
}
}
protected final ConfigurableApplicationContext createManagementContext() {
ConfigurableApplicationContext managementContext = this.managementContextFactory
.createManagementContext(this.parentContext);
managementContext.setId(this.parentContext.getId() + ":management");
if (managementContext instanceof ConfigurableWebServerApplicationContext webServerApplicationContext) {
webServerApplicationContext.setServerNamespace("management");
}
if (managementContext instanceof DefaultResourceLoader resourceLoader) {
resourceLoader.setClassLoader(this.parentContext.getClassLoader());
}
CloseManagementContextListener.addIfPossible(this.parentContext, managementContext);
return managementContext;
}
private boolean isLazyInitialization() {
AbstractApplicationContext context = (AbstractApplicationContext) this.parentContext;
List postProcessors = context.getBeanFactoryPostProcessors();
return postProcessors.stream().anyMatch(LazyInitializationBeanFactoryPostProcessor.class::isInstance);
}
ChildManagementContextInitializer withApplicationContextInitializer(
ApplicationContextInitializer applicationContextInitializer) {
return new ChildManagementContextInitializer(this.managementContextFactory, this.parentContext,
applicationContextInitializer);
}
/**
* {@link BeanRegistrationAotContribution} for
* {@link ChildManagementContextInitializer}.
*/
private static class AotContribution implements BeanRegistrationAotContribution {
private final GenericApplicationContext managementContext;
AotContribution(ConfigurableApplicationContext managementContext) {
Assert.isInstanceOf(GenericApplicationContext.class, managementContext);
this.managementContext = (GenericApplicationContext) managementContext;
}
@Override
public void applyTo(GenerationContext generationContext, BeanRegistrationCode beanRegistrationCode) {
GenerationContext managementGenerationContext = generationContext.withName("Management");
ClassName generatedInitializerClassName = new ApplicationContextAotGenerator()
.processAheadOfTime(this.managementContext, managementGenerationContext);
GeneratedMethod postProcessorMethod = beanRegistrationCode.getMethods()
.add("addManagementInitializer",
(method) -> method.addJavadoc("Use AOT management context initialization")
.addModifiers(Modifier.PRIVATE, Modifier.STATIC)
.addParameter(RegisteredBean.class, "registeredBean")
.addParameter(ChildManagementContextInitializer.class, "instance")
.returns(ChildManagementContextInitializer.class)
.addStatement("return instance.withApplicationContextInitializer(new $L())",
generatedInitializerClassName));
beanRegistrationCode.addInstancePostProcessor(postProcessorMethod.toMethodReference());
}
}
/**
* {@link ApplicationListener} to propagate the {@link ContextClosedEvent} and
* {@link ApplicationFailedEvent} from a parent to a child.
*/
private static class CloseManagementContextListener implements ApplicationListener {
private final ApplicationContext parentContext;
private final ConfigurableApplicationContext childContext;
CloseManagementContextListener(ApplicationContext parentContext, ConfigurableApplicationContext childContext) {
this.parentContext = parentContext;
this.childContext = childContext;
}
@Override
public void onApplicationEvent(ApplicationEvent event) {
if (event instanceof ContextClosedEvent contextClosedEvent) {
onContextClosedEvent(contextClosedEvent);
}
if (event instanceof ApplicationFailedEvent applicationFailedEvent) {
onApplicationFailedEvent(applicationFailedEvent);
}
}
private void onContextClosedEvent(ContextClosedEvent event) {
propagateCloseIfNecessary(event.getApplicationContext());
}
private void onApplicationFailedEvent(ApplicationFailedEvent event) {
propagateCloseIfNecessary(event.getApplicationContext());
}
private void propagateCloseIfNecessary(ApplicationContext applicationContext) {
if (applicationContext == this.parentContext) {
this.childContext.close();
}
}
static void addIfPossible(ApplicationContext parentContext, ConfigurableApplicationContext childContext) {
if (parentContext instanceof ConfigurableApplicationContext configurableApplicationContext) {
add(configurableApplicationContext, childContext);
}
}
private static void add(ConfigurableApplicationContext parentContext,
ConfigurableApplicationContext childContext) {
parentContext.addApplicationListener(new CloseManagementContextListener(parentContext, childContext));
}
}
}