/jboss-as-7.1.1.Final/web/src/main/java/org/jboss/as/web/deployment/component/WebComponentProcessor.java
Java | 223 lines | 154 code | 17 blank | 52 comment | 59 complexity | da770451c7eea04dd11758cdc1c39b49 MD5 | raw file
Possible License(s): LGPL-2.1, Apache-2.0
- /*
- * JBoss, Home of Professional Open Source.
- * Copyright 2011, Red Hat, Inc., and individual contributors
- * as indicated by the @author tags. See the copyright.txt file in the
- * distribution for a full listing of individual contributors.
- *
- * This is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation; either version 2.1 of
- * the License, or (at your option) any later version.
- *
- * This software is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this software; if not, write to the Free
- * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
- */
- package org.jboss.as.web.deployment.component;
- import static org.jboss.as.web.WebMessages.MESSAGES;
- import org.jboss.as.ee.component.Attachments;
- import org.jboss.as.ee.component.ComponentDescription;
- import org.jboss.as.ee.component.EEApplicationClasses;
- import org.jboss.as.ee.component.EEModuleDescription;
- import org.jboss.as.ee.structure.DeploymentType;
- import org.jboss.as.ee.structure.DeploymentTypeMarker;
- import org.jboss.as.server.deployment.DeploymentPhaseContext;
- import org.jboss.as.server.deployment.DeploymentUnit;
- import org.jboss.as.server.deployment.DeploymentUnitProcessingException;
- import org.jboss.as.server.deployment.DeploymentUnitProcessor;
- import org.jboss.as.server.deployment.annotation.CompositeIndex;
- import org.jboss.as.web.deployment.TldsMetaData;
- import org.jboss.as.web.deployment.WarMetaData;
- import org.jboss.as.web.deployment.WebAttachments;
- import org.jboss.jandex.ClassInfo;
- import org.jboss.jandex.DotName;
- import org.jboss.metadata.web.spec.FilterMetaData;
- import org.jboss.metadata.web.spec.ListenerMetaData;
- import org.jboss.metadata.web.spec.ServletMetaData;
- import org.jboss.metadata.web.spec.TagMetaData;
- import org.jboss.metadata.web.spec.TldMetaData;
- import org.jboss.metadata.web.spec.WebCommonMetaData;
- import org.jboss.metadata.web.spec.WebFragmentMetaData;
- import org.jboss.metadata.web.spec.WebMetaData;
- import java.util.HashMap;
- import java.util.HashSet;
- import java.util.Map;
- import java.util.Set;
- import javax.servlet.AsyncListener;
- /**
- * Processor that figures out what type of component a servlet/listener is, and registers the appropriate metadata.
- * The different types are:
- * <ul>
- * <li>Managed Bean - If the servlet is annotated with the <code>ManagedBean</code> annotation</li>
- * <li>CDI Bean - If the servlet is deployed in a bean archive</li>
- * <li>EE Component - If this is an EE deployment and the servlet is not one of the above</li>
- * <li>Normal Servlet - If the EE subsystem is disabled</li>
- * </ul>
- * <p/>
- * For ManagedBean Servlets no action is necessary at this stage, as the servlet is already registered as a component.
- * For CDI and EE components a component definition is added to the deployment.
- * <p/>
- * For now we are just using managed bean components as servlets. We may need a custom component type in future.
- */
- public class WebComponentProcessor implements DeploymentUnitProcessor {
- /**
- * Tags in these packages do not need to be computerized
- */
- private static final String[] BUILTIN_TAGLIBS = {"org.apache.taglibs.standard", "com.sun.faces.taglib.jsf_core", "com.sun.faces.ext.taglib", "com.sun.faces.taglib.html_basic",};
- /**
- * Dotname for AsyncListener, which can be injected dynamically.
- */
- private static final DotName ASYNC_LISTENER_INTERFACE = DotName.createSimple(AsyncListener.class.getName());
- @Override
- public void deploy(DeploymentPhaseContext phaseContext) throws DeploymentUnitProcessingException {
- final DeploymentUnit deploymentUnit = phaseContext.getDeploymentUnit();
- if (!DeploymentTypeMarker.isType(DeploymentType.WAR, deploymentUnit)) {
- return;
- }
- final Map<String, ComponentDescription> componentByClass = new HashMap<String, ComponentDescription>();
- final Map<String, ComponentInstantiator> webComponents = new HashMap<String, ComponentInstantiator>();
- final EEModuleDescription moduleDescription = deploymentUnit.getAttachment(Attachments.EE_MODULE_DESCRIPTION);
- final EEApplicationClasses applicationClassesDescription = deploymentUnit.getAttachment(Attachments.EE_APPLICATION_CLASSES_DESCRIPTION);
- final CompositeIndex compositeIndex = deploymentUnit.getAttachment(org.jboss.as.server.deployment.Attachments.COMPOSITE_ANNOTATION_INDEX);
- final String applicationName = deploymentUnit.getParent() == null ? deploymentUnit.getName() : deploymentUnit.getParent().getName();
- if (moduleDescription == null) {
- return; //not an ee deployment
- }
- for (ComponentDescription component : moduleDescription.getComponentDescriptions()) {
- componentByClass.put(component.getComponentClassName(), component);
- }
- final WarMetaData warMetaData = deploymentUnit.getAttachment(WarMetaData.ATTACHMENT_KEY);
- final TldsMetaData tldsMetaData = deploymentUnit.getAttachment(TldsMetaData.ATTACHMENT_KEY);
- final Set<String> classes = getAllComponentClasses(deploymentUnit, compositeIndex, warMetaData, tldsMetaData);
- for (String clazz : classes) {
- if (clazz == null || clazz.trim().isEmpty()) {
- continue;
- }
- ComponentDescription description = componentByClass.get(clazz);
- if (description != null) {
- //for now just make sure it has a single view
- //this will generally be a managed bean, but it could also be an EJB
- //TODO: make sure the component is a managed bean
- if (!(description.getViews().size() == 1)) {
- throw MESSAGES.wrongComponentType(clazz);
- }
- ManagedBeanComponentInstantiator instantiator = new ManagedBeanComponentInstantiator(deploymentUnit, description);
- webComponents.put(clazz, instantiator);
- } else {
- //we do not make the standard tags into components, as there is no need
- if (compositeIndex.getClassByName(DotName.createSimple(clazz)) == null) {
- boolean found = false;
- for (String pack : BUILTIN_TAGLIBS) {
- if (clazz.startsWith(pack)) {
- found = true;
- break;
- }
- }
- if(found) {
- continue;
- }
- }
- description = new WebComponentDescription(clazz, clazz, moduleDescription, deploymentUnit.getServiceName(), applicationClassesDescription);
- moduleDescription.addComponent(description);
- webComponents.put(clazz, new WebComponentInstantiator(deploymentUnit, description));
- }
- }
- deploymentUnit.putAttachment(WebAttachments.WEB_COMPONENT_INSTANTIATORS, webComponents);
- }
- @Override
- public void undeploy(DeploymentUnit context) {
- }
- /**
- * Gets all classes that are eligible for injection etc
- *
- * @param metaData
- * @return
- */
- private Set<String> getAllComponentClasses(DeploymentUnit deploymentUnit, CompositeIndex index, WarMetaData metaData, TldsMetaData tldsMetaData) {
- final Set<String> classes = new HashSet<String>();
- if (metaData.getAnnotationsMetaData() != null)
- for (Map.Entry<String, WebMetaData> webMetaData : metaData.getAnnotationsMetaData().entrySet()) {
- getAllComponentClasses(webMetaData.getValue(), classes);
- }
- if (metaData.getSharedWebMetaData() != null)
- getAllComponentClasses(metaData.getSharedWebMetaData(), classes);
- if (metaData.getWebFragmentsMetaData() != null)
- for (Map.Entry<String, WebFragmentMetaData> webMetaData : metaData.getWebFragmentsMetaData().entrySet()) {
- getAllComponentClasses(webMetaData.getValue(), classes);
- }
- if (metaData.getWebMetaData() != null)
- getAllComponentClasses(metaData.getWebMetaData(), classes);
- if (tldsMetaData == null)
- return classes;
- if (tldsMetaData.getSharedTlds(deploymentUnit) != null)
- for (TldMetaData tldMetaData : tldsMetaData.getSharedTlds(deploymentUnit)) {
- getAllComponentClasses(tldMetaData, classes);
- }
- if (tldsMetaData.getTlds() != null)
- for (Map.Entry<String, TldMetaData> tldMetaData : tldsMetaData.getTlds().entrySet()) {
- getAllComponentClasses(tldMetaData.getValue(), classes);
- }
- getAllAsyncListenerClasses(index, classes);
- return classes;
- }
- private void getAllComponentClasses(WebCommonMetaData metaData, Set<String> classes) {
- if (metaData.getServlets() != null)
- for (ServletMetaData servlet : metaData.getServlets()) {
- if (servlet.getServletClass() != null) {
- classes.add(servlet.getServletClass());
- }
- }
- if (metaData.getFilters() != null)
- for (FilterMetaData filter : metaData.getFilters()) {
- classes.add(filter.getFilterClass());
- }
- if (metaData.getListeners() != null)
- for (ListenerMetaData listener : metaData.getListeners()) {
- classes.add(listener.getListenerClass());
- }
- }
- private void getAllComponentClasses(TldMetaData metaData, Set<String> classes) {
- if (metaData.getValidator() != null) {
- classes.add(metaData.getValidator().getValidatorClass());
- }
- if (metaData.getListeners() != null)
- for (ListenerMetaData listener : metaData.getListeners()) {
- classes.add(listener.getListenerClass());
- }
- if (metaData.getTags() != null)
- for (TagMetaData tag : metaData.getTags()) {
- classes.add(tag.getTagClass());
- }
- }
- private void getAllAsyncListenerClasses(CompositeIndex index, Set<String> classes) {
- if (index != null) {
- Set<ClassInfo> classInfos = index.getAllKnownImplementors(ASYNC_LISTENER_INTERFACE);
- for (ClassInfo classInfo : classInfos) {
- classes.add(classInfo.name().toString());
- }
- }
- }
- }