Module org.springframework.modulith.actuator

Package org.springframework.modulith.actuator

Class ApplicationModulesEndpoint

java.lang.Object

org.springframework.modulith.actuator.ApplicationModulesEndpoint

@Endpoint(id="modulith")
public class ApplicationModulesEndpoint
extends Object

A Spring Boot actuator endpoint to expose the application module structure of a Spring Modulith based application.

Author:

Oliver Drotbohm

Method Summary

Modifier and Type	Method	Description
(package private) String	getApplicationModules()	Returns the ApplicationModules metadata as Map (to be rendered as JSON).
static ApplicationModulesEndpoint	ofApplicationModules(Supplier<org.springframework.modulith.core.ApplicationModules> modules)	Creates a new ApplicationModulesEndpoint for the given lazily initialized ApplicationModules.
static ApplicationModulesEndpoint	precomputed(Supplier<String> precomputed)	Creates a new ApplicationModulesEndpoint from the pre-computed actuator content

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

precomputed

public static ApplicationModulesEndpoint precomputed(Supplier<String> precomputed)

Creates a new ApplicationModulesEndpoint from the pre-computed actuator content

Parameters:

precomputed - must not be null.

Returns:

will never be null.

Since:

1.0.3

ofApplicationModules

public static ApplicationModulesEndpoint ofApplicationModules(Supplier<org.springframework.modulith.core.ApplicationModules> modules)

Creates a new ApplicationModulesEndpoint for the given lazily initialized ApplicationModules.

Parameters:

modules - must not be null.

Returns:

will never be null.

Since:

1.0.3

getApplicationModules

@ReadOperation
String getApplicationModules()

Returns the ApplicationModules metadata as Map (to be rendered as JSON).

Returns:

will never be null.