diff --git a/spring-boot/src/main/java/org/springframework/boot/context/embedded/EmbeddedServletContainerInitializedEvent.java b/spring-boot/src/main/java/org/springframework/boot/context/embedded/EmbeddedServletContainerInitializedEvent.java new file mode 100644 index 00000000000..bbece783595 --- /dev/null +++ b/spring-boot/src/main/java/org/springframework/boot/context/embedded/EmbeddedServletContainerInitializedEvent.java @@ -0,0 +1,40 @@ +/* + * Copyright 2012-2013 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 + * + * http://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.context.embedded; + +import org.springframework.context.ApplicationEvent; + +/** + * Event to be published after the context is refreshed and the + * {@link EmbeddedServletContainer} is ready. Useful for obtaining the local port of a + * running server. Normally it will have been started, but listeners are free to inspect + * the server and stop and start it if they want to. + * + * @author Dave Syer + */ +public class EmbeddedServletContainerInitializedEvent extends ApplicationEvent { + + public EmbeddedServletContainerInitializedEvent(EmbeddedServletContainer source) { + super(source); + } + + @Override + public EmbeddedServletContainer getSource() { + return (EmbeddedServletContainer) super.getSource(); + } + +} diff --git a/spring-boot/src/main/java/org/springframework/boot/context/embedded/EmbeddedWebApplicationContext.java b/spring-boot/src/main/java/org/springframework/boot/context/embedded/EmbeddedWebApplicationContext.java index eb6130cad6c..c9b46593303 100644 --- a/spring-boot/src/main/java/org/springframework/boot/context/embedded/EmbeddedWebApplicationContext.java +++ b/spring-boot/src/main/java/org/springframework/boot/context/embedded/EmbeddedWebApplicationContext.java @@ -146,6 +146,10 @@ public class EmbeddedWebApplicationContext extends GenericWebApplicationContext protected void finishRefresh() { super.finishRefresh(); startEmbeddedServletContainer(); + if (this.embeddedServletContainer != null) { + publishEvent(new EmbeddedServletContainerInitializedEvent( + this.embeddedServletContainer)); + } } @Override diff --git a/spring-boot/src/test/java/org/springframework/boot/context/embedded/EmbeddedWebApplicationContextTests.java b/spring-boot/src/test/java/org/springframework/boot/context/embedded/EmbeddedWebApplicationContextTests.java index c193062bc30..f953e5ad2ec 100644 --- a/spring-boot/src/test/java/org/springframework/boot/context/embedded/EmbeddedWebApplicationContextTests.java +++ b/spring-boot/src/test/java/org/springframework/boot/context/embedded/EmbeddedWebApplicationContextTests.java @@ -35,6 +35,7 @@ import org.springframework.beans.factory.config.BeanDefinition; import org.springframework.beans.factory.config.ConstructorArgumentValues; import org.springframework.beans.factory.support.RootBeanDefinition; import org.springframework.context.ApplicationContextException; +import org.springframework.context.ApplicationListener; import org.springframework.context.support.AbstractApplicationContext; import org.springframework.context.support.PropertySourcesPlaceholderConfigurer; import org.springframework.core.Ordered; @@ -46,7 +47,9 @@ import static org.hamcrest.Matchers.equalTo; import static org.hamcrest.Matchers.instanceOf; import static org.hamcrest.Matchers.not; import static org.hamcrest.Matchers.nullValue; +import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertThat; +import static org.junit.Assert.assertTrue; import static org.mockito.BDDMockito.given; import static org.mockito.Matchers.anyObject; import static org.mockito.Matchers.anyString; @@ -115,6 +118,18 @@ public class EmbeddedWebApplicationContextTests { assertThat(shutdownHook, not(nullValue())); } + @Test + public void containerEventPublished() throws Exception { + addEmbeddedServletContainerFactoryBean(); + this.context.registerBeanDefinition("listener", new RootBeanDefinition( + MockListener.class)); + this.context.refresh(); + EmbeddedServletContainerInitializedEvent event = this.context.getBean( + MockListener.class).getEvent(); + assertNotNull(event); + assertTrue(event.getSource().getPort() >= 0); + } + @Test public void stopOnClose() throws Exception { addEmbeddedServletContainerFactoryBean(); @@ -387,4 +402,20 @@ public class EmbeddedWebApplicationContextTests { public static T getBean(T object) { return object; } + + public static class MockListener implements + ApplicationListener { + + private EmbeddedServletContainerInitializedEvent event; + + @Override + public void onApplicationEvent(EmbeddedServletContainerInitializedEvent event) { + this.event = event; + } + + public EmbeddedServletContainerInitializedEvent getEvent() { + return this.event; + } + + } }