org.eclipse.jetty.webapp
Class MetaData

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

public class MetaData
extends Object

MetaData

Nested Class Summary

class	MetaData.AbsoluteOrdering AbsoluteOrdering An element in web.xml
static interface	MetaData.Ordering Ordering
static class	MetaData.Origin
static class	MetaData.OriginInfo
class	MetaData.RelativeOrdering RelativeOrdering A set of elements in web-fragment.xmls.

Field Summary

protected List<DiscoveredAnnotation>	_annotations
protected WebAppContext	_context
protected List<DescriptorProcessor>	_descriptorProcessors
protected List<Resource>	_orderedResources
protected MetaData.Ordering	_ordering
protected Map<String,MetaData.OriginInfo>	_origins
protected StandardDescriptorProcessor	_standardDescriptorProcessor
protected Descriptor	_webDefaultsRoot
protected Map<Resource,List<DiscoveredAnnotation>>	_webFragmentAnnotations
protected Map<String,FragmentDescriptor>	_webFragmentNameMap
protected Map<Resource,FragmentDescriptor>	_webFragmentResourceMap
protected List<FragmentDescriptor>	_webFragmentRoots
protected Descriptor	_webOverrideRoot
protected Descriptor	_webXmlRoot
static String	METADATA
static String	METADATA_COMPLETE
static String	WEBXML_CLASSNAMES
static String	WEBXML_MAJOR_VERSION
static String	WEBXML_MINOR_VERSION

Constructor Summary

MetaData(WebAppContext context)

Method Summary

void	addDescriptorProcessor(DescriptorProcessor p)
void	addDiscoveredAnnotations(List<DiscoveredAnnotation> annotations) Annotations not associated with a WEB-INF/lib fragment jar.
void	addDiscoveredAnnotations(Resource resource, List<DiscoveredAnnotation> annotations)
void	addFragment(Resource jarResource, Resource xmlResource) Add a web-fragment.xml
WebAppContext	getContext()
FragmentDescriptor	getFragment(Resource jar)
FragmentDescriptor	getFragment(String name)
List<FragmentDescriptor>	getFragments()
Resource	getJarForFragment(String name)
Map<String,FragmentDescriptor>	getNamedFragments()
List<FragmentDescriptor>	getOrderedFragments()
List<Resource>	getOrderedResources()
MetaData.Ordering	getOrdering()
MetaData.Origin	getOrigin(String name)
Descriptor	getOriginDescriptor(String name)
Descriptor	getOverrideWeb()
Descriptor	getWebDefault()
Descriptor	getWebXml()
boolean	isDistributable()
void	orderFragments()
void	resolve() Resolve all servlet/filter/listener metadata from all sources: descriptors and annotations.
void	setDefaults(Resource webDefaults)
void	setOrdering(MetaData.Ordering o)
void	setOrigin(String name)
void	setOrigin(String name, Descriptor d)
void	setOverride(Resource override)
void	setWebXml(Resource webXml)

Methods inherited from class java.lang.Object

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

Field Detail

METADATA

public static final String METADATA

See Also:

Constant Field Values

METADATA_COMPLETE

public static final String METADATA_COMPLETE

See Also:

Constant Field Values

WEBXML_MAJOR_VERSION

public static final String WEBXML_MAJOR_VERSION

See Also:

Constant Field Values

WEBXML_MINOR_VERSION

public static final String WEBXML_MINOR_VERSION

See Also:

Constant Field Values

WEBXML_CLASSNAMES

public static final String WEBXML_CLASSNAMES

See Also:

Constant Field Values

_context

protected WebAppContext _context

_origins

protected Map<String,MetaData.OriginInfo> _origins

_webDefaultsRoot

protected Descriptor _webDefaultsRoot

_webXmlRoot

protected Descriptor _webXmlRoot

_webOverrideRoot

protected Descriptor _webOverrideRoot

_annotations

protected List<DiscoveredAnnotation> _annotations

_descriptorProcessors

protected List<DescriptorProcessor> _descriptorProcessors

_webFragmentRoots

protected List<FragmentDescriptor> _webFragmentRoots

_webFragmentNameMap

protected Map<String,FragmentDescriptor> _webFragmentNameMap

_webFragmentResourceMap

protected Map<Resource,FragmentDescriptor> _webFragmentResourceMap

_webFragmentAnnotations

protected Map<Resource,List<DiscoveredAnnotation>> _webFragmentAnnotations

_orderedResources

protected List<Resource> _orderedResources

_ordering

protected MetaData.Ordering _ordering

_standardDescriptorProcessor

protected StandardDescriptorProcessor _standardDescriptorProcessor

Constructor Detail

MetaData

public MetaData(WebAppContext context)
         throws ClassNotFoundException

Throws:

ClassNotFoundException

Method Detail

getContext

public WebAppContext getContext()

setDefaults

public void setDefaults(Resource webDefaults)
                 throws Exception

Throws:

Exception

setWebXml

public void setWebXml(Resource webXml)
               throws Exception

Throws:

Exception

setOverride

public void setOverride(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

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 -

addDiscoveredAnnotations

public void addDiscoveredAnnotations(Resource resource,
                                     List<DiscoveredAnnotation> annotations)

addDescriptorProcessor

public void addDescriptorProcessor(DescriptorProcessor p)

orderFragments

public void orderFragments()

resolve

public void resolve()
             throws Exception

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

Throws:

Exception

isDistributable

public boolean isDistributable()

getWebXml

public Descriptor getWebXml()

getOverrideWeb

public Descriptor getOverrideWeb()

getWebDefault

public Descriptor getWebDefault()

getFragments

public List<FragmentDescriptor> getFragments()

getOrderedResources

public List<Resource> getOrderedResources()

getOrderedFragments

public List<FragmentDescriptor> getOrderedFragments()

getOrdering

public MetaData.Ordering getOrdering()

setOrdering

public void setOrdering(MetaData.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 MetaData.Origin getOrigin(String name)

getOriginDescriptor

public Descriptor getOriginDescriptor(String name)

setOrigin

public void setOrigin(String name,
                      Descriptor d)

setOrigin

public void setOrigin(String name)