3.6.2 Refreshable Scope

The Refreshable scope is a custom scope that allows a bean’s state to be refreshed via:

• /refresh endpoint.

• Publication of a RefreshEvent.

The following example, illustrates the @Refreshable scope behavior.

@Refreshable (1)
public static class WeatherService {
    private String forecast;
    @PostConstruct
    public void init() {
        forecast = "Scattered Clouds " + new SimpleDateFormat("dd/MMM/yy HH:mm:ss.SSS").format(new Date());(2)
    }
    public String latestForecast() {
        return forecast;
    }
}

@Refreshable (1)
static class WeatherService {
    String forecast
    @PostConstruct
    void init() {
        forecast = "Scattered Clouds ${new SimpleDateFormat("dd/MMM/yy HH:mm:ss.SSS").format(new Date())}" (2)
    }
    String latestForecast() {
        return forecast
    }
}

@Refreshable (1)
open class WeatherService {
    private var forecast: String? = null
    @PostConstruct
    fun init() {
        forecast = "Scattered Clouds " + SimpleDateFormat("dd/MMM/yy HH:mm:ss.SSS").format(Date())(2)
    }
    open fun latestForecast(): String? {
        return forecast
    }
}

If you invoke the latestForecast() twice, you will see identical responses such as "Scattered Clouds 01/Feb/18 10:29.199".

When the /refresh endpoint is invoked or a RefreshEvent is published then the instance is invalidated and a new instance is created the next time the object is requested. For example:

applicationContext.publishEvent(new RefreshEvent());

applicationContext.publishEvent(new RefreshEvent())

applicationContext.publishEvent(RefreshEvent())