org.eclipse.jetty.webapp

Class MetaData

java.lang.Object

org.eclipse.jetty.webapp.MetaData

public class MetaData
extends Object

MetaData All data associated with the configuration and deployment of a web application.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetaData.OriginInfo

Field Summary

Fields

Modifier and Type	Field and Description
static Resource	NON_FRAG_RESOURCE
static String	ORDERED_LIBS
static String	VALIDATE_XML

Constructor Summary

Constructors

Constructor and Description
MetaData()

Method Summary

Modifier and Type	Method and Description
void	addContainerResource(Resource jar)
void	addDescriptorProcessor(DescriptorProcessor p)
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.
void	addDiscoveredAnnotations(List<DiscoveredAnnotation> annotations) Annotations not associated with a WEB-INF/lib fragment jar.
void	addFragment(Resource jarResource, Resource xmlResource) Add a web-fragment.xml
void	addOverride(Resource override)
void	addWebInfJar(Resource newResource)
void	clear() Empty ready for reuse
List<Resource>	getContainerResources()
FragmentDescriptor	getFragment(Resource jar)
FragmentDescriptor	getFragment(String name)
List<FragmentDescriptor>	getFragments()
Resource	getJarForFragment(String name)
Map<String,FragmentDescriptor>	getNamedFragments()
List<FragmentDescriptor>	getOrderedFragments()
List<Resource>	getOrderedWebInfJars()
Ordering	getOrdering()
Origin	getOrigin(String name)
Descriptor	getOriginDescriptor(String name)
MetaData.OriginInfo	getOriginInfo(String name)
Map<String,MetaData.OriginInfo>	getOrigins()
List<WebDescriptor>	getOverrideWebs()
WebDescriptor	getWebDefault()
List<Resource>	getWebInfClassesDirs()
List<Resource>	getWebInfJars()
WebDescriptor	getWebXml()
boolean	isAllowDuplicateFragmentNames()
boolean	isDistributable()
boolean	isMetaDataComplete()
boolean	isValidateXml()
void	orderFragments()
void	removeDescriptorProcessor(DescriptorProcessor p)
void	resolve(WebAppContext context) Resolve all servlet/filter/listener metadata from all sources: descriptors and annotations.
void	setAllowDuplicateFragmentNames(boolean allowDuplicateFragmentNames)
void	setDefaults(Resource webDefaults)
void	setOrdering(Ordering o)
void	setOrigin(String name, Annotation annotation, Class<?> annotated)
void	setOrigin(String name, Descriptor d)
void	setOriginAPI(String name)
void	setValidateXml(boolean validateXml)
void	setWebInfClassesDirs(List<Resource> dirs)
void	setWebXml(Resource webXml)

Methods inherited from class java.lang.Object

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

Field Detail

VALIDATE_XML

public static final String VALIDATE_XML

See Also:

Constant Field Values

ORDERED_LIBS

public static final String ORDERED_LIBS

See Also:

Constant Field Values

NON_FRAG_RESOURCE

public static final Resource NON_FRAG_RESOURCE

Constructor Detail

MetaData

public MetaData()

Method Detail

clear

public void clear()

Empty ready for reuse

setDefaults

public void setDefaults(Resource webDefaults)
                 throws Exception

Throws:

Exception

setWebXml

public void setWebXml(Resource webXml)
               throws Exception

Throws:

Exception

addOverride

public void addOverride(Resource override)
                 throws Exception

Throws:

Exception

addFragment

public void addFragment(Resource jarResource,
                        Resource xmlResource)
                 throws Exception

Add a web-fragment.xml

Parameters:

jarResource - the jar the fragment is contained in

xmlResource - the resource representing the xml file

Throws:

Exception - if unable to add fragment

addDiscoveredAnnotations

public void addDiscoveredAnnotations(List<DiscoveredAnnotation> annotations)

Annotations not associated with a WEB-INF/lib fragment jar. These are from WEB-INF/classes or the ??container path??

Parameters:

annotations - the list of discovered annotations to add

addDiscoveredAnnotation

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. This method is synchronized as it is anticipated that it may be called by many threads during the annotation scanning phase.

Parameters:

annotation - the discovered annotation

addDescriptorProcessor

public void addDescriptorProcessor(DescriptorProcessor p)

removeDescriptorProcessor

public void removeDescriptorProcessor(DescriptorProcessor p)

orderFragments

public void orderFragments()

resolve

public void resolve(WebAppContext context)
             throws Exception

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

Parameters:

context - the context to resolve servlets / filters / listeners metadata from

Throws:

Exception - if unable to resolve metadata

isDistributable

public boolean isDistributable()

getWebXml

public WebDescriptor getWebXml()

getOverrideWebs

public List<WebDescriptor> getOverrideWebs()

getWebDefault

public WebDescriptor getWebDefault()

getFragments

public List<FragmentDescriptor> getFragments()

getOrderedWebInfJars

public List<Resource> getOrderedWebInfJars()

getOrderedFragments

public List<FragmentDescriptor> getOrderedFragments()

getOrdering

public Ordering getOrdering()

setOrdering

public void setOrdering(Ordering o)

getFragment

public FragmentDescriptor getFragment(Resource jar)

getFragment

public FragmentDescriptor getFragment(String name)

getJarForFragment

public Resource getJarForFragment(String name)

getNamedFragments

public Map<String,FragmentDescriptor> getNamedFragments()

getOrigin

public Origin getOrigin(String name)

getOriginInfo

public MetaData.OriginInfo getOriginInfo(String name)

getOriginDescriptor

public Descriptor getOriginDescriptor(String name)

setOrigin

public void setOrigin(String name,
                      Descriptor d)

setOrigin

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

setOriginAPI

public void setOriginAPI(String name)

isMetaDataComplete

public boolean isMetaDataComplete()

addWebInfJar

public void addWebInfJar(Resource newResource)

getWebInfJars

public List<Resource> getWebInfJars()

getContainerResources

public List<Resource> getContainerResources()

addContainerResource

public void addContainerResource(Resource jar)

setWebInfClassesDirs

public void setWebInfClassesDirs(List<Resource> dirs)

getWebInfClassesDirs

public List<Resource> getWebInfClassesDirs()

isAllowDuplicateFragmentNames

public boolean isAllowDuplicateFragmentNames()

setAllowDuplicateFragmentNames

public void setAllowDuplicateFragmentNames(boolean allowDuplicateFragmentNames)

isValidateXml

public boolean isValidateXml()

Returns:

the validateXml

setValidateXml

public void setValidateXml(boolean validateXml)

Parameters:

validateXml - the validateXml to set

getOrigins

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