Package io.hawt.springboot

Class HawtioPlugin

java.lang.Object

io.hawt.springboot.HawtioPlugin

public class HawtioPlugin
extends Object

Hawtio v3 remote plugin for Spring Boot. Hawtio v3 plugin system is based on Webpack Module Federation. This interface is the Java representation of HawtioRemote interface in hawtio-next project, which is compatible with ImportRemoteOptions interface defined in @module-federation/utilities package.

Constructor Summary

Constructors

Constructor	Description
HawtioPlugin(String scope, String module)	Use a plugin that's located in the application itself.
HawtioPlugin(String scope, String module, String url)	Use a plugin from remote repository.

Method Summary

Modifier and Type	Method	Description
Boolean	getBustRemoteEntryCache()
String	getModule()
String	getPluginEntry()
String	getRemoteEntryFileName()
String	getScope()
String	getUrl()
void	setBustRemoteEntryCache(Boolean bustRemoteEntryCache)
void	setModule(String module)
void	setPluginEntry(String pluginEntry)
void	setRemoteEntryFileName(String remoteEntryFileName)
void	setScope(String scope)
void	setUrl(String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

HawtioPlugin

public HawtioPlugin(String scope,
                    String module,
                    String url)

Use a plugin from remote repository. These are the parameters required to load a remote Hawtio plugin (a.k.a. Module Federation remote module):

Parameters:

url - The URL of the remote entry for the plugin. This must be the same location as the Hawtio console.

scope - The name of the container defined at Webpack ModuleFederationPlugin. See also: sample-plugin/craco.config.js

module - The path exposed from Webpack ModuleFederationPlugin. See also: sample-plugin/craco.config.js

HawtioPlugin

public HawtioPlugin(String scope,
                    String module)

Use a plugin that's located in the application itself. This constructor automatically uses address of the application. These are the parameters required to load a remote Hawtio plugin (a.k.a. Module Federation remote module):

Parameters:

scope - The name of the container defined at Webpack ModuleFederationPlugin. See also: sample-plugin/craco.config.js

module - The path exposed from Webpack ModuleFederationPlugin. See also: sample-plugin/craco.config.js

Method Detail

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

getScope

public String getScope()

setScope

public void setScope(String scope)

getModule

public String getModule()

setModule

public void setModule(String module)

getRemoteEntryFileName

public String getRemoteEntryFileName()

setRemoteEntryFileName

public void setRemoteEntryFileName(String remoteEntryFileName)

getBustRemoteEntryCache

public Boolean getBustRemoteEntryCache()

setBustRemoteEntryCache

public void setBustRemoteEntryCache(Boolean bustRemoteEntryCache)

getPluginEntry

public String getPluginEntry()

setPluginEntry

public void setPluginEntry(String pluginEntry)