com.sun.faces.spi.AnnotationProvider Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.faces.spi;
import javax.servlet.ServletContext;
import java.lang.annotation.Annotation;
import java.net.URI;
import java.util.Set;
import java.util.Map;
/**
*
* An integration point for integrators to provide custom annotation scanning.
*
*
*
* All AnnotationProvider implementations must
* scan for the following annotations:
*
*
* - FacesComponent
* - FacesConverter
* - FacesRenderer
* - FacesValidator
* - ManagedBean
* - NamedEvent
* - FacesBehavior
* - FacesBehaviorRenderer
*
*
*
* The AnnotationProvider instance will be wrapped as a {@link java.util.concurrent.Future} and
* executed during the environment initialization. The result of the future can be obtained
* by calling {@link com.sun.faces.config.ConfigManager#getAnnotatedClasses(javax.faces.context.FacesContext)}.
*
*
*
* The {@link java.util.concurrent.Future} itself can be obtained from the
* application map using the key com.sun.faces.config.ConfigManager__ANNOTATION_SCAN_TASK.
*
*
*
* It's important to note that the value returned by either method described above
* is only available while the application is being initialized and will be removed
* before the application is put into service.
*
*
*
* To register a custom AnnotationProvider with the runtime, place a file named
* com.sun.faces.spi.annotationprovider within META-INF/services of a JAR file,
* with a single line referencing the fully qualified class name of the AnnotationProvider
* implementation. Custom AnnotationProviders can be used to decorate the default
* AnnotationProvider by providing a constructor that takes an AnnotationProvider as the
* second parameter:
*
* public AnnotationProvider(ServletContext sc, AnnotationProvider parent)
*
* If decoration is not desired, then the custom provider must have a constructor
* that takes one paramer, a ServletContext:
*
*
public AnnotationProvider(ServletContext sc)
*
* All customer providers must extend this class.
*
*/
public abstract class AnnotationProvider {
protected ServletContext sc;
// ------------------------------------------------------------ Constructors
public AnnotationProvider(ServletContext sc) {
this.sc = sc;
}
// ---------------------------------------------------------- Public Methods
/**
* @param urls a Set of URLs that refer to specific faces-config.xml
* documents on the classpath. The information returned by the map may
* return annotation information from sources outside of those defined by the
* urls.
* @return a Map of classes mapped to a specific annotation type.
* If no annotations are present, this method returns an empty Map.
*/
public abstract Map,Set>> getAnnotatedClasses(Set urls);
} // END AnnotationProvider