/*
* Copyright 2012-2020 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.web.servlet.context;
import org.springframework.boot.web.context.WebServerInitializedEvent;
import org.springframework.boot.web.server.WebServer;
Event to be published after the WebServer
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 Since: 2.0.0
/**
* Event to be published after the {@link WebServer} is ready. Useful for obtaining the
* local port of a running server.
*
* <p>
* 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
* @since 2.0.0
*/
@SuppressWarnings("serial")
public class ServletWebServerInitializedEvent extends WebServerInitializedEvent {
private final ServletWebServerApplicationContext applicationContext;
public ServletWebServerInitializedEvent(WebServer webServer,
ServletWebServerApplicationContext applicationContext) {
super(webServer);
this.applicationContext = applicationContext;
}
Access the application context that the server was created in. Sometimes it is
prudent to check that this matches expectations (like being equal to the current
context) before acting on the server itself.
Returns: the applicationContext that the server was created from
/**
* Access the application context that the server was created in. Sometimes it is
* prudent to check that this matches expectations (like being equal to the current
* context) before acting on the server itself.
* @return the applicationContext that the server was created from
*/
@Override
public ServletWebServerApplicationContext getApplicationContext() {
return this.applicationContext;
}
}