Class WebServerPortFileWriter
java.lang.Object
org.springframework.boot.web.context.WebServerPortFileWriter
- All Implemented Interfaces:
EventListener
,ApplicationListener<WebServerInitializedEvent>
public class WebServerPortFileWriter
extends Object
implements ApplicationListener<WebServerInitializedEvent>
An
ApplicationListener
that saves embedded server port and management port into
file. This application listener will be triggered whenever the server starts, and the
file name can be overridden at runtime with a System property or environment variable
named "PORTFILE" or "portfile".- Since:
- 2.0.0
- Author:
- David Liu, Phillip Webb, Andy Wilkinson
-
Constructor Summary
ConstructorDescriptionCreate a newWebServerPortFileWriter
instance using the filename 'application.port'.WebServerPortFileWriter
(File file) Create a newWebServerPortFileWriter
instance with a specified file.WebServerPortFileWriter
(String filename) Create a newWebServerPortFileWriter
instance with a specified filename. -
Method Summary
Modifier and TypeMethodDescriptionprotected File
getPortFile
(ApplicationContext applicationContext) Return the actual port file that should be written for the given application context.void
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.context.ApplicationListener
supportsAsyncExecution
-
Constructor Details
-
WebServerPortFileWriter
public WebServerPortFileWriter()Create a newWebServerPortFileWriter
instance using the filename 'application.port'. -
WebServerPortFileWriter
Create a newWebServerPortFileWriter
instance with a specified filename.- Parameters:
filename
- the name of file containing port
-
WebServerPortFileWriter
Create a newWebServerPortFileWriter
instance with a specified file.- Parameters:
file
- the file containing port
-
-
Method Details
-
onApplicationEvent
- Specified by:
onApplicationEvent
in interfaceApplicationListener<WebServerInitializedEvent>
-
getPortFile
Return the actual port file that should be written for the given application context. The default implementation builds a file from the source file and the application context namespace if available.- Parameters:
applicationContext
- the source application context- Returns:
- the file that should be written
-