org.apache.webbeans.corespi.scanner

Class AbstractMetaDataDiscovery

java.lang.Object

org.apache.webbeans.corespi.scanner.AbstractMetaDataDiscovery

All Implemented Interfaces:

ScannerService

Direct Known Subclasses:

DefaultScannerService, OpenWebBeansTestMetaDataDiscoveryService, WebScannerService

public abstract class AbstractMetaDataDiscovery
extends Object
implements ScannerService

Field Summary

Fields

Modifier and Type	Field and Description
protected CdiArchive	archive
protected BDABeansXmlScanner	bdaBeansXmlScanner
protected org.apache.xbean.finder.AnnotationFinder	finder
protected boolean	isBDAScannerEnabled
protected ClassLoader	loader
protected static Logger	logger
static String	META_INF_BEANS_XML

Constructor Summary

Constructors

Constructor and Description
AbstractMetaDataDiscovery()

Method Summary

Modifier and Type	Method and Description
protected void	addWebBeansXmlLocation(URL beansXmlUrl) add the given beans.xml path to the locations list
protected abstract void	configure()
protected String[]	findBeansXmlBases(String resourceName, ClassLoader loader) Find the base paths of all available resources with the given resourceName in the classpath.
Set<String>	getAllAnnotations(String className)
BDABeansXmlScanner	getBDABeansXmlScanner() Gets BDABeansXMLScanner used to determine the beans.xml modifiers (interceptors, decorators, and, alternatives) that are enabled per BDA.
Set<Class<?>>	getBeanClasses() Gets beans classes that are found in the deployment archives.
Set<URL>	getBeanXmls() Gets xml configuration files that are occured in the deployment archives.
protected Iterable<URL>	getUrls()
void	init(Object object) Any initializtion action that is required by the implementors.
protected org.apache.xbean.finder.AnnotationFinder	initFinder()
boolean	isBDABeansXmlScanningEnabled() Indicates if BDABeansXmlScanner is available.
void	release() This method will get called once the information found by the current scan is not needed anymore and the ScannerService might free up resources.
void	scan() Configure the Web Beans Container with deployment information and fills annotation database and beans.xml stream database.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final Logger logger

META_INF_BEANS_XML

public static final String META_INF_BEANS_XML

See Also:

Constant Field Values

loader

protected ClassLoader loader

archive

protected CdiArchive archive

finder

protected org.apache.xbean.finder.AnnotationFinder finder

isBDAScannerEnabled

protected boolean isBDAScannerEnabled

bdaBeansXmlScanner

protected BDABeansXmlScanner bdaBeansXmlScanner

Constructor Detail

AbstractMetaDataDiscovery

public AbstractMetaDataDiscovery()

Method Detail

initFinder

protected org.apache.xbean.finder.AnnotationFinder initFinder()

getUrls

protected Iterable<URL> getUrls()

scan

public void scan()
          throws WebBeansDeploymentException

Configure the Web Beans Container with deployment information and fills annotation database and beans.xml stream database.

Specified by:

scan in interface ScannerService

Throws:

WebBeansConfigurationException - if any run time exception occurs

WebBeansDeploymentException

release

public void release()

Description copied from interface: ScannerService

This method will get called once the information found by the current scan is not needed anymore and the ScannerService might free up resources.

Specified by:

release in interface ScannerService

configure

protected abstract void configure()

findBeansXmlBases

protected String[] findBeansXmlBases(String resourceName,
                                     ClassLoader loader)

Find the base paths of all available resources with the given resourceName in the classpath. The returned Strings will NOT contain the resourceName itself!

Parameters:

resourceName - the name of the resource, e.g. 'META-INF/beans.xml'

loader - the ClassLoader which should be used

Returns:

array of Strings with the URL path to the resources.

init

public void init(Object object)

Description copied from interface: ScannerService

Any initializtion action that is required by the implementors.

Specified by:

init in interface ScannerService

Parameters:

object - initialization object

getAllAnnotations

public Set<String> getAllAnnotations(String className)

addWebBeansXmlLocation

protected void addWebBeansXmlLocation(URL beansXmlUrl)

add the given beans.xml path to the locations list

Parameters:

beansXmlUrl - location path

getBeanClasses

public Set<Class<?>> getBeanClasses()

Description copied from interface: ScannerService

Gets beans classes that are found in the deployment archives.

Specified by:

getBeanClasses in interface ScannerService

Returns:

bean classes

getBeanXmls

public Set<URL> getBeanXmls()

Description copied from interface: ScannerService

Gets xml configuration files that are occured in the deployment archives.

Specified by:

getBeanXmls in interface ScannerService

Returns:

the URL of the beans.xml files.

getBDABeansXmlScanner

public BDABeansXmlScanner getBDABeansXmlScanner()

Description copied from interface: ScannerService

Gets BDABeansXMLScanner used to determine the beans.xml modifiers (interceptors, decorators, and, alternatives) that are enabled per BDA. This is different from the default behavior that enables modifiers per application and not just in one BDA contained in an application.

Specified by:

getBDABeansXmlScanner in interface ScannerService

Returns:

null or reference to BDABeansXMLScanner

isBDABeansXmlScanningEnabled

public boolean isBDABeansXmlScanningEnabled()

Description copied from interface: ScannerService

Indicates if BDABeansXmlScanner is available. This method should only return true if a BDABeansXmlScanner is implemented and the OpenWebBeansConfiguration.USE_BDA_BEANSXML_SCANNER custom property is set to true.

Specified by:

isBDABeansXmlScanningEnabled in interface ScannerService

Returns:

T - BDABeansXmlScanner is available and enabled; F - No BDABeansXmlScanner is available or it is disabled