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

public Class WebDescriptor

extends Descriptor
Class Inheritance
Known Direct Subclasses
org.eclipse.jetty.ee10.webapp.DefaultsDescriptor, org.eclipse.jetty.ee10.webapp.FragmentDescriptor, org.eclipse.jetty.ee10.webapp.OverrideDescriptor
Imports
java.io.IOException, java.net.URI, .URL, java.util.ArrayList, .Iterator, .List, jakarta.servlet.Servlet, org.eclipse.jetty.ee10.servlet.ServletContextHandler, org.eclipse.jetty.util.resource.Resource, org.eclipse.jetty.xml.XmlParser, org.slf4j.Logger, .LoggerFactory
Descriptor A web descriptor (web.xml/web-defaults.xml/web-overrides.xml).

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
WebDescriptor.WebDescriptorParser

Field Summary

Modifier and TypeField and Description
public static XmlParser
__nonValidatingStaticParser

protected ArrayList<String>
_classNames

protected boolean
_distributable

protected boolean
_isOrdered

protected int
_majorVersion

protected MetaData.Complete
_metaDataComplete

protected int
_minorVersion

protected List<String>
_ordering

private static final Logger
LOG

Hides org.eclipse.jetty.ee10.webapp.Descriptor.LOG.

Inherited from org.eclipse.jetty.ee10.webapp.Descriptor:
_dtd_root_xml

Constructor Summary

AccessConstructor and Description
public
WebDescriptor(Resource xml)

Method Summary

Modifier and TypeMethod and Description
public void
addClassName(String className)

public ArrayList<String>
getClassNames()

public int
getMajorVersion()

public MetaData.Complete
getMetaDataComplete()

public int
getMinorVersion()

public List<String>
getOrdering()

public static XmlParser

Returns:

an XmlParser for web descriptors
getParser(boolean
true if the parser should validate syntax, false otherwise
validating)

Get a parser for parsing web descriptor content.

public boolean
isDistributable()

public static boolean

Returns:

true iff metadata-complete=true is declared in the descriptor
isMetaDataComplete(WebDescriptor
the descriptor (web.xml, web-fragment.xml, web-default.xml, web-override.xml) to check
d)

Check if the descriptor is metadata-complete.

public boolean
isOrdered()

public static XmlParser

Returns:

an XmlParser
newParser(boolean
if true, the parser will validate syntax
validating)

Create a new parser for parsing web descriptors.

public void
parse(XmlParser parser)

Overrides org.eclipse.jetty.ee10.webapp.Descriptor.parse.

public void
processDistributable()

public void
processOrdering()

public void
processVersion()

Inherited from org.eclipse.jetty.ee10.webapp.Descriptor:
getResourcegetRootgetURItoString

Field Detail

__nonValidatingStaticParserback to summary
public static XmlParser __nonValidatingStaticParser
_classNamesback to summary
protected ArrayList<String> _classNames
_distributableback to summary
protected boolean _distributable
_isOrderedback to summary
protected boolean _isOrdered
_majorVersionback to summary
protected int _majorVersion
_metaDataCompleteback to summary
protected MetaData.Complete _metaDataComplete
_minorVersionback to summary
protected int _minorVersion
_orderingback to summary
protected List<String> _ordering
LOGback to summary
private static final Logger LOG

Hides org.eclipse.jetty.ee10.webapp.Descriptor.LOG.

Constructor Detail

WebDescriptorback to summary
public WebDescriptor(Resource xml)

Method Detail

addClassNameback to summary
public void addClassName(String className)
getClassNamesback to summary
public ArrayList<String> getClassNames()
getMajorVersionback to summary
public int getMajorVersion()
getMetaDataCompleteback to summary
public MetaData.Complete getMetaDataComplete()
getMinorVersionback to summary
public int getMinorVersion()
getOrderingback to summary
public List<String> getOrdering()
getParserback to summary
public static XmlParser getParser(boolean validating)

Get a parser for parsing web descriptor content.

Parameters
validating:boolean

true if the parser should validate syntax, false otherwise

Returns:XmlParser

an XmlParser for web descriptors

isDistributableback to summary
public boolean isDistributable()
isMetaDataCompleteback to summary
public static boolean isMetaDataComplete(WebDescriptor d)

Check if the descriptor is metadata-complete.

Parameters
d:WebDescriptor

the descriptor (web.xml, web-fragment.xml, web-default.xml, web-override.xml) to check

Returns:boolean

true iff metadata-complete=true is declared in the descriptor

isOrderedback to summary
public boolean isOrdered()
newParserback to summary
public static XmlParser newParser(boolean validating)

Create a new parser for parsing web descriptors.

Parameters
validating:boolean

if true, the parser will validate syntax

Returns:XmlParser

an XmlParser

parseback to summary
public void parse(XmlParser parser) throws Exception

Overrides org.eclipse.jetty.ee10.webapp.Descriptor.parse.

Annotations
@Override
processDistributableback to summary
public void processDistributable()
processOrderingback to summary
public void processOrdering()
processVersionback to summary
public void processVersion()
org.eclipse.jetty.ee10.webapp back to summary

private Class WebDescriptor.WebDescriptorParser

extends XmlParser
Class Inheritance

Constructor Summary

AccessConstructor and Description
public
WebDescriptorParser(boolean validating)

Method Summary

Inherited from org.eclipse.jetty.xml.XmlParser:
addCatalogaddCatalogaddContentHandlergetDTDgetSAXParsergetXpathisValidatingnewSAXParserFactoryparseparseparseparsesetValidatingsetXpath

Constructor Detail

WebDescriptorParserback to summary
public WebDescriptorParser(boolean validating) throws IOException