Class UiPluginService
java.lang.Object
com.tccc.kos.commons.util.ready.ReadyBean
com.tccc.kos.commons.core.service.AbstractService
com.tccc.kos.core.service.ui.plugin.UiPluginService
- All Implemented Interfaces:
CtxEventListener
,ContextHandleAware
,HandleAware
,Ready
,ReadyAndReadyListener
,ReadyListener
Centralized service that provides discoverability of browser based
ui plugins.
- Version:
- 2025-06-11
-
Method Summary
Modifier and TypeMethodDescriptionvoid
mount
(UiPluginContext ctx) Register aUiPluginContext
with the service.boolean
Override in subclasses to be notified when all dependencies are ready.void
unmount
(UiPluginContext ctx) Unregister aUiPluginContext
from the service.Methods inherited from class com.tccc.kos.commons.core.service.AbstractService
getHandle, getHandlePrefix
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.tccc.kos.commons.core.context.CtxEventListener
onCtxAutowiringCompleted, onCtxDestroyed, onCtxPhaseCompleted
Methods inherited from interface com.tccc.kos.commons.core.service.handle.HandleAware
addHandleChild, getName, getPath
Methods inherited from interface com.tccc.kos.commons.util.ready.ReadyAndReadyListener
onDependenciesReady
Methods inherited from interface com.tccc.kos.commons.util.ready.ReadyListener
onDependenciesGroupReady
-
Method Details
-
onBeanReady
public boolean onBeanReady()Description copied from interface:ReadyAndReadyListener
Override in subclasses to be notified when all dependencies are ready. Return true to indicate that this bean is also ready. If the bean needs to callsetReady()
later due to some async processing, return false to preventsetReady()
from being called automatically.It is recommended to override this method rather than
onDependenciesReady()
as a majority of the time it requires callingsuper.onDependneciesReady()
or explicitly callingsetReady()
which defaults to a failure mode.- Returns:
- true if this object is now ready
-
mount
Register aUiPluginContext
with the service. This will make the context available in the VFS and discoverable via associated endpoints. Contexts must be unmounted in order for them to be removed from the VFS and garbage collected.The context will be mounted to a directory with the name of the context. This means that every context must have a unique name.
- Parameters:
ctx
- the context to mount
-
unmount
Unregister aUiPluginContext
from the service. This will unmount the context and allow it to be garbage collected.- Parameters:
ctx
- the context to unmount
-