org.apache.webbeans.osgi.scanner

Class OsgiMetaDataScannerService

java.lang.Object

org.apache.webbeans.osgi.scanner.OsgiMetaDataScannerService

All Implemented Interfaces:

ScannerService

public class OsgiMetaDataScannerService
extends Object
implements ScannerService

In an OSGi environment, resources will not be delivered in jars or file URLs, but as 'bundle://'. This ScannerService parses for all classes in such a bundle.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.servlet.ServletContext	servletContext

Constructor Summary

Constructors

Constructor and Description
OsgiMetaDataScannerService()

Method Summary

Modifier and Type	Method and Description
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.
void	init(Object object) Any initializtion action that is required by the implementors.
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() Perform the actual class scanning.

Methods inherited from class java.lang.Object

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

Field Detail

servletContext

protected javax.servlet.ServletContext servletContext

Constructor Detail

OsgiMetaDataScannerService

public OsgiMetaDataScannerService()

Method Detail

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

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

scan

public void scan()
          throws WebBeansDeploymentException

Description copied from interface: ScannerService

Perform the actual class scanning.

Specified by:

scan in interface ScannerService

Throws:

WebBeansDeploymentException

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.

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

getAllAnnotations

public Set<String> getAllAnnotations(String className)

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