Package com.atlassian.plugin.osgi.container.impl

Class DefaultPackageScannerConfiguration

java.lang.Object

com.atlassian.plugin.osgi.container.impl.DefaultPackageScannerConfiguration

All Implemented Interfaces:

PackageScannerConfiguration

public class DefaultPackageScannerConfiguration
extends Object
implements PackageScannerConfiguration

Default package scanner configuration. Probably mostly useful for Spring XML configuration.

Constructor Summary

Constructors

Constructor	Description
DefaultPackageScannerConfiguration()
DefaultPackageScannerConfiguration(String hostVersion)

Method Summary

Modifier and Type	Method	Description
Set<String>	getApplicationBundledInternalPlugins()
String	getCurrentHostVersion()
List<String>	getJarExcludes()
List<String>	getJarIncludes()
Set<String>	getOsgiDeprecatedPackages()
Set<String>	getOsgiPublicPackages()
Set<String>	getOsgiPublicPackagesExcludes()
List<String>	getPackageExcludes()
List<String>	getPackageIncludes()
Map<String,String>	getPackageVersions()
javax.servlet.ServletContext	getServletContext()
void	setApplicationBundledInternalPlugins(Set<String> applicationBundledInternalPlugins)
void	setDeprecatedPackages(Set<String> deprecatedPackages)
void	setJarExcludes(List<String> jarExcludes)
void	setJarIncludes(List<String> jarIncludes)
void	setJarPatterns(List<String> includes, List<String> excludes)	Sets the jars to include and exclude from scanning
void	setOsgiPublicPackages(Set<String> osgiPublicPackages)
void	setOsgiPublicPackagesExcludes(Set<String> osgiPublicPackagesExcludes)
void	setPackageExcludes(List<String> packageExcludes)
void	setPackageIncludes(List<String> packageIncludes)
void	setPackagePatterns(List<String> includes, List<String> excludes)	Sets the packages to include and exclude
void	setPackageVersions(Map<String,String> packageToVersions)	Maps discovered packages to specific versions by overriding autodiscovered versions
void	setServletContext(javax.servlet.ServletContext servletContext)
void	setTreatDeprecatedPackagesAsPublic(boolean treatDeprecatedPackagesAsPublic)
boolean	treatDeprecatedPackagesAsPublic()

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultPackageScannerConfiguration

public DefaultPackageScannerConfiguration()

DefaultPackageScannerConfiguration

public DefaultPackageScannerConfiguration(String hostVersion)

Parameters:

hostVersion - The current host application version

Since:

2.2

Method Details

setJarIncludes

public void setJarIncludes(List<String> jarIncludes)

setJarExcludes

public void setJarExcludes(List<String> jarExcludes)

setPackageIncludes

public void setPackageIncludes(List<String> packageIncludes)

setPackageExcludes

public void setPackageExcludes(List<String> packageExcludes)

setDeprecatedPackages

public void setDeprecatedPackages(Set<String> deprecatedPackages)

Since:

7.3

setTreatDeprecatedPackagesAsPublic

public void setTreatDeprecatedPackagesAsPublic(boolean treatDeprecatedPackagesAsPublic)

Since:

7.3

setJarPatterns

public void setJarPatterns(List<String> includes,
 List<String> excludes)

Sets the jars to include and exclude from scanning

Parameters:

includes - A list of jar patterns to include

excludes - A list of jar patterns to exclude

setPackagePatterns

public void setPackagePatterns(List<String> includes,
 List<String> excludes)

Sets the packages to include and exclude

Parameters:

includes - A list of patterns to include

excludes - A list of patterns to exclude

setPackageVersions

public void setPackageVersions(Map<String,String> packageToVersions)

Maps discovered packages to specific versions by overriding autodiscovered versions

Parameters:

packageToVersions - A map of package patterns to version strings

setOsgiPublicPackages

public void setOsgiPublicPackages(Set<String> osgiPublicPackages)

setOsgiPublicPackagesExcludes

public void setOsgiPublicPackagesExcludes(Set<String> osgiPublicPackagesExcludes)

setApplicationBundledInternalPlugins

public void setApplicationBundledInternalPlugins(Set<String> applicationBundledInternalPlugins)

getJarIncludes

public List<String> getJarIncludes()

Specified by:

getJarIncludes in interface PackageScannerConfiguration

Returns:

The jar patterns to include

getJarExcludes

public List<String> getJarExcludes()

Specified by:

getJarExcludes in interface PackageScannerConfiguration

Returns:

The jar patterns to exclude

getPackageIncludes

public List<String> getPackageIncludes()

Specified by:

getPackageIncludes in interface PackageScannerConfiguration

Returns:

The package patterns to include

getPackageExcludes

public List<String> getPackageExcludes()

Specified by:

getPackageExcludes in interface PackageScannerConfiguration

Returns:

The package patterns to exclude

getPackageVersions

public Map<String,String> getPackageVersions()

Specified by:

getPackageVersions in interface PackageScannerConfiguration

Returns:

A map of package patterns and their versions

getCurrentHostVersion

public String getCurrentHostVersion()

Specified by:

getCurrentHostVersion in interface PackageScannerConfiguration

Returns:

The current host application version number. Used as a caching key for scanned data.

getServletContext

public javax.servlet.ServletContext getServletContext()

Specified by:

getServletContext in interface PackageScannerConfiguration

Returns:

The servlet context to use to scan for jars, in case the classloader scanning fails

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

getOsgiPublicPackages

public Set<String> getOsgiPublicPackages()

Specified by:

getOsgiPublicPackages in interface PackageScannerConfiguration

getOsgiPublicPackagesExcludes

public Set<String> getOsgiPublicPackagesExcludes()

Specified by:

getOsgiPublicPackagesExcludes in interface PackageScannerConfiguration

getOsgiDeprecatedPackages

public Set<String> getOsgiDeprecatedPackages()

Specified by:

getOsgiDeprecatedPackages in interface PackageScannerConfiguration

Since:

7.3

treatDeprecatedPackagesAsPublic

public boolean treatDeprecatedPackagesAsPublic()

Specified by:

treatDeprecatedPackagesAsPublic in interface PackageScannerConfiguration

Since:

7.3

getApplicationBundledInternalPlugins

public Set<String> getApplicationBundledInternalPlugins()

Specified by:

getApplicationBundledInternalPlugins in interface PackageScannerConfiguration