Package org.apache.camel.quarkus.servlet.runtime

Class CamelServletConfig.ServletConfig

java.lang.Object

org.apache.camel.quarkus.servlet.runtime.CamelServletConfig.ServletConfig

Enclosing class:

CamelServletConfig

public static class CamelServletConfig.ServletConfig
extends Object

camel-servlet component configuration

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_SERVLET_CLASS
static String	DEFAULT_SERVLET_NAME
String	servletClass	A fully qualified name of a servlet class to serve paths that match urlPatterns
String	servletName	A servletName as it would be defined in a `web.xml` file or in the WebServlet.name() annotation.
Optional<List<String>>	urlPatterns	A comma separated list of path patterns under which the CamelServlet should be accessible.

Constructor Summary

Constructors

Constructor	Description
ServletConfig()

Method Summary

Modifier and Type	Method	Description
String	getEffectiveServletName(String key)	Setting the servlet name is possible both via servletName and the key in the org.apache.camel.quarkus.servlet.runtime.CamelServletConfig.ServletsConfig#namedServlets map.
boolean	isValid()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SERVLET_NAME

public static final String DEFAULT_SERVLET_NAME

See Also:

Constant Field Values

DEFAULT_SERVLET_CLASS

public static final String DEFAULT_SERVLET_CLASS

See Also:

Constant Field Values

urlPatterns

@ConfigItem
public Optional<List<String>> urlPatterns

A comma separated list of path patterns under which the CamelServlet should be accessible. Example path patterns: /*, /services/*

servletClass

@ConfigItem(defaultValue="org.apache.camel.component.servlet.CamelHttpTransportServlet")
public String servletClass

A fully qualified name of a servlet class to serve paths that match urlPatterns

servletName

@ConfigItem(defaultValue="CamelServlet")
public String servletName

A servletName as it would be defined in a `web.xml` file or in the WebServlet.name() annotation.

Constructor Detail

ServletConfig

public ServletConfig()

Method Detail

isValid

public boolean isValid()

Returns:

true if this CamelServletConfig.ServletConfig is valid as a whole. This currently translates to urlPatterns being non-empty because servletClass and servletName have default values. Otherwise returns false.

getEffectiveServletName

public String getEffectiveServletName(String key)

Setting the servlet name is possible both via servletName and the key in the org.apache.camel.quarkus.servlet.runtime.CamelServletConfig.ServletsConfig#namedServlets map. This method sets the precedence: the servletName gets effective only if it has a non-default value; otherwise the key is returned as the servlet name.

Parameters:

key - the key used in org.apache.camel.quarkus.servlet.runtime.CamelServletConfig.ServletsConfig#namedServlets

Returns:

the effective servlet name to use