Package org.eclipse.jetty.ee10.osgi.boot

Class OSGiMetaInfConfiguration

java.lang.Object

org.eclipse.jetty.ee10.webapp.AbstractConfiguration

org.eclipse.jetty.ee10.webapp.MetaInfConfiguration

org.eclipse.jetty.ee10.osgi.boot.OSGiMetaInfConfiguration

All Implemented Interfaces:

Configuration

public class OSGiMetaInfConfiguration
extends MetaInfConfiguration

OSGiMetaInfConfiguration Handle adding resources found in bundles.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.ee10.webapp.AbstractConfiguration

AbstractConfiguration.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTAINER_BUNDLE_PATTERN	Regex of symbolic names of bundles that should be considered to be on the container classpath
static final String	FRAGMENT_AND_REQUIRED_BUNDLES
static final String	FRAGMENT_AND_REQUIRED_RESOURCES
static final String	SYS_PROP_TLD_BUNDLES	Comma separated list of symbolic names of bundles that contain tlds that should be considered as on the container classpath

Fields inherited from class org.eclipse.jetty.ee10.webapp.MetaInfConfiguration

__allScanTypes, CACHED_CONTAINER_FRAGMENTS, CACHED_CONTAINER_RESOURCES, CACHED_CONTAINER_TLDS, CONTAINER_JAR_PATTERN, DEFAULT_USE_CONTAINER_METAINF_CACHE, METAINF_FRAGMENTS, METAINF_RESOURCES, METAINF_TLDS, RESOURCE_DIRS, USE_CONTAINER_METAINF_CACHE, WEBINF_JAR_PATTERN

Constructor Summary

Constructors

Constructor	Description
OSGiMetaInfConfiguration()

Method Summary

Modifier and Type	Method	Description
void	configure(WebAppContext context)	Allow fragments to supply some resources that are added to the baseResource of the webapp.
protected List<Resource>	findJars(WebAppContext context)	Consider the fragment bundles associated with the bundle of the webapp being deployed.
void	postConfigure(WebAppContext context)	Clear down after configuration.
void	preConfigure(WebAppContext context)	Check to see if there have been any bundle symbolic names added of bundles that should be regarded as being on the container classpath, and scanned for fragments, tlds etc etc.
Class<? extends Configuration>	replaces()	Get a class that this class replaces/extends.
protected void	scanJars(WebAppContext context)

Methods inherited from class org.eclipse.jetty.ee10.webapp.MetaInfConfiguration

findAndFilterContainerPaths, findAndFilterWebAppPaths, findClassDirs, findExtraClasspathDirs, findExtraClasspathJars, findWebInfClassesDir, findWebInfLibJars, getAllContainerJars, scanForFragment, scanForResources, scanForTlds, scanJars, scanJars

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

abort, deconfigure, destroy, getDependencies, getDependents, getHiddenClasses, getProtectedClasses, isEnabledByDefault

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.ee10.webapp.Configuration

getServerClasses, getSystemClasses, isAvailable

Field Details

SYS_PROP_TLD_BUNDLES

public static final String SYS_PROP_TLD_BUNDLES

Comma separated list of symbolic names of bundles that contain tlds that should be considered as on the container classpath

See Also:

• Constant Field Values

CONTAINER_BUNDLE_PATTERN

public static final String CONTAINER_BUNDLE_PATTERN

Regex of symbolic names of bundles that should be considered to be on the container classpath

See Also:

• Constant Field Values

FRAGMENT_AND_REQUIRED_BUNDLES

public static final String FRAGMENT_AND_REQUIRED_BUNDLES

See Also:

• Constant Field Values

FRAGMENT_AND_REQUIRED_RESOURCES

public static final String FRAGMENT_AND_REQUIRED_RESOURCES

See Also:

• Constant Field Values

Constructor Details

OSGiMetaInfConfiguration

public OSGiMetaInfConfiguration()

Method Details

replaces

public Class<? extends Configuration> replaces()

Description copied from interface: Configuration

Get a class that this class replaces/extends. If this is added to Configurations collection that already contains a configuration of the replaced class or that reports to replace the same class, then it is replaced with this instance.

Returns:

The class this Configuration replaces/extends or null if it replaces no other configuration

preConfigure

public void preConfigure(WebAppContext context)
                  throws Exception

Check to see if there have been any bundle symbolic names added of bundles that should be regarded as being on the container classpath, and scanned for fragments, tlds etc etc. This can be defined in:

1. SystemProperty SYS_PROP_TLD_BUNDLES
2. DeployerManager.setContextAttribute CONTAINER_BUNDLE_PATTERN

We also allow individual bundles to specify particular bundles that might include TLDs via the Require-Tlds MANIFEST.MF header.

Specified by:

preConfigure in interface Configuration

Overrides:

preConfigure in class MetaInfConfiguration

Parameters:

context - The context to configure

Throws:

Exception - if unable to pre configure

See Also:

• WebInfConfiguration.preConfigure(org.eclipse.jetty.ee10.webapp.WebAppContext)

scanJars

protected void scanJars(WebAppContext context)
                 throws Exception

Overrides:

scanJars in class MetaInfConfiguration

Throws:

Exception

postConfigure

public void postConfigure(WebAppContext context)
                   throws Exception

Description copied from interface: Configuration

Clear down after configuration.

Specified by:

postConfigure in interface Configuration

Overrides:

postConfigure in class MetaInfConfiguration

Parameters:

context - The context to configure

Throws:

Exception - if unable to post configure

findJars

protected List<Resource> findJars(WebAppContext context)
                           throws Exception

Consider the fragment bundles associated with the bundle of the webapp being deployed.

Overrides:

findJars in class MetaInfConfiguration

Parameters:

context - the context to find the jars in

Returns:

the list of jar resources found within context

Throws:

Exception - if unable to find the jars

See Also:

• MetaInfConfiguration.findJars(org.eclipse.jetty.ee10.webapp.WebAppContext)

configure

public void configure(WebAppContext context)
               throws Exception

Allow fragments to supply some resources that are added to the baseResource of the webapp. The resources can be either prepended or appended to the baseResource.

Specified by:

configure in interface Configuration

Overrides:

configure in class MetaInfConfiguration

Parameters:

context - The context to configure

Throws:

Exception - if unable to configure

See Also:

• WebInfConfiguration.configure(org.eclipse.jetty.ee10.webapp.WebAppContext)