org.apache.myfaces.config.annotation
Class DefaultAnnotationProvider

java.lang.Object
  org.apache.myfaces.spi.AnnotationProvider
      org.apache.myfaces.config.annotation.DefaultAnnotationProvider

All Implemented Interfaces:

FacesWrapper<AnnotationProvider>

public class DefaultAnnotationProvider
extends AnnotationProvider

Since:

2.0.2

Author:

Leonardo Uribe

Field Summary

static String

SCAN_PACKAGES Servlet context init parameter which defines which packages to scan for beans, separated by commas.

Constructor Summary

DefaultAnnotationProvider()

Method Summary

Map<Class<? extends Annotation>,Set<Class<?>>>	getAnnotatedClasses(ExternalContext ctx) Retrieve a map containing the classes that contains annotations used by jsf implementation at startup.
protected Collection<Class<?>>	getAnnotatedMetaInfClasses(ExternalContext ctx, Set<URL> urls)
protected Collection<Class<?>>	getAnnotatedMyfacesImplClasses(ExternalContext ctx, URL url)
protected Collection<Class<?>>	getAnnotatedWebInfClasses(ExternalContext ctx)
Set<URL>	getBaseUrls() The returned Set<URL> urls are calculated in this way ( see JSF 2.0 spec section 11.4.2 for definitions )
Set<URL>	getBaseUrls(ExternalContext context) Same as getBaseUrls(), but with the ExternalContext reference.
protected Collection<Class<?>>	getGAEAnnotatedMetaInfClasses(ExternalContext context, String filter)

Methods inherited from class org.apache.myfaces.spi.AnnotationProvider

getWrapped

Methods inherited from class java.lang.Object

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

Field Detail

SCAN_PACKAGES

@JSFWebConfigParam(since="2.0")
public static final String SCAN_PACKAGES

Servlet context init parameter which defines which packages to scan for beans, separated by commas.

See Also:

Constant Field Values

Constructor Detail

DefaultAnnotationProvider

public DefaultAnnotationProvider()

Method Detail

getAnnotatedClasses

public Map<Class<? extends Annotation>,Set<Class<?>>> getAnnotatedClasses(ExternalContext ctx)

Description copied from class: AnnotationProvider

Retrieve a map containing the classes that contains annotations used by jsf implementation at startup.

The default implementation must comply with JSF 2.0 spec section 11.5.1 Requirements for scanning of classes for annotations.

This method could call getBaseUrls() to obtain a list of URL that could be used to indicate jar files of annotations in the classpath.

If the element in the WEB-INF/faces-config.xml file contains metadata-complete attribute whose value is "true", this method should not be called.

Specified by:

getAnnotatedClasses in class AnnotationProvider

Parameters:

ctx - The current ExternalContext

Returns:

A map with all classes that could contain annotations.

getBaseUrls

public Set<URL> getBaseUrls()
                     throws IOException

Description copied from class: AnnotationProvider

The returned Set<URL> urls are calculated in this way ( see JSF 2.0 spec section 11.4.2 for definitions )

1. All resources that match either "META-INF/faces-config.xml" or end with ".facesconfig.xml" directly in the "META-INF" directory (considered applicationConfigurationResources)

Specified by:

getBaseUrls in class AnnotationProvider

Returns:

Throws:

IOException

getBaseUrls

public Set<URL> getBaseUrls(ExternalContext context)
                     throws IOException

Description copied from class: AnnotationProvider

Same as getBaseUrls(), but with the ExternalContext reference. By default it calls to getBaseUrls()

Overrides:

getBaseUrls in class AnnotationProvider

Returns:

Throws:

IOException

getAnnotatedMetaInfClasses

protected Collection<Class<?>> getAnnotatedMetaInfClasses(ExternalContext ctx,
                                                          Set<URL> urls)

getGAEAnnotatedMetaInfClasses

protected Collection<Class<?>> getGAEAnnotatedMetaInfClasses(ExternalContext context,
                                                             String filter)

getAnnotatedMyfacesImplClasses

protected Collection<Class<?>> getAnnotatedMyfacesImplClasses(ExternalContext ctx,
                                                              URL url)

getAnnotatedWebInfClasses

protected Collection<Class<?>> getAnnotatedWebInfClasses(ExternalContext ctx)
                                                  throws IOException

Throws:

IOException