WebServerPortFileWriter (spring-boot 2.2.1.RELEASE)

java.lang.Object
- org.springframework.boot.web.context.WebServerPortFileWriter

All Implemented Interfaces:

EventListener, org.springframework.context.ApplicationListener<WebServerInitializedEvent>
```
public class WebServerPortFileWriter
extends Object
implements org.springframework.context.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

Constructors
Constructor and Description
`WebServerPortFileWriter()` Create a new `WebServerPortFileWriter` instance using the filename 'application.port'.
`WebServerPortFileWriter(File file)` Create a new `WebServerPortFileWriter` instance with a specified file.
`WebServerPortFileWriter(String filename)` Create a new `WebServerPortFileWriter` instance with a specified filename.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected File`	`getPortFile(org.springframework.context.ApplicationContext applicationContext)` Return the actual port file that should be written for the given application context.
`void`	`onApplicationEvent(WebServerInitializedEvent event)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WebServerPortFileWriter
```
public WebServerPortFileWriter()
```
    Create a new WebServerPortFileWriter instance using the filename 'application.port'.
  - WebServerPortFileWriter
```
public WebServerPortFileWriter(String filename)
```
    Create a new WebServerPortFileWriter instance with a specified filename.
    
    Parameters:
    
    filename - the name of file containing port
  - WebServerPortFileWriter
```
public WebServerPortFileWriter(File file)
```
    Create a new WebServerPortFileWriter instance with a specified file.
    
    Parameters:
    
    file - the file containing port
- Method Detail
  - onApplicationEvent
```
public void onApplicationEvent(WebServerInitializedEvent event)
```
    Specified by:
    
    onApplicationEvent in interface org.springframework.context.ApplicationListener<WebServerInitializedEvent>
  - getPortFile
```
protected File getPortFile(org.springframework.context.ApplicationContext applicationContext)
```
    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

Copyright © 2019 Pivotal Software, Inc.. All rights reserved.