Package io.quarkus.devui.deployment

Class DevUIProcessor

java.lang.Object
io.quarkus.devui.deployment.DevUIProcessor
public class DevUIProcessor extends Object
Create the HTTP related Dev UI API Points. This includes the JsonRPC Websocket endpoint and the endpoints that deliver the generated and static content. This also find all jsonrpc methods and make them available in the jsonRPC Router

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    (package private) static final record 
    DevUIProcessor.LanguageCountry
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    DevUIProcessor()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    (package private) void
    additionalBean(io.quarkus.deployment.annotations.BuildProducer<io.quarkus.arc.deployment.AdditionalBeanBuildItem> additionalBeanProducer, io.quarkus.deployment.annotations.BuildProducer<io.quarkus.deployment.builditem.AdditionalIndexedClassesBuildItem> additionalIndexProducer, List<io.quarkus.devui.spi.JsonRPCProvidersBuildItem> jsonRPCProvidersBuildItems)
    This makes sure the Runtime JsonRPC Classes for both the internal Dev UI and extensions is available as a bean and on the index.
    (package private) void
    createAllRoutes(io.quarkus.vertx.http.deployment.webjar.WebJarResultsBuildItem webJarResultsBuildItem, io.quarkus.deployment.builditem.LaunchModeBuildItem launchModeBuildItem, List<DevUIWebJarBuildItem> devUIWebJarBuiltItems, io.quarkus.deployment.annotations.BuildProducer<DevUIRoutesBuildItem> devUIRoutesProducer)
     
    (package private) io.quarkus.devui.spi.JsonRPCProvidersBuildItem
    createAssistantJsonRPCService()
     
    (package private) void
    createJsonRpcRouter(io.quarkus.devui.runtime.DevUIRecorder recorder, io.quarkus.arc.deployment.BeanContainerBuildItem beanContainer, JsonRPCRuntimeMethodsBuildItem jsonRPCMethodsBuildItem, DeploymentMethodBuildItem deploymentMethodBuildItem)
     
    (package private) void
    findAllJsonRPCMethods(io.quarkus.deployment.annotations.BuildProducer<JsonRPCRuntimeMethodsBuildItem> jsonRPCMethodsProvider, io.quarkus.deployment.annotations.BuildProducer<BuildTimeConstBuildItem> buildTimeConstProducer, io.quarkus.deployment.builditem.LaunchModeBuildItem launchModeBuildItem, io.quarkus.deployment.builditem.CombinedIndexBuildItem combinedIndexBuildItem, io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem curateOutcomeBuildItem, List<io.quarkus.devui.spi.JsonRPCProvidersBuildItem> jsonRPCProvidersBuildItems, DeploymentMethodBuildItem deploymentMethodBuildItem)
    This goes through all jsonRPC methods and discover the methods using Jandex
    (package private) BuildTimeConstBuildItem
    findAllSupportedLocales()
    This creates a set of supported locales
    (package private) void
    getAllExtensions(List<io.quarkus.devui.spi.page.CardPageBuildItem> cardPageBuildItems, List<io.quarkus.devui.spi.page.MenuPageBuildItem> menuPageBuildItems, List<io.quarkus.devui.spi.page.FooterPageBuildItem> footerPageBuildItems, List<io.quarkus.devui.spi.page.SettingPageBuildItem> settingPageBuildItems, List<io.quarkus.devui.spi.page.UnlistedPageBuildItem> unlistedPageBuildItems, io.quarkus.deployment.builditem.LaunchModeBuildItem launchModeBuildItem, io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem curateOutcomeBuildItem, io.quarkus.deployment.annotations.BuildProducer<ExtensionsBuildItem> extensionsProducer, io.quarkus.deployment.annotations.BuildProducer<io.quarkus.vertx.http.deployment.webjar.WebJarBuildItem> webJarBuildProducer, io.quarkus.deployment.annotations.BuildProducer<DevUIWebJarBuildItem> devUIWebJarProducer, io.quarkus.deployment.Capabilities capabilities)
    This build all the pages for dev ui, based on the extension included
    (package private) void
    processFooterLogs(io.quarkus.deployment.annotations.BuildProducer<io.quarkus.devui.spi.buildtime.BuildTimeActionBuildItem> buildTimeActionProducer, io.quarkus.deployment.annotations.BuildProducer<io.quarkus.devui.spi.page.FooterPageBuildItem> footerPageProducer, List<io.quarkus.devui.spi.buildtime.FooterLogBuildItem> footerLogBuildItems)
     
    (package private) void
    registerDevUiHandlers(DevUIConfig devUIConfig, io.quarkus.arc.deployment.BeanContainerBuildItem beanContainer, MvnpmBuildItem mvnpmBuildItem, List<DevUIRoutesBuildItem> devUIRoutesBuildItems, List<io.quarkus.devui.spi.buildtime.StaticContentBuildItem> staticContentBuildItems, io.quarkus.deployment.annotations.BuildProducer<io.quarkus.vertx.http.deployment.RouteBuildItem> routeProducer, io.quarkus.devui.runtime.DevUIRecorder recorder, io.quarkus.deployment.builditem.LaunchModeBuildItem launchModeBuildItem, io.quarkus.vertx.http.deployment.NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem, io.quarkus.vertx.http.deployment.HttpRootPathBuildItem httpRootPathBuildItem, io.quarkus.deployment.builditem.ShutdownContextBuildItem shutdownContext)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DevUIProcessor

      public DevUIProcessor()

  • Method Details

    • registerDevUiHandlers

      void registerDevUiHandlers(DevUIConfig devUIConfig, io.quarkus.arc.deployment.BeanContainerBuildItem beanContainer, MvnpmBuildItem mvnpmBuildItem, List<DevUIRoutesBuildItem> devUIRoutesBuildItems, List<io.quarkus.devui.spi.buildtime.StaticContentBuildItem> staticContentBuildItems, io.quarkus.deployment.annotations.BuildProducer<io.quarkus.vertx.http.deployment.RouteBuildItem> routeProducer, io.quarkus.devui.runtime.DevUIRecorder recorder, io.quarkus.deployment.builditem.LaunchModeBuildItem launchModeBuildItem, io.quarkus.vertx.http.deployment.NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem, io.quarkus.vertx.http.deployment.HttpRootPathBuildItem httpRootPathBuildItem, io.quarkus.deployment.builditem.ShutdownContextBuildItem shutdownContext) throws IOException
      Throws:
      IOException

    • additionalBean

      void additionalBean(io.quarkus.deployment.annotations.BuildProducer<io.quarkus.arc.deployment.AdditionalBeanBuildItem> additionalBeanProducer, io.quarkus.deployment.annotations.BuildProducer<io.quarkus.deployment.builditem.AdditionalIndexedClassesBuildItem> additionalIndexProducer, List<io.quarkus.devui.spi.JsonRPCProvidersBuildItem> jsonRPCProvidersBuildItems)
      This makes sure the Runtime JsonRPC Classes for both the internal Dev UI and extensions is available as a bean and on the index.

    • findAllSupportedLocales

      BuildTimeConstBuildItem findAllSupportedLocales()
      This creates a set of supported locales

    • createAssistantJsonRPCService

      io.quarkus.devui.spi.JsonRPCProvidersBuildItem createAssistantJsonRPCService()

    • findAllJsonRPCMethods

      void findAllJsonRPCMethods(io.quarkus.deployment.annotations.BuildProducer<JsonRPCRuntimeMethodsBuildItem> jsonRPCMethodsProvider, io.quarkus.deployment.annotations.BuildProducer<BuildTimeConstBuildItem> buildTimeConstProducer, io.quarkus.deployment.builditem.LaunchModeBuildItem launchModeBuildItem, io.quarkus.deployment.builditem.CombinedIndexBuildItem combinedIndexBuildItem, io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem curateOutcomeBuildItem, List<io.quarkus.devui.spi.JsonRPCProvidersBuildItem> jsonRPCProvidersBuildItems, DeploymentMethodBuildItem deploymentMethodBuildItem)
      This goes through all jsonRPC methods and discover the methods using Jandex

    • createJsonRpcRouter

      void createJsonRpcRouter(io.quarkus.devui.runtime.DevUIRecorder recorder, io.quarkus.arc.deployment.BeanContainerBuildItem beanContainer, JsonRPCRuntimeMethodsBuildItem jsonRPCMethodsBuildItem, DeploymentMethodBuildItem deploymentMethodBuildItem)

    • processFooterLogs

      void processFooterLogs(io.quarkus.deployment.annotations.BuildProducer<io.quarkus.devui.spi.buildtime.BuildTimeActionBuildItem> buildTimeActionProducer, io.quarkus.deployment.annotations.BuildProducer<io.quarkus.devui.spi.page.FooterPageBuildItem> footerPageProducer, List<io.quarkus.devui.spi.buildtime.FooterLogBuildItem> footerLogBuildItems)

    • getAllExtensions

      void getAllExtensions(List<io.quarkus.devui.spi.page.CardPageBuildItem> cardPageBuildItems, List<io.quarkus.devui.spi.page.MenuPageBuildItem> menuPageBuildItems, List<io.quarkus.devui.spi.page.FooterPageBuildItem> footerPageBuildItems, List<io.quarkus.devui.spi.page.SettingPageBuildItem> settingPageBuildItems, List<io.quarkus.devui.spi.page.UnlistedPageBuildItem> unlistedPageBuildItems, io.quarkus.deployment.builditem.LaunchModeBuildItem launchModeBuildItem, io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem curateOutcomeBuildItem, io.quarkus.deployment.annotations.BuildProducer<ExtensionsBuildItem> extensionsProducer, io.quarkus.deployment.annotations.BuildProducer<io.quarkus.vertx.http.deployment.webjar.WebJarBuildItem> webJarBuildProducer, io.quarkus.deployment.annotations.BuildProducer<DevUIWebJarBuildItem> devUIWebJarProducer, io.quarkus.deployment.Capabilities capabilities)
      This build all the pages for dev ui, based on the extension included

    • createAllRoutes

      void createAllRoutes(io.quarkus.vertx.http.deployment.webjar.WebJarResultsBuildItem webJarResultsBuildItem, io.quarkus.deployment.builditem.LaunchModeBuildItem launchModeBuildItem, List<DevUIWebJarBuildItem> devUIWebJarBuiltItems, io.quarkus.deployment.annotations.BuildProducer<DevUIRoutesBuildItem> devUIRoutesProducer)