Class UiPluginService

All Implemented Interfaces:
CtxEventListener, ContextHandleAware, HandleAware, Ready, ReadyAndReadyListener, ReadyListener

public final class UiPluginService extends AbstractService
Centralized service that provides discoverability of browser based ui plugins.
Version:
2025-06-11
  • 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 call setReady() later due to some async processing, return false to prevent setReady() from being called automatically.

      It is recommended to override this method rather than onDependenciesReady() as a majority of the time it requires calling super.onDependneciesReady() or explicitly calling setReady() which defaults to a failure mode.

      Returns:
      true if this object is now ready
    • mount

      public void mount(UiPluginContext ctx)
      Register a UiPluginContext 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

      public void unmount(UiPluginContext ctx)
      Unregister a UiPluginContext from the service. This will unmount the context and allow it to be garbage collected.
      Parameters:
      ctx - the context to unmount