com.atlassian.plugin.main

Class PackageScannerConfigurationBuilder

java.lang.Object

com.atlassian.plugin.main.PackageScannerConfigurationBuilder

public class PackageScannerConfigurationBuilder
extends Object

The builder for PackageScannerConfiguration instances that additionally performs validation and default creation. For a usage example, see the package javadocs.

Not thread-safe. Instances of this class should be thread and preferably method local.

Since:

2.2

Constructor Summary

Constructors

Constructor and Description
PackageScannerConfigurationBuilder() Default constructor.
PackageScannerConfigurationBuilder(PackageScannerConfiguration packageScannerConfiguration) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
PackageScannerConfiguration	build() Builds a PackageScannerConfiguration instance by processing the configuration that was previously set and setting any defaults where not explicitly specified.
PackageScannerConfigurationBuilder	hostVersion(String... pkgs) Sets the current host version.
PackageScannerConfigurationBuilder	jarsToExclude(String... jars) Sets a list of jar expressions to hide from plugins.
PackageScannerConfigurationBuilder	jarsToInclude(String... jars) Sets a list of jar expressions to expose to plugins.
static PackageScannerConfigurationBuilder	packageScannerConfiguration() Static factory for creating a new builder.
PackageScannerConfigurationBuilder	packagesToExclude(String... pkgs) Sets a list of package expressions to hide from plugins.
PackageScannerConfigurationBuilder	packagesToInclude(String... pkgs) Sets a list of package expressions to expose to plugins.
PackageScannerConfigurationBuilder	packagesVersions(Map<String,String> packageToVersion) Sets which packages should be exposed as which versions.
PackageScannerConfigurationBuilder	servletContext(javax.servlet.ServletContext servletContext) Sets the ServletContext used to lookup jars as some application servers need it to lookup jar files.

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageScannerConfigurationBuilder

public PackageScannerConfigurationBuilder()

Default constructor. Uses a DefaultPackageScannerConfiguration as the template.

PackageScannerConfigurationBuilder

public PackageScannerConfigurationBuilder(PackageScannerConfiguration packageScannerConfiguration)

Copy constructor. Use the supplied PackageScannerConfiguration as a template.

Parameters:

packageScannerConfiguration -

Method Detail

packageScannerConfiguration

public static PackageScannerConfigurationBuilder packageScannerConfiguration()

Static factory for creating a new builder.

Returns:

a new builder.

hostVersion

public PackageScannerConfigurationBuilder hostVersion(String... pkgs)

Sets the current host version.

Parameters:

pkgs - A list of package expressions, where the '*' character matches any character including subpackages

Returns:

this

See Also:

PackageScannerConfiguration.getCurrentHostVersion()

servletContext

public PackageScannerConfigurationBuilder servletContext(javax.servlet.ServletContext servletContext)

Sets the ServletContext used to lookup jars as some application servers need it to lookup jar files.

Parameters:

pkgs - A list of package expressions, where the '*' character matches any character including subpackages

Returns:

this

See Also:

PackageScannerConfiguration#getS()

packagesToInclude

public PackageScannerConfigurationBuilder packagesToInclude(String... pkgs)

Sets a list of package expressions to expose to plugins.

Parameters:

pkgs - A list of package expressions, where the '*' character matches any character including subpackages

Returns:

this

See Also:

PackageScannerConfiguration.getPackageIncludes()

packagesToExclude

public PackageScannerConfigurationBuilder packagesToExclude(String... pkgs)

Sets a list of package expressions to hide from plugins.

Parameters:

pkgs - A list of package expressions, where the '*' character matches any character including subpackages

Returns:

this

See Also:

PackageScannerConfiguration.getPackageExcludes()

packagesVersions

public PackageScannerConfigurationBuilder packagesVersions(Map<String,String> packageToVersion)

Sets which packages should be exposed as which versions.

Parameters:

packageToVersion - A map of package names to version names. No wildcards allowed, and the version names must match the expected OSGi versioning scheme.

Returns:

this

See Also:

PackageScannerConfiguration.getPackageVersions()

jarsToInclude

public PackageScannerConfigurationBuilder jarsToInclude(String... jars)

Sets a list of jar expressions to expose to plugins.

Parameters:

pkgs - A list of package expressions, where the '*' character matches any character including subpackages

Returns:

this

See Also:

PackageScannerConfiguration.getJarIncludes()

jarsToExclude

public PackageScannerConfigurationBuilder jarsToExclude(String... jars)

Sets a list of jar expressions to hide from plugins.

Parameters:

pkgs - A list of package expressions, where the '*' character matches any character including subpackages

Returns:

this

See Also:

PackageScannerConfiguration.getPackageExcludes()

build

public PackageScannerConfiguration build()

Builds a PackageScannerConfiguration instance by processing the configuration that was previously set and setting any defaults where not explicitly specified.

Returns:

A valid PackageScannerConfiguration instance to pass to AtlassianPlugins