Package org.apache.webbeans.corespi.scanner

Class AbstractMetaDataDiscovery

java.lang.Object

org.apache.webbeans.corespi.scanner.AbstractMetaDataDiscovery

All Implemented Interfaces:

BdaScannerService, ScannerService

Direct Known Subclasses:

DefaultScannerService, OpenWebBeansTestMetaDataDiscoveryService

public abstract class AbstractMetaDataDiscovery
extends Object
implements BdaScannerService

Field Summary

Fields

Modifier and Type	Field	Description
protected CdiArchive	archive
protected BDABeansXmlScanner	bdaBeansXmlScanner
protected OwbAnnotationFinder	finder
protected boolean	isBDAScannerEnabled
protected ClassLoader	loader
protected static Logger	logger
static String	META_INF_BEANS_XML
protected String[]	scanningExcludes
protected WebBeansContext	webBeansContext

Constructor Summary

Constructors

Constructor	Description
AbstractMetaDataDiscovery()

Method Summary

Modifier and Type	Method	Description
protected void	addDeploymentUrl(String beansXml, URL cpUrl)	Add an URL for a deployment later on
protected void	addWebBeansXmlLocation(URL beanArchiveUrl)	add the given beans.xml path to the locations list
protected abstract void	configure()
protected void	doAddWebBeansXmlLocation(URL beanArchiveUrl)
protected void	filterExcludedJars(Set<URL> classPathUrls)
protected org.apache.xbean.finder.archive.Archive	getAdditionalArchive()
BDABeansXmlScanner	getBDABeansXmlScanner()
protected Iterable<URL>	getBeanArchiveUrls()	Deprecated. just here for backward compat reasons
Set<Class<?>>	getBeanClasses()
Map<BeanArchiveService.BeanArchiveInformation,Set<Class<?>>>	getBeanClassesPerBda()	This method only gets called if the initialisation is done already.
Map<String,URL>	getBeanDeploymentUrls()
Set<URL>	getBeanXmls()
void	init(Object object)
protected org.apache.xbean.finder.AnnotationFinder	initFinder()
void	initScanningExcludes()
boolean	isBDABeansXmlScanningEnabled()
protected boolean	isBdaUrlEnabled(URL bdaUrl)	This method could filter out known JARs or even JVM classpaths which shall not be considered bean archives.
protected boolean	isBeanAnnotatedClass(org.apache.xbean.finder.AnnotationFinder.ClassInfo classInfo)	This method is called for classes from bean archives with bean-discovery-mode 'annotated'.
protected boolean	isBeanAnnotation(org.apache.xbean.finder.AnnotationFinder.AnnotationInfo annotationInfo)
protected int	isExcludedJar(String path)
protected boolean	isExcludedJar(URL url)
protected void	registerBeanArchives(ClassLoader loader)	Since CDI-1.1 this is actually more a 'findBdaBases' as it also picks up jars without marker file.
void	release()
void	scan()	Configure the Web Beans Container with deployment information and fills annotation database and beans.xml stream database.
protected String	stripProtocol(String urlPath)	Get rid of any protocol header from the url externalForm
protected Map<File,URL>	toFiles(Set<URL> classPathUrls)
protected WebBeansContext	webBeansContext()

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

scanningExcludes

protected String[] scanningExcludes

loader

protected ClassLoader loader

archive

protected CdiArchive archive

finder

protected OwbAnnotationFinder finder

isBDAScannerEnabled

protected boolean isBDAScannerEnabled

bdaBeansXmlScanner

protected BDABeansXmlScanner bdaBeansXmlScanner

webBeansContext

protected WebBeansContext webBeansContext

Constructor Detail

AbstractMetaDataDiscovery

public AbstractMetaDataDiscovery()

Method Detail

initFinder

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

getAdditionalArchive

protected org.apache.xbean.finder.archive.Archive getAdditionalArchive()

getBeanArchiveUrls

protected Iterable<URL> getBeanArchiveUrls()

Deprecated.

just here for backward compat reasons

Returns:

list of beans.xml locations or implicit bean archives

getBeanDeploymentUrls

public Map<String,URL> getBeanDeploymentUrls()

Returns:

URLs of all classpath entries which

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

configure

protected abstract void configure()

registerBeanArchives

protected void registerBeanArchives(ClassLoader loader)

Since CDI-1.1 this is actually more a 'findBdaBases' as it also picks up jars without marker file. This will register all 'explicit' Bean Archives, aka all META-INF/beans.xml resources on the classpath. Those will be added including the META-INF/beans.xml in the URL. We will also add all other classpath locations which do not have the beans.xml marker file, the 'implicit bean archives'. In this case the URL will point to the root of the classpath entry.

Parameters:

loader - the ClassLoader which should be used

See Also:

getBeanArchiveUrls(), getBeanDeploymentUrls()

toFiles

protected Map<File,URL> toFiles(Set<URL> classPathUrls)

stripProtocol

protected String stripProtocol(String urlPath)

Get rid of any protocol header from the url externalForm

Parameters:

urlPath -

filterExcludedJars

protected void filterExcludedJars(Set<URL> classPathUrls)

isExcludedJar

protected boolean isExcludedJar(URL url)

isExcludedJar

protected int isExcludedJar(String path)

release

public void release()

Specified by:

release in interface ScannerService

addDeploymentUrl

protected void addDeploymentUrl(String beansXml,
                                URL cpUrl)

Add an URL for a deployment later on

Parameters:

beansXml -

cpUrl -

isBdaUrlEnabled

protected boolean isBdaUrlEnabled(URL bdaUrl)

This method could filter out known JARs or even JVM classpaths which shall not be considered bean archives.

Returns:

whether the URL is a bean archive or not

init

public void init(Object object)

Specified by:

init in interface ScannerService

initScanningExcludes

public void initScanningExcludes()

addWebBeansXmlLocation

protected void addWebBeansXmlLocation(URL beanArchiveUrl)

add the given beans.xml path to the locations list

Parameters:

beanArchiveUrl - location path

doAddWebBeansXmlLocation

protected void doAddWebBeansXmlLocation(URL beanArchiveUrl)

getBeanClassesPerBda

public Map<BeanArchiveService.BeanArchiveInformation,Set<Class<?>>> getBeanClassesPerBda()

This method only gets called if the initialisation is done already. It will collect all the classes from all the BDAs it can find.

Specified by:

getBeanClassesPerBda in interface BdaScannerService

getBeanClasses

public Set<Class<?>> getBeanClasses()

Specified by:

getBeanClasses in interface ScannerService

isBeanAnnotatedClass

protected boolean isBeanAnnotatedClass(org.apache.xbean.finder.AnnotationFinder.ClassInfo classInfo)

This method is called for classes from bean archives with bean-discovery-mode 'annotated'. This method is intended to be overwritten in integration scenarios and e.g. allows to add other criterias for keeping the class.

Parameters:

classInfo -

Returns:

true if this class should be kept and further get picked up as CDI Bean

isBeanAnnotation

protected boolean isBeanAnnotation(org.apache.xbean.finder.AnnotationFinder.AnnotationInfo annotationInfo)

getBeanXmls

public Set<URL> getBeanXmls()

Specified by:

getBeanXmls in interface ScannerService

getBDABeansXmlScanner

public BDABeansXmlScanner getBDABeansXmlScanner()

Specified by:

getBDABeansXmlScanner in interface ScannerService

isBDABeansXmlScanningEnabled

public boolean isBDABeansXmlScanningEnabled()

Specified by:

isBDABeansXmlScanningEnabled in interface ScannerService

webBeansContext

protected WebBeansContext webBeansContext()