Top Description Fields Constructors Methods
org.eclipse.jetty.ee10.webapp

public Class StandardDescriptorProcessor

extends IterativeDescriptorProcessor
Class Inheritance
Imports
java.util.ArrayList, .Arrays, .EnumSet, .HashMap, .HashSet, .Iterator, .List, .ListIterator, .Locale, .Map, .Objects, .Set, java.util.concurrent.TimeUnit, jakarta.servlet.DispatcherType, .MultipartConfigElement, .SessionTrackingMode, org.eclipse.jetty.ee10.servlet.ErrorPageErrorHandler, .FilterHolder, .FilterMapping, .ListenerHolder, .ServletContextHandler.JspConfig, .ServletContextHandler.JspPropertyGroup, .ServletContextHandler.TagLib, .ServletHolder, .ServletMapping, .Source, org.eclipse.jetty.ee10.servlet.security.ConstraintAware, .ConstraintMapping, .ConstraintSecurityHandler, org.eclipse.jetty.http.pathmap.ServletPathSpec, org.eclipse.jetty.security.Authenticator, .Constraint, org.eclipse.jetty.security.authentication.FormAuthenticator, org.eclipse.jetty.util.ArrayUtil, .Loader, .StringUtil, org.eclipse.jetty.xml.XmlParser, .XmlParser.Node, org.slf4j.Logger, .LoggerFactory
StandardDescriptorProcessor.

Process the web.xml, web-defaults.xml, web-overrides.xml, and web-fragment.xml descriptors.

Field Summary

Modifier and TypeField and Description
pack-priv final Map<String, FilterHolder>
_filterHolderMap

pack-priv final List<FilterHolder>
_filterHolders

pack-priv final List<FilterMapping>
_filterMappings

pack-priv final Map<String, ServletHolder>
_servletHolderMap

pack-priv final List<ServletHolder>
_servletHolders

pack-priv final List<ServletMapping>
_servletMappings

private static final Logger
LOG

public static final String
STANDARD_PROCESSOR

Inherited from org.eclipse.jetty.ee10.webapp.IterativeDescriptorProcessor:
__signature_visitors

Constructor Summary

AccessConstructor and Description
public
StandardDescriptorProcessor()

Method Summary

Modifier and TypeMethod and Description
public void
addFilterMapping(String filterName, XmlParser.Node node, WebAppContext context, Descriptor descriptor)

public ServletMapping
addServletMapping(String servletName, XmlParser.Node node, WebAppContext context, Descriptor descriptor)

public void
addSessionConfigAttribute(WebAppContext context, Descriptor descriptor, String name, String value)

public void
addWelcomeFiles(WebAppContext context, XmlParser.Node node, Descriptor descriptor)

public void
end(WebAppContext context, Descriptor descriptor)

Implements abstract org.eclipse.jetty.ee10.webapp.IterativeDescriptorProcessor.end.

private boolean

Returns:

true if the path can be mapped, false otherwise
resolveAnyDuplicateServletPathMapping(String
the servlet target of the mapping
servletName, String
the path to check
path, WebAppContext
the context of the mapping
context, Descriptor
the descriptor currently being parsed
descriptor)

Resolve any duplicate servlet path mappings.

public void
start(WebAppContext context, Descriptor descriptor)

Implements abstract org.eclipse.jetty.ee10.webapp.IterativeDescriptorProcessor.start.

private void
unknownOrigin(Origin origin)

public void
visitContextParam(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

public void
visitDefaultContextPath(WebAppContext
the of the processing
context, Descriptor
the descriptor
descriptor, XmlParser.Node
the xml node
node)

When specified, this element provides a default context path of the web application.

public void
visitDenyUncoveredHttpMethods(WebAppContext
the of the processing
context, Descriptor
the descriptor
descriptor, XmlParser.Node
the xml node
node)

Servlet spec 3.1.

public void
visitDisplayName(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

public void
visitErrorPage(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

public void
visitFilter(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

public void
visitFilterMapping(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

public void
visitJspConfig(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

public void
visitListener(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

public void
visitLocaleEncodingList(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

public void
visitLoginConfig(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

public void
visitMimeMapping(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

public void
visitRequestCharacterEncoding(WebAppContext
the of the processing
context, Descriptor
the descriptor
descriptor, XmlParser.Node
the xml node
node)

When specified, this element provides a default request encoding of the web application.

public void
visitResponseCharacterEncoding(WebAppContext
the of the processing
context, Descriptor
the descriptor
descriptor, XmlParser.Node
the xml node
node)

When specified, this element provides a default response encoding of the web application.

public void
visitSecurityConstraint(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

public void
visitSecurityRole(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

public void
visitServlet(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

public void
visitServletMapping(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

public void
visitSessionConfig(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

public void
visitTagLib(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

public void
visitWelcomeFileList(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

Inherited from org.eclipse.jetty.ee10.webapp.IterativeDescriptorProcessor:
processregisterVisitorvisit

Field Detail

_filterHolderMapback to summary
pack-priv final Map<String, FilterHolder> _filterHolderMap
_filterHoldersback to summary
pack-priv final List<FilterHolder> _filterHolders
_filterMappingsback to summary
pack-priv final List<FilterMapping> _filterMappings
_servletHolderMapback to summary
pack-priv final Map<String, ServletHolder> _servletHolderMap
_servletHoldersback to summary
pack-priv final List<ServletHolder> _servletHolders
_servletMappingsback to summary
pack-priv final List<ServletMapping> _servletMappings
LOGback to summary
private static final Logger LOG
STANDARD_PROCESSORback to summary
public static final String STANDARD_PROCESSOR

Constructor Detail

StandardDescriptorProcessorback to summary
public StandardDescriptorProcessor()

Method Detail

addFilterMappingback to summary
public void addFilterMapping(String filterName, XmlParser.Node node, WebAppContext context, Descriptor descriptor)
addServletMappingback to summary
public ServletMapping addServletMapping(String servletName, XmlParser.Node node, WebAppContext context, Descriptor descriptor)
addSessionConfigAttributeback to summary
public void addSessionConfigAttribute(WebAppContext context, Descriptor descriptor, String name, String value)
addWelcomeFilesback to summary
public void addWelcomeFiles(WebAppContext context, XmlParser.Node node, Descriptor descriptor)
endback to summary
public void end(WebAppContext context, Descriptor descriptor)

Implements abstract org.eclipse.jetty.ee10.webapp.IterativeDescriptorProcessor.end.

Annotations
@Override
resolveAnyDuplicateServletPathMappingback to summary
private boolean resolveAnyDuplicateServletPathMapping(String servletName, String path, WebAppContext context, Descriptor descriptor)

Resolve any duplicate servlet path mappings. A path can be (re)mapped iff:

  • it is not already mapped
  • it is already mapped by webdefault.xml
  • it is already mapped by the embedded api, and the descriptor is not webdefault.xml
The effect of the above conditions is to produce the following precedence hierarchy:
  1. jetty-override.xml (OverrideDescriptor)
  2. web.xml (WebDescriptor)
  3. web-fragment.xml (FragmentDescriptor)
  4. embedded api
  5. webdefault.xml (DefaultsDescriptor)
Parameters
servletName:String

the servlet target of the mapping

path:String

the path to check

context:WebAppContext

the context of the mapping

descriptor:Descriptor

the descriptor currently being parsed

Returns:boolean

true if the path can be mapped, false otherwise

Exceptions
IllegalStateException:
if the duplicate mappings are illegal
startback to summary
public void start(WebAppContext context, Descriptor descriptor)

Implements abstract org.eclipse.jetty.ee10.webapp.IterativeDescriptorProcessor.start.

Annotations
@Override
unknownOriginback to summary
private void unknownOrigin(Origin origin)
visitContextParamback to summary
public void visitContextParam(WebAppContext context, Descriptor descriptor, XmlParser.Node node)
visitDefaultContextPathback to summary
public void visitDefaultContextPath(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

When specified, this element provides a default context path of the web application. The default context path starts with a / character. If it is not rooted at the root of the server's name space, the path does not end with a / character.

Parameters
context:WebAppContext

the of the processing

descriptor:Descriptor

the descriptor

node:XmlParser.Node

the xml node

Since
Servlet 4.0
visitDenyUncoveredHttpMethodsback to summary
public void visitDenyUncoveredHttpMethods(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

Servlet spec 3.1. When present in web.xml, this means that http methods that are not covered by security constraints should have access denied.

See section 13.8.4, pg 145

Parameters
context:WebAppContext

the of the processing

descriptor:Descriptor

the descriptor

node:XmlParser.Node

the xml node

visitDisplayNameback to summary
public void visitDisplayName(WebAppContext context, Descriptor descriptor, XmlParser.Node node)
visitErrorPageback to summary
public void visitErrorPage(WebAppContext context, Descriptor descriptor, XmlParser.Node node)
visitFilterback to summary
public void visitFilter(WebAppContext context, Descriptor descriptor, XmlParser.Node node)
visitFilterMappingback to summary
public void visitFilterMapping(WebAppContext context, Descriptor descriptor, XmlParser.Node node)
visitJspConfigback to summary
public void visitJspConfig(WebAppContext context, Descriptor descriptor, XmlParser.Node node)
visitListenerback to summary
public void visitListener(WebAppContext context, Descriptor descriptor, XmlParser.Node node)
visitLocaleEncodingListback to summary
public void visitLocaleEncodingList(WebAppContext context, Descriptor descriptor, XmlParser.Node node)
visitLoginConfigback to summary
public void visitLoginConfig(WebAppContext context, Descriptor descriptor, XmlParser.Node node) throws Exception
visitMimeMappingback to summary
public void visitMimeMapping(WebAppContext context, Descriptor descriptor, XmlParser.Node node)
visitRequestCharacterEncodingback to summary
public void visitRequestCharacterEncoding(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

When specified, this element provides a default request encoding of the web application.

Parameters
context:WebAppContext

the of the processing

descriptor:Descriptor

the descriptor

node:XmlParser.Node

the xml node

Since
Servlet 4.0
visitResponseCharacterEncodingback to summary
public void visitResponseCharacterEncoding(WebAppContext context, Descriptor descriptor, XmlParser.Node node)

When specified, this element provides a default response encoding of the web application.

Parameters
context:WebAppContext

the of the processing

descriptor:Descriptor

the descriptor

node:XmlParser.Node

the xml node

Since
Servlet 4.0
visitSecurityConstraintback to summary
public void visitSecurityConstraint(WebAppContext context, Descriptor descriptor, XmlParser.Node node)
visitSecurityRoleback to summary
public void visitSecurityRole(WebAppContext context, Descriptor descriptor, XmlParser.Node node)
visitServletback to summary
public void visitServlet(WebAppContext context, Descriptor descriptor, XmlParser.Node node)
visitServletMappingback to summary
public void visitServletMapping(WebAppContext context, Descriptor descriptor, XmlParser.Node node)
visitSessionConfigback to summary
public void visitSessionConfig(WebAppContext context, Descriptor descriptor, XmlParser.Node node)
visitTagLibback to summary
public void visitTagLib(WebAppContext context, Descriptor descriptor, XmlParser.Node node)
visitWelcomeFileListback to summary
public void visitWelcomeFileList(WebAppContext context, Descriptor descriptor, XmlParser.Node node)