io.quarkus.undertow.deployment

Class UndertowBuildStep

java.lang.Object

io.quarkus.undertow.deployment.UndertowBuildStep

public class UndertowBuildStep
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
(package private) CombinedIndexBuildItem	combinedIndexBuildItem
static org.jboss.jandex.DotName	DECLARE_ROLES
protected static org.jboss.jandex.DotName	HANDLES_TYPES
static org.jboss.jandex.DotName	MULTIPART_CONFIG
static org.jboss.jandex.DotName	RUN_AS
protected static String	SERVLET_CONTAINER_INITIALIZER
static org.jboss.jandex.DotName	SERVLET_SECURITY
static org.jboss.jandex.DotName	WEB_FILTER
static org.jboss.jandex.DotName	WEB_LISTENER
static org.jboss.jandex.DotName	WEB_SERVLET

Constructor Summary

Constructors

Constructor and Description
UndertowBuildStep()

Method Summary

Modifier and Type	Method and Description
ServiceStartBuildItem	boot(UndertowDeploymentRecorder recorder, ServletDeploymentManagerBuildItem servletDeploymentManagerBuildItem, List<HttpHandlerWrapperBuildItem> wrappers, ShutdownContextBuildItem shutdown, Consumer<DefaultRouteBuildItem> undertowProducer, BuildProducer<RouteBuildItem> routeProducer, ExecutorBuildItem executorBuildItem, io.quarkus.vertx.http.runtime.HttpConfiguration httpConfiguration, ServletRuntimeConfig servletRuntimeConfig, ServletContextPathBuildItem servletContextPathBuildItem, Capabilities capabilities)
ServletDeploymentManagerBuildItem	build(List<ServletBuildItem> servlets, List<FilterBuildItem> filters, List<ListenerBuildItem> listeners, List<ServletInitParamBuildItem> initParams, List<ServletContextAttributeBuildItem> contextParams, List<ServletContainerInitializerBuildItem> servletContainerInitializerBuildItems, UndertowDeploymentRecorder recorder, RecorderContext context, List<ServletExtensionBuildItem> extensions, BeanContainerBuildItem bc, ServletContextPathBuildItem servletContextPathBuildItem, WebMetadataBuildItem webMetadataBuildItem, BuildProducer<ObjectSubstitutionBuildItem> substitutions, Consumer<ReflectiveClassBuildItem> reflectiveClasses, LaunchModeBuildItem launchMode, ShutdownContextBuildItem shutdownContext, KnownPathsBuildItem knownPaths, io.quarkus.vertx.http.runtime.HttpBuildTimeConfig httpBuildTimeConfig, ServletConfig servletConfig)
(package private) CapabilityBuildItem	capability()
ServletContextPathBuildItem	contextPath(ServletConfig servletConfig, WebMetadataBuildItem webMetadataBuildItem)
(package private) CustomScopeBuildItem	customScope()
protected org.jboss.annotation.javaee.Descriptions	getDescription(String description)
protected org.jboss.metadata.javaee.spec.DescriptionGroupMetaData	getDescriptionGroup(String description)
protected org.jboss.metadata.javaee.spec.DescriptionGroupMetaData	getDescriptionGroup(String description, String displayName, String smallIcon, String largeIcon)
protected org.jboss.annotation.javaee.DisplayNames	getDisplayName(String displayName)
protected org.jboss.annotation.javaee.Icons	getIcons(String smallIcon, String largeIcon)
(package private) void	integrateCdi(BuildProducer<AdditionalBeanBuildItem> additionalBeans, BuildProducer<ListenerBuildItem> listeners, Capabilities capabilities)
(package private) ContextRegistrationPhaseBuildItem.ContextConfiguratorBuildItem	registerContext(ContextRegistrationPhaseBuildItem phase)
void	registerUndertowHandlersConf(BuildProducer<ServletExtensionBuildItem> producer, ApplicationArchivesBuildItem applicationArchivesBuildItem, BuildProducer<HotDeploymentWatchedFileBuildItem> watchedFile, BuildProducer<NativeImageResourceBuildItem> nativeImageResourceBuildItemBuildProducer) Register the undertow-handlers.conf file
List<ServletContainerInitializerBuildItem>	servletContainerInitializer(ApplicationArchivesBuildItem archives, CombinedIndexBuildItem combinedIndexBuildItem, List<BlacklistedServletContainerInitializerBuildItem> blacklistedBuildItems, BuildProducer<AdditionalBeanBuildItem> beans)
(package private) SyntheticBeanBuildItem	servletContextBean(UndertowDeploymentRecorder recorder)
FeatureBuildItem	setupCapability()

Methods inherited from class java.lang.Object

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

Field Detail

WEB_FILTER

public static final org.jboss.jandex.DotName WEB_FILTER

WEB_LISTENER

public static final org.jboss.jandex.DotName WEB_LISTENER

WEB_SERVLET

public static final org.jboss.jandex.DotName WEB_SERVLET

RUN_AS

public static final org.jboss.jandex.DotName RUN_AS

DECLARE_ROLES

public static final org.jboss.jandex.DotName DECLARE_ROLES

MULTIPART_CONFIG

public static final org.jboss.jandex.DotName MULTIPART_CONFIG

SERVLET_SECURITY

public static final org.jboss.jandex.DotName SERVLET_SECURITY

SERVLET_CONTAINER_INITIALIZER

protected static final String SERVLET_CONTAINER_INITIALIZER

See Also:

Constant Field Values

HANDLES_TYPES

protected static final org.jboss.jandex.DotName HANDLES_TYPES

combinedIndexBuildItem

@Inject
CombinedIndexBuildItem combinedIndexBuildItem

Constructor Detail

UndertowBuildStep

public UndertowBuildStep()

Method Detail

capability

CapabilityBuildItem capability()

setupCapability

public FeatureBuildItem setupCapability()

boot

public ServiceStartBuildItem boot(UndertowDeploymentRecorder recorder,
                                  ServletDeploymentManagerBuildItem servletDeploymentManagerBuildItem,
                                  List<HttpHandlerWrapperBuildItem> wrappers,
                                  ShutdownContextBuildItem shutdown,
                                  Consumer<DefaultRouteBuildItem> undertowProducer,
                                  BuildProducer<RouteBuildItem> routeProducer,
                                  ExecutorBuildItem executorBuildItem,
                                  io.quarkus.vertx.http.runtime.HttpConfiguration httpConfiguration,
                                  ServletRuntimeConfig servletRuntimeConfig,
                                  ServletContextPathBuildItem servletContextPathBuildItem,
                                  Capabilities capabilities)
                           throws Exception

Throws:

Exception

integrateCdi

void integrateCdi(BuildProducer<AdditionalBeanBuildItem> additionalBeans,
                  BuildProducer<ListenerBuildItem> listeners,
                  Capabilities capabilities)

registerContext

ContextRegistrationPhaseBuildItem.ContextConfiguratorBuildItem registerContext(ContextRegistrationPhaseBuildItem phase)

customScope

CustomScopeBuildItem customScope()

registerUndertowHandlersConf

public void registerUndertowHandlersConf(BuildProducer<ServletExtensionBuildItem> producer,
                                         ApplicationArchivesBuildItem applicationArchivesBuildItem,
                                         BuildProducer<HotDeploymentWatchedFileBuildItem> watchedFile,
                                         BuildProducer<NativeImageResourceBuildItem> nativeImageResourceBuildItemBuildProducer)

Register the undertow-handlers.conf file

servletContainerInitializer

public List<ServletContainerInitializerBuildItem> servletContainerInitializer(ApplicationArchivesBuildItem archives,
                                                                              CombinedIndexBuildItem combinedIndexBuildItem,
                                                                              List<BlacklistedServletContainerInitializerBuildItem> blacklistedBuildItems,
                                                                              BuildProducer<AdditionalBeanBuildItem> beans)
                                                                       throws IOException

Throws:

IOException

contextPath

public ServletContextPathBuildItem contextPath(ServletConfig servletConfig,
                                               WebMetadataBuildItem webMetadataBuildItem)

build

public ServletDeploymentManagerBuildItem build(List<ServletBuildItem> servlets,
                                               List<FilterBuildItem> filters,
                                               List<ListenerBuildItem> listeners,
                                               List<ServletInitParamBuildItem> initParams,
                                               List<ServletContextAttributeBuildItem> contextParams,
                                               List<ServletContainerInitializerBuildItem> servletContainerInitializerBuildItems,
                                               UndertowDeploymentRecorder recorder,
                                               RecorderContext context,
                                               List<ServletExtensionBuildItem> extensions,
                                               BeanContainerBuildItem bc,
                                               ServletContextPathBuildItem servletContextPathBuildItem,
                                               WebMetadataBuildItem webMetadataBuildItem,
                                               BuildProducer<ObjectSubstitutionBuildItem> substitutions,
                                               Consumer<ReflectiveClassBuildItem> reflectiveClasses,
                                               LaunchModeBuildItem launchMode,
                                               ShutdownContextBuildItem shutdownContext,
                                               KnownPathsBuildItem knownPaths,
                                               io.quarkus.vertx.http.runtime.HttpBuildTimeConfig httpBuildTimeConfig,
                                               ServletConfig servletConfig)
                                        throws Exception

Throws:

Exception

servletContextBean

SyntheticBeanBuildItem servletContextBean(UndertowDeploymentRecorder recorder)

getDescription

protected org.jboss.annotation.javaee.Descriptions getDescription(String description)

getDisplayName

protected org.jboss.annotation.javaee.DisplayNames getDisplayName(String displayName)

getIcons

protected org.jboss.annotation.javaee.Icons getIcons(String smallIcon,
                                                     String largeIcon)

getDescriptionGroup

protected org.jboss.metadata.javaee.spec.DescriptionGroupMetaData getDescriptionGroup(String description)

getDescriptionGroup

protected org.jboss.metadata.javaee.spec.DescriptionGroupMetaData getDescriptionGroup(String description,
                                                                                      String displayName,
                                                                                      String smallIcon,
                                                                                      String largeIcon)