Modifier and Type	Class and Description
public static enum	MetaData.Complete
public static class	MetaData.OriginInfo Metadata regarding where a deployable element was declared: by annotation or by descriptor.

Modifier and Type	Field and Description
protected boolean	_allowDuplicateFragmentNames
protected final Map<Resource, List<DiscoveredAnnotation>>	_annotations
protected final List<DescriptorProcessor>	_descriptorProcessors
private final AutoLock	_lock
protected boolean	_metaDataComplete
protected final List<Resource>	_orderedContainerResources
protected final List<Resource>	_orderedWebInfResources
protected Ordering	_ordering
protected Map<String, MetaData.OriginInfo>	_origins
protected boolean	_validateXml
protected WebDescriptor	_webDefaultsRoot
protected final Map<String, FragmentDescriptor>	_webFragmentNameMap
protected final Map<Resource, FragmentDescriptor>	_webFragmentResourceMap
protected final List<FragmentDescriptor>	_webFragmentRoots
protected final List<Resource>	_webInfClasses
protected final List<Resource>	_webInfJars
protected final List<WebDescriptor>	_webOverrideRoots
protected WebDescriptor	_webXmlRoot
private static final Logger	LOG
public static final String	ORDERED_LIBS
public static final String	VALIDATE_XML

Access	Constructor and Description
public	MetaData()

Method Summary

Modifier and Type	Method and Description
public void	addContainerResource(Resource jar)
public void	addDescriptorProcessor(DescriptorProcessor p)
public void	addDiscoveredAnnotation(DiscoveredAnnotation the discovered annotation annotation) Add an annotation that has been discovered on a class, method or field within a resource eg a jar or dir.
public void	addDiscoveredAnnotations(List<DiscoveredAnnotation> the list of discovered annotations to add annotations) Annotations such as WebServlet, WebFilter, WebListener that can be discovered by scanning unloaded classes.
public void	addFragmentDescriptor(Resource the jar of the fragment jarResource, FragmentDescriptor web-fragment.xml descriptor) Add a web-fragment.xml, and the jar it is contained in.
public void	addOverrideDescriptor(OverrideDescriptor the override-web.xml descriptor) Add a override-web.xml descriptor.
public void	addWebInfResource(Resource newResource)
public void	clear() Empty ready for reuse
public List<Resource>	getContainerResources()
public WebDescriptor	getDefaultsDescriptor()
private Resource	Returns: the resource from the list that contains the given resource. getEnclosingResource(List<Resource> the list of resources to check against resources, Resource the resource for which to find the parent resource resource) Check if the resource is contained within one of the list of resources.
public FragmentDescriptor	getFragmentDescriptor(String the name specified in a web-fragment.xml name) Returns: the web-fragment.xml that defines that name or null
public FragmentDescriptor	getFragmentDescriptor(Resource the web-fragment.xml location as a Resource descriptorResource) Returns: the FrgmentDescriptor for the web-fragment.xml, or null if none exists
public FragmentDescriptor	Returns: the FragmentDescriptor or null if no web-fragment.xml is associated with the jar getFragmentDescriptorForJar(Resource the jar to check for a mapping to web-fragment.xml jar) Get the web-fragment.xml related to a jar
public Resource	getJarForFragmentName(String the name specified in a web-fragment.xml name) Returns: the jar that contains the web-fragment.xml with the given name or null
public Map<String, FragmentDescriptor>	getNamedFragmentDescriptors() Returns: a map of name to FragmentDescriptor, for those FragmentDescriptors that define a name element.
public Ordering	getOrdering()
public Origin	getOrigin(String name)
public Descriptor	getOriginDescriptor(String name)
public MetaData.OriginInfo	getOriginInfo(String name)
public Map<String, MetaData.OriginInfo>	getOrigins()
public List<WebDescriptor>	getOverrideDescriptors()
public WebDescriptor	getWebDescriptor()
public List<Resource>	getWebInfClassesResources()
public List<Resource>	getWebInfResources(boolean withOrdering)
public boolean	isAllowDuplicateFragmentNames()
public boolean	Returns: true if the webapp is distributable, false otherwise isDistributable() A webapp is distributable if web.xml is metadata-complete and distributable=true, or if metadata-complete is false, but all web-fragments.xml are distributable=true.
public boolean	isMetaDataComplete()
public boolean	isOrdered()
public boolean	isValidateXml() Returns: true if the parser validates, false otherwise
public void	orderFragments()
public void	removeDescriptorProcessor(DescriptorProcessor p)
public void	resolve(WebAppContext the context to resolve servlets / filters / listeners metadata from context) Resolve all servlet/filter/listener metadata from all sources: descriptors and annotations.
public void	setAllowDuplicateFragmentNames(boolean allowDuplicateFragmentNames)
public void	setDefaultsDescriptor(DefaultsDescriptor the web-default.xml descriptor) Set the web-default.xml.
public void	setOrdering(Ordering o)
public void	setOrigin(String name, Descriptor d)
public void	setOrigin(String name, Annotation annotation, Class<?> annotated)
public void	setOriginAPI(String name)
public void	setValidateXml(boolean if true xml syntax is validated by the parser, false otherwise validateXml) Set if true xml syntax is validated by the parser, false otherwise.
public void	setWebDescriptor(WebDescriptor the web.xml descriptor descriptor) Set the web.xml descriptor.
public void	setWebInfClassesResources(List<Resource> dirs)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_allowDuplicateFragmentNames	back to summary
protected boolean _allowDuplicateFragmentNames

_annotations	back to summary
protected final Map<Resource, List<DiscoveredAnnotation>> _annotations

_descriptorProcessors	back to summary
protected final List<DescriptorProcessor> _descriptorProcessors

_lock	back to summary
private final AutoLock _lock

_metaDataComplete	back to summary
protected boolean _metaDataComplete

_orderedContainerResources	back to summary
protected final List<Resource> _orderedContainerResources

_orderedWebInfResources	back to summary
protected final List<Resource> _orderedWebInfResources

_ordering	back to summary
protected Ordering _ordering

_origins	back to summary
protected Map<String, MetaData.OriginInfo> _origins

_validateXml	back to summary
protected boolean _validateXml

_webDefaultsRoot	back to summary
protected WebDescriptor _webDefaultsRoot

_webFragmentNameMap	back to summary
protected final Map<String, FragmentDescriptor> _webFragmentNameMap

_webFragmentResourceMap	back to summary
protected final Map<Resource, FragmentDescriptor> _webFragmentResourceMap

_webFragmentRoots	back to summary
protected final List<FragmentDescriptor> _webFragmentRoots

_webInfClasses	back to summary
protected final List<Resource> _webInfClasses

_webInfJars	back to summary
protected final List<Resource> _webInfJars

_webOverrideRoots	back to summary
protected final List<WebDescriptor> _webOverrideRoots

_webXmlRoot	back to summary
protected WebDescriptor _webXmlRoot

LOG	back to summary
private static final Logger LOG

ORDERED_LIBS	back to summary
public static final String ORDERED_LIBS

VALIDATE_XML	back to summary
public static final String VALIDATE_XML

Constructor Detail

MetaData	back to summary
public MetaData()

Method Detail

addContainerResource	back to summary
public void addContainerResource(Resource jar)

addDescriptorProcessor	back to summary
public void addDescriptorProcessor(DescriptorProcessor p)

addDiscoveredAnnotation	back to summary
public void addDiscoveredAnnotation(DiscoveredAnnotation annotation) Add an annotation that has been discovered on a class, method or field within a resource eg a jar or dir. The annotation may also have no associated resource, or that resource may be a system or container resource. This method is synchronized as it is anticipated that it may be called by many threads during the annotation scanning phase. Parameters annotation:DiscoveredAnnotation the discovered annotation

addDiscoveredAnnotation

back to summary

public void addDiscoveredAnnotation(DiscoveredAnnotation annotation)

Add an annotation that has been discovered on a class, method or field within a resource eg a jar or dir. The annotation may also have no associated resource, or that resource may be a system or container resource. This method is synchronized as it is anticipated that it may be called by many threads during the annotation scanning phase.

Parameters

annotation:DiscoveredAnnotation: the discovered annotation

addDiscoveredAnnotations	back to summary
public void addDiscoveredAnnotations(List<DiscoveredAnnotation> annotations) Annotations such as WebServlet, WebFilter, WebListener that can be discovered by scanning unloaded classes. Parameters annotations:List<DiscoveredAnnotation> the list of discovered annotations to add

addDiscoveredAnnotations

back to summary

public void addDiscoveredAnnotations(List<DiscoveredAnnotation> annotations)

Annotations such as WebServlet, WebFilter, WebListener that can be discovered by scanning unloaded classes.

Parameters

annotations:List<DiscoveredAnnotation>: the list of discovered annotations to add

addFragmentDescriptor	back to summary
public void addFragmentDescriptor(Resource jarResource, FragmentDescriptor descriptor) throws Exception Add a web-fragment.xml, and the jar it is contained in. Parameters jarResource:Resource the jar of the fragment descriptor:FragmentDescriptor web-fragment.xml Exceptions Exception: if unable to add fragment

addFragmentDescriptor

back to summary

public void addFragmentDescriptor(Resource jarResource, FragmentDescriptor descriptor) throws Exception

Add a web-fragment.xml, and the jar it is contained in.

Parameters

jarResource:Resource: the jar of the fragment
descriptor:FragmentDescriptor: web-fragment.xml

Exceptions

Exception:: if unable to add fragment

addOverrideDescriptor	back to summary
public void addOverrideDescriptor(OverrideDescriptor descriptor) throws Exception Add a override-web.xml descriptor. Parameters descriptor:OverrideDescriptor the override-web.xml

addOverrideDescriptor

back to summary

public void addOverrideDescriptor(OverrideDescriptor descriptor) throws Exception

Add a override-web.xml descriptor.

Parameters

descriptor:OverrideDescriptor: the override-web.xml

addWebInfResource	back to summary
public void addWebInfResource(Resource newResource)

clear	back to summary
public void clear() Empty ready for reuse

getContainerResources	back to summary
public List<Resource> getContainerResources()

getDefaultsDescriptor	back to summary
public WebDescriptor getDefaultsDescriptor()

getEnclosingResource	back to summary
private Resource getEnclosingResource(List<Resource> resources, Resource resource) Check if the resource is contained within one of the list of resources. In other words, check if the given resource is a sub-resource of one of the list of resources. Parameters resources:List<Resource> the list of resources to check against resource:Resource the resource for which to find the parent resource Returns:Resource the resource from the list that contains the given resource.

getEnclosingResource

back to summary

private Resource getEnclosingResource(List<Resource> resources, Resource resource)

Check if the resource is contained within one of the list of resources. In other words, check if the given resource is a sub-resource of one of the list of resources.

Parameters

resources:List<Resource>: the list of resources to check against
resource:Resource: the resource for which to find the parent resource

Returns:Resource

the resource from the list that contains the given resource.

getFragmentDescriptor	back to summary
public FragmentDescriptor getFragmentDescriptor(String name) Parameters name:String the name specified in a web-fragment.xml Returns:FragmentDescriptor the web-fragment.xml that defines that name or null

getFragmentDescriptor	back to summary
public FragmentDescriptor getFragmentDescriptor(Resource descriptorResource) Parameters descriptorResource:Resource the web-fragment.xml location as a Resource Returns:FragmentDescriptor the FrgmentDescriptor for the web-fragment.xml, or null if none exists

getFragmentDescriptorForJar	back to summary
public FragmentDescriptor getFragmentDescriptorForJar(Resource jar) Get the web-fragment.xml related to a jar Parameters jar:Resource the jar to check for a mapping to web-fragment.xml Returns:FragmentDescriptor the FragmentDescriptor or null if no web-fragment.xml is associated with the jar

getFragmentDescriptorForJar

back to summary

public FragmentDescriptor getFragmentDescriptorForJar(Resource jar)

Get the web-fragment.xml related to a jar

Parameters

jar:Resource: the jar to check for a mapping to web-fragment.xml

Returns:FragmentDescriptor

the FragmentDescriptor or null if no web-fragment.xml is associated with the jar

getJarForFragmentName	back to summary
public Resource getJarForFragmentName(String name) Parameters name:String the name specified in a web-fragment.xml Returns:Resource the jar that contains the web-fragment.xml with the given name or null

getNamedFragmentDescriptors	back to summary
public Map<String, FragmentDescriptor> getNamedFragmentDescriptors() Returns:Map<String, FragmentDescriptor> a map of name to FragmentDescriptor, for those FragmentDescriptors that define a name element.

getOrdering	back to summary
public Ordering getOrdering()

getOrigin	back to summary
public Origin getOrigin(String name)

getOriginDescriptor	back to summary
public Descriptor getOriginDescriptor(String name)

getOriginInfo	back to summary
public MetaData.OriginInfo getOriginInfo(String name)

getOrigins	back to summary
public Map<String, MetaData.OriginInfo> getOrigins()

getOverrideDescriptors	back to summary
public List<WebDescriptor> getOverrideDescriptors()

getWebDescriptor	back to summary
public WebDescriptor getWebDescriptor()

getWebInfClassesResources	back to summary
public List<Resource> getWebInfClassesResources()

getWebInfResources	back to summary
public List<Resource> getWebInfResources(boolean withOrdering)

isAllowDuplicateFragmentNames	back to summary
public boolean isAllowDuplicateFragmentNames()

isDistributable

back to summary

public boolean isDistributable()

A webapp is distributable if web.xml is metadata-complete and distributable=true, or if metadata-complete is false, but all web-fragments.xml are distributable=true.

Returns:boolean: true if the webapp is distributable, false otherwise

isMetaDataComplete	back to summary
public boolean isMetaDataComplete()

isOrdered	back to summary
public boolean isOrdered()

isValidateXml	back to summary
public boolean isValidateXml() Returns:boolean true if the parser validates, false otherwise

orderFragments	back to summary
public void orderFragments()

removeDescriptorProcessor	back to summary
public void removeDescriptorProcessor(DescriptorProcessor p)

resolve

back to summary

public void resolve(WebAppContext context) throws Exception

Resolve all servlet/filter/listener metadata from all sources: descriptors and annotations.

Parameters

context:WebAppContext: the context to resolve servlets / filters / listeners metadata from

Exceptions

Exception:: if unable to resolve metadata

setAllowDuplicateFragmentNames	back to summary
public void setAllowDuplicateFragmentNames(boolean allowDuplicateFragmentNames)

setDefaultsDescriptor

back to summary

public void setDefaultsDescriptor(DefaultsDescriptor descriptor) throws Exception

Set the web-default.xml.

Parameters

descriptor:DefaultsDescriptor: the web-default.xml

setOrdering	back to summary
public void setOrdering(Ordering o)

setOrigin	back to summary
public void setOrigin(String name, Descriptor d)

setOrigin	back to summary
public void setOrigin(String name, Annotation annotation, Class<?> annotated)

setOriginAPI	back to summary
public void setOriginAPI(String name)

setValidateXml

back to summary

public void setValidateXml(boolean validateXml)

Set if true xml syntax is validated by the parser, false otherwise.

Parameters

validateXml:boolean: if true xml syntax is validated by the parser, false otherwise

setWebDescriptor

back to summary

public void setWebDescriptor(WebDescriptor descriptor) throws Exception

Set the web.xml descriptor.

Parameters

descriptor:WebDescriptor: the web.xml descriptor

setWebInfClassesResources	back to summary
public void setWebInfClassesResources(List<Resource> dirs)

org.eclipse.jetty.ee10.webapp back to summary

public final Enum MetaData.Complete

Class Inheritance

extends Enum<MetaData.Complete>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.ee10.webapp.MetaData.Complete

Field Summary

Modifier and Type	Field and Description
public static final MetaData.Complete	False
public static final MetaData.Complete	NotSet
public static final MetaData.Complete	True

Constructor Summary

Access	Constructor and Description
private	Complete()

Method Summary

Modifier and Type	Method and Description
public static MetaData.Complete	valueOf(String name)
public static MetaData.Complete[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

False	back to summary
public static final MetaData.Complete False

NotSet	back to summary
public static final MetaData.Complete NotSet

True	back to summary
public static final MetaData.Complete True

Constructor Detail

Complete	back to summary
private Complete()

Method Detail

valueOf	back to summary
public static MetaData.Complete valueOf(String name)

values	back to summary
public static MetaData.Complete[] values()

org.eclipse.jetty.ee10.webapp back to summary

public Class MetaData.OriginInfo

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jetty.ee10.webapp.MetaData.OriginInfo

Metadata regarding where a deployable element was declared: by annotation or by descriptor.

Field Summary

Modifier and Type	Field and Description
private final Class<?>	annotated The class containing the annotation, if declared by one
private final Annotation	annotation Reference to the annotation, if declared by one
private final Descriptor	descriptor Reference to the descriptor, if declared in one
private final String	name Identifier for the deployable element
private final Origin	origin Origin of the deployable element

Constructor Summary

Access	Constructor and Description
public	OriginInfo(String n, Annotation a, Class<?> ac)
public	OriginInfo(String n, Descriptor d)
public	OriginInfo(String n)

Method Summary

Modifier and Type	Method and Description
public Descriptor	getDescriptor()
public String	getName()
public Origin	getOriginType()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

annotated	back to summary
private final Class<?> annotated The class containing the annotation, if declared by one

annotation	back to summary
private final Annotation annotation Reference to the annotation, if declared by one

descriptor	back to summary
private final Descriptor descriptor Reference to the descriptor, if declared in one

name	back to summary
private final String name Identifier for the deployable element

origin	back to summary
private final Origin origin Origin of the deployable element

Constructor Detail

OriginInfo	back to summary
public OriginInfo(String n, Annotation a, Class<?> ac)

OriginInfo	back to summary
public OriginInfo(String n, Descriptor d)

OriginInfo	back to summary
public OriginInfo(String n)

Method Detail

getDescriptor	back to summary
public Descriptor getDescriptor()

getName	back to summary
public String getName()

getOriginType	back to summary
public Origin getOriginType()

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class MetaData

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum MetaData.Complete

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class MetaData.OriginInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail