org.eclipse.jetty.osgi.annotations

Class AnnotationConfiguration

java.lang.Object

org.eclipse.jetty.webapp.AbstractConfiguration

org.eclipse.jetty.annotations.AnnotationConfiguration

org.eclipse.jetty.osgi.annotations.AnnotationConfiguration

All Implemented Interfaces:

Configuration

public class AnnotationConfiguration
extends AnnotationConfiguration

Extend the AnnotationConfiguration to support OSGi: Look for annotations inside WEB-INF/lib and also in the fragments and required bundles. Discover them using a scanner adapted to OSGi instead of the jarscanner.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AnnotationConfiguration.BundleParserTask

Nested classes/interfaces inherited from class org.eclipse.jetty.annotations.AnnotationConfiguration

AnnotationConfiguration.ClassInheritanceMap, AnnotationConfiguration.ContainerClassNameResolver, AnnotationConfiguration.ParserTask, AnnotationConfiguration.ServletContainerInitializerComparator, AnnotationConfiguration.ServletContainerInitializerOrdering, AnnotationConfiguration.TimeStatistic, AnnotationConfiguration.WebAppClassNameResolver

Nested classes/interfaces inherited from interface org.eclipse.jetty.webapp.Configuration

Configuration.ClassList

Field Summary

Fields inherited from class org.eclipse.jetty.annotations.AnnotationConfiguration

_classInheritanceHandler, _containerClassNameResolver, _containerInitializerAnnotationHandlers, _containerPathStats, _discoverableAnnotationHandlers, _parserTasks, _sciExcludePattern, _webAppClassNameResolver, _webInfClassesStats, _webInfLibStats, CLASS_INHERITANCE_MAP, CONTAINER_INITIALIZER_STARTER, CONTAINER_INITIALIZERS, DEFAULT_MAX_SCAN_WAIT, DEFAULT_MULTI_THREADED, MAX_SCAN_WAIT, MULTI_THREADED, SERVLET_CONTAINER_INITIALIZER_EXCLUSION_PATTERN, SERVLET_CONTAINER_INITIALIZER_ORDER

Fields inherited from interface org.eclipse.jetty.webapp.Configuration

ATTR

Constructor Summary

Constructors

Constructor and Description
AnnotationConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
protected AnnotationParser	createAnnotationParser() This parser scans the bundles using the OSGi APIs instead of assuming a jar.
protected ClassNameResolver	createClassNameResolver(WebAppContext context) Returns the same classname resolver than for the webInfjar scanner
protected ClassNameResolver	createClassNameResolver(WebAppContext context, boolean excludeSysClass, boolean excludeServerClass, boolean excludeEverythingElse, boolean overrideIsParenLoaderIsPriority)
protected void	parseBundle(WebAppContext context, AnnotationParser parser, org.osgi.framework.Bundle webbundle, org.osgi.framework.Bundle bundle)
protected void	parseFragmentBundle(WebAppContext context, AnnotationParser parser, org.osgi.framework.Bundle webbundle, org.osgi.framework.Bundle fragmentBundle) Scan a fragment bundle for servlet annotations
protected void	parseRequiredBundle(WebAppContext context, AnnotationParser parser, org.osgi.framework.Bundle webbundle, org.osgi.framework.Bundle requiredBundle) Scan a bundle required by the webbundle for servlet annotations
protected void	parseWebBundle(WebAppContext context, AnnotationParser parser, org.osgi.framework.Bundle webbundle) Scan a bundle required by the webbundle for servlet annotations
void	parseWebInfLib(WebAppContext context, AnnotationParser parser) Here is the order in which jars and osgi artifacts are scanned for discoverable annotations.

Methods inherited from class org.eclipse.jetty.annotations.AnnotationConfiguration

addDiscoverableAnnotationHandler, cloneConfigure, configure, createServletContainerInitializerAnnotationHandlers, deconfigure, getFragmentFromJar, getInitializerOrdering, getJarFor, getMaxScanWait, getNonExcludedInitializers, isFromContainerClassPath, isFromExcludedJar, isMetaDataComplete, isUseMultiThreading, matchesExclusionPattern, parseContainerPath, parseWebInfClasses, postConfigure, preConfigure, scanForAnnotations

Methods inherited from class org.eclipse.jetty.webapp.AbstractConfiguration

destroy

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationConfiguration

public AnnotationConfiguration()

Method Detail

createAnnotationParser

protected AnnotationParser createAnnotationParser()

This parser scans the bundles using the OSGi APIs instead of assuming a jar.

Overrides:

createAnnotationParser in class AnnotationConfiguration

Returns:

a new AnnotationParser. This method can be overridden to use a different implementation of the AnnotationParser. Note that this is considered internal API.

parseWebInfLib

public void parseWebInfLib(WebAppContext context,
                  AnnotationParser parser)
                    throws Exception

Here is the order in which jars and osgi artifacts are scanned for discoverable annotations.

1. The container jars are scanned.
2. The WEB-INF/classes are scanned
3. The osgi fragment to the web bundle are parsed.
4. The WEB-INF/lib are scanned
5. The required bundles are parsed

Overrides:

parseWebInfLib in class AnnotationConfiguration

Throws:

Exception

parseFragmentBundle

protected void parseFragmentBundle(WebAppContext context,
                       AnnotationParser parser,
                       org.osgi.framework.Bundle webbundle,
                       org.osgi.framework.Bundle fragmentBundle)
                            throws Exception

Scan a fragment bundle for servlet annotations

Parameters:

context - The webapp context

parser - The parser

webbundle - The current webbundle

fragmentBundle - The OSGi fragment bundle to scan

Throws:

Exception

parseWebBundle

protected void parseWebBundle(WebAppContext context,
                  AnnotationParser parser,
                  org.osgi.framework.Bundle webbundle)
                       throws Exception

Scan a bundle required by the webbundle for servlet annotations

Parameters:

context - The webapp context

parser - The parser

webbundle - The current webbundle

fragmentBundle - The OSGi required bundle to scan

Throws:

Exception

parseRequiredBundle

protected void parseRequiredBundle(WebAppContext context,
                       AnnotationParser parser,
                       org.osgi.framework.Bundle webbundle,
                       org.osgi.framework.Bundle requiredBundle)
                            throws Exception

Scan a bundle required by the webbundle for servlet annotations

Parameters:

context - The webapp context

parser - The parser

webbundle - The current webbundle

fragmentBundle - The OSGi required bundle to scan

Throws:

Exception

parseBundle

protected void parseBundle(WebAppContext context,
               AnnotationParser parser,
               org.osgi.framework.Bundle webbundle,
               org.osgi.framework.Bundle bundle)
                    throws Exception

Throws:

Exception

createClassNameResolver

protected ClassNameResolver createClassNameResolver(WebAppContext context)

Returns the same classname resolver than for the webInfjar scanner

Parameters:

context -

Returns:

createClassNameResolver

protected ClassNameResolver createClassNameResolver(WebAppContext context,
                                        boolean excludeSysClass,
                                        boolean excludeServerClass,
                                        boolean excludeEverythingElse,
                                        boolean overrideIsParenLoaderIsPriority)