org.springframework.boot.admin

Interface SpringApplicationAdminMXBean

public interface SpringApplicationAdminMXBean

An MBean contract to control and monitor a running SpringApplication via JMX. Intended for internal use only.

Since:

1.3.0

Author:

Stephane Nicoll

Method Summary

Modifier and Type	Method and Description
String	getProperty(String key) Return the value of the specified key from the application Environment.
boolean	isEmbeddedWebApplication() Specify if the application runs in an embedded web container.
boolean	isReady() Specify if the application has fully started and is now ready.
void	shutdown() Shutdown the application.

Method Detail

isReady

boolean isReady()

Specify if the application has fully started and is now ready.

Returns:

true if the application is ready

See Also:

ApplicationReadyEvent

isEmbeddedWebApplication

boolean isEmbeddedWebApplication()

Specify if the application runs in an embedded web container. Return false on a web application that hasn't fully started yet, so it is preferable to wait for the application to be ready.

Returns:

true if the application runs in an embedded web container

See Also:

isReady()

getProperty

String getProperty(String key)

Return the value of the specified key from the application Environment.

Parameters:

key - the property key

Returns:

the property value or null if it does not exist

shutdown

void shutdown()

Shutdown the application.

See Also:

ConfigurableApplicationContext.close()