Package io.quarkus.undertow.runtime

Class UndertowDeploymentRecorder

java.lang.Object
io.quarkus.undertow.runtime.UndertowDeploymentRecorder
public class UndertowDeploymentRecorder extends Object
Provides the runtime methods to bootstrap Undertow. This class is present in the final uber-jar, and is invoked from generated bytecode

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    UndertowDeploymentRecorder.ServletContextSupplier
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final int
    DEFAULT_BUFFER_SIZE
     
    protected static final boolean
    DEFAULT_DIRECT_BUFFERS
     
    static final io.undertow.server.HttpHandler
    ROOT_HANDLER
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    UndertowDeploymentRecorder(io.quarkus.vertx.http.runtime.VertxHttpBuildTimeConfig httpBuildTimeConfig, io.quarkus.runtime.RuntimeValue<io.quarkus.vertx.http.runtime.VertxHttpConfig> httpRuntimeConfig, io.quarkus.runtime.RuntimeValue<ServletRuntimeConfig> servletRuntimeConfig)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addContextParam(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, String paramName, String paramValue)
     
    void
    addErrorPage(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, String location, int errorCode)
     
    void
    addErrorPage(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, String location, Class<? extends Throwable> exceptionType)
     
    void
    addFilterInitParam(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.FilterInfo> info, String name, String value)
     
    void
    addFilterServletNameMapping(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> info, String name, String mapping, jakarta.servlet.DispatcherType dispatcherType)
     
    void
    addFilterURLMapping(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> info, String name, String mapping, jakarta.servlet.DispatcherType dispatcherType)
     
    static void
    addHotDeploymentWrapper(io.undertow.server.HandlerWrapper handlerWrapper)
     
    void
    addMimeMapping(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> info, String extension, String mimeType)
     
    void
    addSecurityConstraint(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, io.undertow.servlet.api.SecurityConstraint securityConstraint)
     
    void
    addSecurityConstraint(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, io.undertow.servlet.api.SecurityInfo.EmptyRoleSemantic emptyRoleSemantic, io.undertow.servlet.api.TransportGuaranteeType transportGuaranteeType, Set<String> rolesAllowed, Set<io.undertow.servlet.api.WebResourceCollection> webResourceCollections)
     
    void
    addSecurityRoleRef(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.ServletInfo> sref, String roleName, String roleLink)
     
    void
    addServletContainerInitializer(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, Class<? extends jakarta.servlet.ServletContainerInitializer> sciClass, Set<Class<?>> handlesTypes)
     
    void
    addServletContextAttribute(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, String key, Object value1)
     
    void
    addServletExtension(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, io.undertow.servlet.ServletExtension extension)
     
    void
    addServletInitParam(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.ServletInfo> info, String name, String value)
     
    void
    addServletInitParameter(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> info, String name, String value)
     
    void
    addServletMapping(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> info, String name, String mapping)
     
    io.undertow.servlet.api.DeploymentManager
    bootServletContainer(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> info, io.quarkus.arc.runtime.BeanContainer beanContainer, io.quarkus.runtime.LaunchMode launchMode, io.quarkus.runtime.ShutdownContext shutdownContext, boolean decorateStacktrace, String scrMainJava, List<String> knownClasses)
     
    io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo>
    createDeployment(String name, Set<String> knownFiles, Set<String> knownDirectories, io.quarkus.runtime.LaunchMode launchMode, io.quarkus.runtime.ShutdownContext context, String mountPoint, String defaultCharset, String requestCharacterEncoding, String responseCharacterEncoding, boolean proactiveAuth, List<String> welcomeFiles, boolean hasSecurityCapability)
     
    static SocketAddress
    getHttpAddress()
     
    io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.FilterInfo>
    registerFilter(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> info, String name, Class<?> filterClass, boolean asyncSupported, io.quarkus.arc.runtime.BeanContainer beanContainer, io.undertow.servlet.api.InstanceFactory<? extends jakarta.servlet.Filter> instanceFactory)
     
    void
    registerListener(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> info, Class<?> listenerClass, io.quarkus.arc.runtime.BeanContainer factory)
     
    io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.ServletInfo>
    registerServlet(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deploymentInfo, String name, Class<?> servletClass, boolean asyncSupported, int loadOnStartup, io.quarkus.arc.runtime.BeanContainer beanContainer, io.undertow.servlet.api.InstanceFactory<? extends jakarta.servlet.Servlet> instanceFactory)
     
    Supplier<jakarta.servlet.ServletContext>
    servletContextSupplier()
     
    io.undertow.servlet.api.ServletSessionConfig
    sessionConfig(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment)
     
    void
    setDenyUncoveredHttpMethods(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, boolean denyUncoveredHttpMethods)
     
    static void
    setHotDeploymentResources(List<Path> resources)
     
    void
    setMultipartConfig(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.ServletInfo> sref, String location, long fileSize, long maxRequestSize, int fileSizeThreshold)
     
    void
    setSecurityInfo(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.ServletInfo> sref, io.undertow.servlet.api.ServletSecurityInfo securityInfo)
     
    void
    setSessionCookieConfig(io.undertow.servlet.api.ServletSessionConfig config, String name, String path, String comment, String domain, Boolean httpOnly, Integer maxAge, Boolean secure)
     
    void
    setSessionTimeout(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, int sessionTimeout)
     
    void
    setSessionTracking(io.undertow.servlet.api.ServletSessionConfig config, Set<jakarta.servlet.SessionTrackingMode> modes)
     
    void
    setupRequestScope(io.undertow.servlet.api.DeploymentInfo deploymentInfo, io.quarkus.arc.runtime.BeanContainer beanContainer)
     
    void
    setupSecurity(io.undertow.servlet.api.DeploymentManager manager)
     
    io.vertx.core.Handler<io.vertx.ext.web.RoutingContext>
    startUndertow(io.quarkus.runtime.ShutdownContext shutdown, ExecutorService executorService, io.undertow.servlet.api.DeploymentManager manager, List<io.undertow.server.HandlerWrapper> wrappers)
     

    Methods inherited from class java.lang.Object

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

  • Field Details

    • ROOT_HANDLER

      public static final io.undertow.server.HttpHandler ROOT_HANDLER

    • DEFAULT_BUFFER_SIZE

      protected static final int DEFAULT_BUFFER_SIZE

    • DEFAULT_DIRECT_BUFFERS

      protected static final boolean DEFAULT_DIRECT_BUFFERS

  • Constructor Details

    • UndertowDeploymentRecorder

      public UndertowDeploymentRecorder(io.quarkus.vertx.http.runtime.VertxHttpBuildTimeConfig httpBuildTimeConfig, io.quarkus.runtime.RuntimeValue<io.quarkus.vertx.http.runtime.VertxHttpConfig> httpRuntimeConfig, io.quarkus.runtime.RuntimeValue<ServletRuntimeConfig> servletRuntimeConfig)

  • Method Details

    • setHotDeploymentResources

      public static void setHotDeploymentResources(List<Path> resources)

    • createDeployment

      public io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> createDeployment(String name, Set<String> knownFiles, Set<String> knownDirectories, io.quarkus.runtime.LaunchMode launchMode, io.quarkus.runtime.ShutdownContext context, String mountPoint, String defaultCharset, String requestCharacterEncoding, String responseCharacterEncoding, boolean proactiveAuth, List<String> welcomeFiles, boolean hasSecurityCapability)

    • getHttpAddress

      public static SocketAddress getHttpAddress()

    • registerServlet

      public io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.ServletInfo> registerServlet(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deploymentInfo, String name, Class<?> servletClass, boolean asyncSupported, int loadOnStartup, io.quarkus.arc.runtime.BeanContainer beanContainer, io.undertow.servlet.api.InstanceFactory<? extends jakarta.servlet.Servlet> instanceFactory) throws Exception
      Throws:
      Exception

    • addServletInitParam

      public void addServletInitParam(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.ServletInfo> info, String name, String value)

    • addServletMapping

      public void addServletMapping(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> info, String name, String mapping) throws Exception
      Throws:
      Exception

    • setMultipartConfig

      public void setMultipartConfig(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.ServletInfo> sref, String location, long fileSize, long maxRequestSize, int fileSizeThreshold)

    • setSecurityInfo

      public void setSecurityInfo(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.ServletInfo> sref, io.undertow.servlet.api.ServletSecurityInfo securityInfo)
      Parameters:
      sref -
      securityInfo -

    • addSecurityRoleRef

      public void addSecurityRoleRef(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.ServletInfo> sref, String roleName, String roleLink)
      Parameters:
      sref -
      roleName -
      roleLink -

    • registerFilter

      public io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.FilterInfo> registerFilter(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> info, String name, Class<?> filterClass, boolean asyncSupported, io.quarkus.arc.runtime.BeanContainer beanContainer, io.undertow.servlet.api.InstanceFactory<? extends jakarta.servlet.Filter> instanceFactory) throws Exception
      Throws:
      Exception

    • addFilterInitParam

      public void addFilterInitParam(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.FilterInfo> info, String name, String value)

    • addFilterURLMapping

      public void addFilterURLMapping(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> info, String name, String mapping, jakarta.servlet.DispatcherType dispatcherType) throws Exception
      Throws:
      Exception

    • addFilterServletNameMapping

      public void addFilterServletNameMapping(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> info, String name, String mapping, jakarta.servlet.DispatcherType dispatcherType) throws Exception
      Throws:
      Exception

    • registerListener

      public void registerListener(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> info, Class<?> listenerClass, io.quarkus.arc.runtime.BeanContainer factory)

    • addMimeMapping

      public void addMimeMapping(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> info, String extension, String mimeType) throws Exception
      Throws:
      Exception

    • addServletInitParameter

      public void addServletInitParameter(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> info, String name, String value)

    • setupSecurity

      public void setupSecurity(io.undertow.servlet.api.DeploymentManager manager)

    • startUndertow

      public io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> startUndertow(io.quarkus.runtime.ShutdownContext shutdown, ExecutorService executorService, io.undertow.servlet.api.DeploymentManager manager, List<io.undertow.server.HandlerWrapper> wrappers) throws Exception
      Throws:
      Exception

    • addHotDeploymentWrapper

      public static void addHotDeploymentWrapper(io.undertow.server.HandlerWrapper handlerWrapper)

    • servletContextSupplier

      public Supplier<jakarta.servlet.ServletContext> servletContextSupplier()

    • bootServletContainer

      public io.undertow.servlet.api.DeploymentManager bootServletContainer(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> info, io.quarkus.arc.runtime.BeanContainer beanContainer, io.quarkus.runtime.LaunchMode launchMode, io.quarkus.runtime.ShutdownContext shutdownContext, boolean decorateStacktrace, String scrMainJava, List<String> knownClasses)

    • addServletContextAttribute

      public void addServletContextAttribute(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, String key, Object value1)

    • addServletExtension

      public void addServletExtension(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, io.undertow.servlet.ServletExtension extension)

    • setupRequestScope

      public void setupRequestScope(io.undertow.servlet.api.DeploymentInfo deploymentInfo, io.quarkus.arc.runtime.BeanContainer beanContainer)

    • addServletContainerInitializer

      public void addServletContainerInitializer(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, Class<? extends jakarta.servlet.ServletContainerInitializer> sciClass, Set<Class<?>> handlesTypes)

    • addContextParam

      public void addContextParam(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, String paramName, String paramValue)

    • setDenyUncoveredHttpMethods

      public void setDenyUncoveredHttpMethods(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, boolean denyUncoveredHttpMethods)

    • addSecurityConstraint

      public void addSecurityConstraint(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, io.undertow.servlet.api.SecurityConstraint securityConstraint)

    • addSecurityConstraint

      public void addSecurityConstraint(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, io.undertow.servlet.api.SecurityInfo.EmptyRoleSemantic emptyRoleSemantic, io.undertow.servlet.api.TransportGuaranteeType transportGuaranteeType, Set<String> rolesAllowed, Set<io.undertow.servlet.api.WebResourceCollection> webResourceCollections)

    • setSessionTimeout

      public void setSessionTimeout(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, int sessionTimeout)

    • sessionConfig

      public io.undertow.servlet.api.ServletSessionConfig sessionConfig(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment)

    • setSessionTracking

      public void setSessionTracking(io.undertow.servlet.api.ServletSessionConfig config, Set<jakarta.servlet.SessionTrackingMode> modes)

    • setSessionCookieConfig

      public void setSessionCookieConfig(io.undertow.servlet.api.ServletSessionConfig config, String name, String path, String comment, String domain, Boolean httpOnly, Integer maxAge, Boolean secure)

    • addErrorPage

      public void addErrorPage(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, String location, int errorCode)

    • addErrorPage

      public void addErrorPage(io.quarkus.runtime.RuntimeValue<io.undertow.servlet.api.DeploymentInfo> deployment, String location, Class<? extends Throwable> exceptionType)