If necessary, install default jsf subsystem at end of profile xml parsing

Author: bstansberry

controller/src/main/java/org/jboss/as/controller/extension/ExtensionAddHandler.java

@@ -22,15 +22,11 @@
 import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OP;
 import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OP_ADDR;
 
-import java.util.Map;
-
 import org.jboss.as.controller.Extension;
 import org.jboss.as.controller.OperationContext;
 import org.jboss.as.controller.OperationFailedException;
 import org.jboss.as.controller.OperationStepHandler;
 import org.jboss.as.controller.PathAddress;
-import org.jboss.as.controller.ProcessType;
-import org.jboss.as.controller.services.path.PathManager;
 import org.jboss.dmr.ModelNode;
 import org.jboss.modules.Module;
 import org.jboss.modules.ModuleIdentifier;
@@ -73,6 +69,7 @@ public ExtensionAddHandler(final ExtensionRegistry extensionRegistry, final bool
     public void execute(OperationContext context, ModelNode operation) throws OperationFailedException {
         final String moduleName = PathAddress.pathAddress(operation.require(OP_ADDR)).getLastElement().getValue();
         ExtensionResource resource = new ExtensionResource(moduleName, extensionRegistry);
+
         context.addResource(PathAddress.EMPTY_ADDRESS, resource);
 
         if (!parallelBoot || !context.isBooting()) {
@@ -86,6 +83,7 @@ public void execute(OperationContext context, ModelNode operation) throws Operat
 
         context.completeStep(OperationContext.RollbackHandler.NOOP_ROLLBACK_HANDLER);
     }
+
     void initializeExtension(String module) throws OperationFailedException {
         try {
             for (Extension extension : Module.loadServiceFromCallerModuleLoader(ModuleIdentifier.fromString(module), Extension.class)) {

controller/src/main/java/org/jboss/as/controller/extension/ExtensionRegistry.java

@@ -41,6 +41,7 @@
 import org.jboss.as.controller.descriptions.ModelDescriptionConstants;
 import org.jboss.as.controller.descriptions.OverrideDescriptionProvider;
 import org.jboss.as.controller.parsing.ExtensionParsingContext;
+import org.jboss.as.controller.parsing.ProfileParsingCompletionHandler;
 import org.jboss.as.controller.persistence.SubsystemMarshallingContext;
 import org.jboss.as.controller.persistence.SubsystemXmlWriterRegistry;
 import org.jboss.as.controller.registry.AttributeAccess;
@@ -212,8 +213,6 @@ public ExtensionParsingContext getExtensionParsingContext(final String moduleNam
      *
      * @return  the {@link ExtensionContext}.  Will not return {@code null}
      *
-     * @param moduleName the name of the extension's module. Cannot be {@code null}
-     * @return the {@link ExtensionContext}.  Will not return {@code null}
      * @throws IllegalStateException if no {@link #setSubsystemParentResourceRegistrations(ManagementResourceRegistration, ManagementResourceRegistration)} profile resource registration has been set}
      */
     public ExtensionContext getExtensionContext(final String moduleName) {
@@ -245,6 +244,19 @@ public Set<String> getUnnamedNamespaces(final String moduleName) {
         return result;
     }
 
+    public Set<ProfileParsingCompletionHandler> getProfileParsingCompletionHandlers() {
+        Set<ProfileParsingCompletionHandler> result = new HashSet<ProfileParsingCompletionHandler>();
+
+        for (ExtensionInfo extensionInfo : extensions.values()) {
+            synchronized (extensionInfo) {
+                if (extensionInfo.parsingCompletionHandler != null) {
+                    result.add(extensionInfo.parsingCompletionHandler);
+                }
+            }
+        }
+        return Collections.unmodifiableSet(result);
+    }
+
     /**
      * Cleans up a module's subsystems from the resource registration model.
      *
@@ -419,13 +431,20 @@ public void setDeploymentXmlMapping(String namespaceUri, XMLElementReader<ModelN
         public void setDeploymentXmlMapping(String subsystemName, String namespaceUri, XMLElementReader<ModelNode> reader) {
             // ignored
         }
+
+        @Override
+        public void setProfileParsingCompletionHandler(ProfileParsingCompletionHandler handler) {
+            assert handler != null : "handler is null";
+            synchronized (extension) {
+                extension.parsingCompletionHandler = handler;
+            }
+        }
     }
 
     public class ExtensionContextImpl implements ExtensionContext {
 
         private final ExtensionInfo extension;
         private final PathManager pathManager;
-        private String subsystemName;
 
         private ExtensionContextImpl(String extensionName, PathManager pathManager) {
             assert pathManager != null || !processType.isServer() : "pathManager is null";
@@ -442,7 +461,6 @@ public SubsystemRegistration registerSubsystem(String name, int majorVersion, in
         @Override
         public SubsystemRegistration registerSubsystem(String name, int majorVersion, int minorVersion, int microVersion) {
             assert name != null : "name is null";
-            this.subsystemName = name;
             checkNewSubystem(extension.extensionModuleName, name);
             SubsystemInformationImpl info = extension.getSubsystemInfo(name);
             info.setMajorVersion(majorVersion);
@@ -592,6 +610,7 @@ public class ExtensionInfo {
         private final Set<String> unnamedParsers = new HashSet<String>();
         private final String extensionModuleName;
         private XMLMapper xmlMapper;
+        private ProfileParsingCompletionHandler parsingCompletionHandler;
 
         public ExtensionInfo(String extensionModuleName) {
             this.extensionModuleName = extensionModuleName;
@@ -710,6 +729,7 @@ public ManagementResourceRegistration getSubModel(PathAddress address) {
             return deployments.getSubModel(address);
         }
 
+        @SuppressWarnings("deprecation")
         @Override
         public ManagementResourceRegistration registerSubModel(PathElement address, DescriptionProvider descriptionProvider) {
             ManagementResourceRegistration depl = deployments.registerSubModel(address, descriptionProvider);
@@ -801,12 +821,14 @@ public void unregisterOperationHandler(String operationName) {
             subdeployments.unregisterOperationHandler(operationName);
         }
 
+        @SuppressWarnings("deprecation")
         @Override
         public void registerReadWriteAttribute(String attributeName, OperationStepHandler readHandler, OperationStepHandler writeHandler, AttributeAccess.Storage storage) {
             deployments.registerReadWriteAttribute(attributeName, readHandler, writeHandler, storage);
             subdeployments.registerReadWriteAttribute(attributeName, readHandler, writeHandler, storage);
         }
 
+        @SuppressWarnings("deprecation")
         @Override
         public void registerReadWriteAttribute(String attributeName, OperationStepHandler readHandler, OperationStepHandler writeHandler, EnumSet<AttributeAccess.Flag> flags) {
             deployments.registerReadWriteAttribute(attributeName, readHandler, writeHandler, flags);
@@ -819,12 +841,14 @@ public void registerReadWriteAttribute(AttributeDefinition definition, Operation
             subdeployments.registerReadWriteAttribute(definition, readHandler, writeHandler);
         }
 
+        @SuppressWarnings("deprecation")
         @Override
         public void registerReadOnlyAttribute(String attributeName, OperationStepHandler readHandler, AttributeAccess.Storage storage) {
             deployments.registerReadOnlyAttribute(attributeName, readHandler, storage);
             subdeployments.registerReadOnlyAttribute(attributeName, readHandler, storage);
         }
 
+        @SuppressWarnings("deprecation")
         @Override
         public void registerReadOnlyAttribute(String attributeName, OperationStepHandler readHandler, EnumSet<AttributeAccess.Flag> flags) {
             deployments.registerReadOnlyAttribute(attributeName, readHandler, flags);
@@ -837,6 +861,7 @@ public void registerReadOnlyAttribute(AttributeDefinition definition, OperationS
             subdeployments.registerReadOnlyAttribute(definition, readHandler);
         }
 
+        @SuppressWarnings("deprecation")
         @Override
         public void registerMetric(String attributeName, OperationStepHandler metricHandler) {
             deployments.registerMetric(attributeName, metricHandler);
@@ -849,6 +874,7 @@ public void registerMetric(AttributeDefinition definition, OperationStepHandler
             subdeployments.registerMetric(definition, metricHandler);
         }
 
+        @SuppressWarnings("deprecation")
         @Override
         public void registerMetric(String attributeName, OperationStepHandler metricHandler, EnumSet<AttributeAccess.Flag> flags) {
             deployments.registerMetric(attributeName, metricHandler, flags);

controller/src/main/java/org/jboss/as/controller/parsing/ExtensionParsingContext.java

@@ -100,4 +100,12 @@ public interface ExtensionParsingContext {
     @Deprecated
     void setDeploymentXmlMapping(String subsystemName, String namespaceUri, XMLElementReader<ModelNode> reader);
 
+    /**
+     * Registers a {@link ProfileParsingCompletionHandler} to receive a callback upon completion of parsing of a
+     * profile.
+     *
+     * @param handler the handler. Cannot be {@code null}
+     */
+    void setProfileParsingCompletionHandler(ProfileParsingCompletionHandler handler);
+
 }

controller/src/main/java/org/jboss/as/controller/parsing/ProfileParsingCompletionHandler.java

@@ -0,0 +1,47 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ * Copyright 2012, 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.controller.parsing;
+
+import java.util.List;
+import java.util.Map;
+
+import org.jboss.as.controller.Extension;
+import org.jboss.dmr.ModelNode;
+
+/**
+ * Callback an {@link Extension} can register to, upon completion of normal parsing of a profile, manipulate the list
+ * of parsed boot operations associated with a profile.
+ *
+ * @author Brian Stansberry (c) 2011 Red Hat Inc.
+ */
+public interface ProfileParsingCompletionHandler {
+
+    /**
+     * Callback indicating normal parsing of a profile is completed.
+     *
+     * @param profileBootOperations the boot operations added by subsystems in the profile, keyed by the URI of the
+     *                              xml namespace used for the subsystem
+     * @param otherBootOperations other operations registered in the boot prior to parsing of the profile
+     */
+    void handleProfileParsingCompletion(final Map<String, List<ModelNode>> profileBootOperations, List<ModelNode> otherBootOperations);
+}

host-controller/src/main/java/org/jboss/as/host/controller/parsing/DomainXml.java

@@ -67,7 +67,9 @@
 import java.util.Collections;
 import java.util.EnumSet;
 import java.util.HashSet;
+import java.util.LinkedHashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.ExecutorService;
 
@@ -83,6 +85,7 @@
 import org.jboss.as.controller.parsing.ExtensionXml;
 import org.jboss.as.controller.parsing.Namespace;
 import org.jboss.as.controller.parsing.ParseUtils;
+import org.jboss.as.controller.parsing.ProfileParsingCompletionHandler;
 import org.jboss.as.controller.persistence.ModelMarshallingContext;
 import org.jboss.as.controller.persistence.SubsystemMarshallingContext;
 import org.jboss.as.controller.resource.SocketBindingGroupResourceDefinition;
@@ -105,10 +108,12 @@
 public class DomainXml extends CommonXml {
 
     private final ExtensionXml extensionXml;
+    private final ExtensionRegistry extensionRegistry;
 
     public DomainXml(final ModuleLoader loader, ExecutorService executorService, ExtensionRegistry extensionRegistry) {
         super();
         extensionXml = new ExtensionXml(loader, executorService, extensionRegistry);
+        this.extensionRegistry = extensionRegistry;
     }
 
     @Override
@@ -714,26 +719,30 @@ void parseProfiles(final XMLExtendedStreamReader reader, final ModelNode address
                 throw MESSAGES.duplicateDeclaration("profile", name, reader.getLocation());
             }
 
-            final List<ModelNode> subsystems = new ArrayList<ModelNode>();
+
             //final Set<String> includes = new HashSet<String>();  // See commented out section below.
             //final ModelNode profileIncludes = new ModelNode();
 
             // Content
             // Sequence
-            final Set<String> configuredSubsystemTypes = new HashSet<String>();
+            final Map<String, List<ModelNode>> profileOps = new LinkedHashMap<String, List<ModelNode>>();
             while (reader.nextTag() != END_ELEMENT) {
                 Namespace ns = Namespace.forUri(reader.getNamespaceURI());
                 switch (ns) {
                     case UNKNOWN: {
                         if (Element.forName(reader.getLocalName()) != Element.SUBSYSTEM) {
                             throw unexpectedElement(reader);
                         }
-                        if (!configuredSubsystemTypes.add(reader.getNamespaceURI())) {
+                        String namespace = reader.getNamespaceURI();
+                        if (profileOps.containsKey(namespace)) {
                             throw MESSAGES.duplicateDeclaration("subsystem", name, reader.getLocation());
                         }
                         // parse content
+                        final List<ModelNode> subsystems = new ArrayList<ModelNode>();
                         reader.handleAny(subsystems);
 
+                        profileOps.put(namespace, subsystems);
+
                         break;
                     }
                     case DOMAIN_1_0:
@@ -742,7 +751,7 @@ void parseProfiles(final XMLExtendedStreamReader reader, final ModelNode address
                     case DOMAIN_1_3:{
                         requireNamespace(reader, expectedNs);
                         // include should come first
-                        if (configuredSubsystemTypes.size() > 0) {
+                        if (profileOps.size() > 0) {
                             throw unexpectedElement(reader);
                         }
                         if (Element.forName(reader.getLocalName()) != Element.INCLUDE) {
@@ -770,6 +779,13 @@ void parseProfiles(final XMLExtendedStreamReader reader, final ModelNode address
                     }
                 }
             }
+
+            // Let extensions modify the profile
+            Set<ProfileParsingCompletionHandler> completionHandlers = extensionRegistry.getProfileParsingCompletionHandlers();
+            for (ProfileParsingCompletionHandler completionHandler : completionHandlers) {
+                completionHandler.handleProfileParsingCompletion(profileOps, list);
+            }
+
             final ModelNode profile = new ModelNode();
             profile.get(OP).set(ADD);
             profile.get(OP_ADDR).set(address).add(ModelDescriptionConstants.PROFILE, name);
@@ -779,17 +795,19 @@ void parseProfiles(final XMLExtendedStreamReader reader, final ModelNode address
             list.add(profile);
 
             // Process subsystems
-            for(final ModelNode update : subsystems) {
-                // Process relative subsystem path address
-                final ModelNode subsystemAddress = address.clone().set(address).add(ModelDescriptionConstants.PROFILE, name);
-                for(final Property path : update.get(OP_ADDR).asPropertyList()) {
-                    subsystemAddress.add(path.getName(), path.getValue().asString());
+            for (List<ModelNode> subsystems : profileOps.values()) {
+                for(final ModelNode update : subsystems) {
+                    // Process relative subsystem path address
+                    final ModelNode subsystemAddress = address.clone().set(address).add(ModelDescriptionConstants.PROFILE, name);
+                    for(final Property path : update.get(OP_ADDR).asPropertyList()) {
+                        subsystemAddress.add(path.getName(), path.getValue().asString());
+                    }
+                    update.get(OP_ADDR).set(subsystemAddress);
+                    list.add(update);
                 }
-                update.get(OP_ADDR).set(subsystemAddress);
-                list.add(update);
             }
 
-            if (configuredSubsystemTypes.size() == 0) {
+            if (profileOps.size() == 0) {
                 throw MESSAGES.profileHasNoSubsystems(reader.getLocation());
             }
         }

jsf/src/main/java/org/jboss/as/jsf/subsystem/JSFSubsystemAdd.java

@@ -22,6 +22,8 @@
 
 package org.jboss.as.jsf.subsystem;
 
+import java.util.List;
+
 import org.jboss.as.controller.AbstractBoottimeAddStepHandler;
 import org.jboss.as.controller.OperationContext;
 import org.jboss.as.controller.ServiceVerificationHandler;
@@ -36,8 +38,6 @@
 import org.jboss.dmr.ModelNode;
 import org.jboss.msc.service.ServiceController;
 
-import java.util.List;
-
 /**
  * The JSF subsystem add update handler.
  *

jsf/src/test/resources/org/jboss/as/jsf/subsystem/subsystem-legacy-web-1.0.xml

@@ -0,0 +1,7 @@
+<subsystem xmlns="urn:jboss:domain:web:1.0" default-virtual-server="default-host">
+    <connector name="http" scheme="http" protocol="HTTP/1.1" socket-binding="http"/>
+    <virtual-server name="default-host" enable-welcome-root="false">
+        <alias name="localhost"/>
+        <alias name="example.com"/>
+    </virtual-server>
+</subsystem>

jsf/src/test/resources/org/jboss/as/jsf/subsystem/subsystem-legacy-web-1.1.xml

@@ -0,0 +1,7 @@
+<subsystem xmlns="urn:jboss:domain:web:1.1" default-virtual-server="default-host">
+    <connector name="http" scheme="http" protocol="HTTP/1.1" socket-binding="http"/>
+    <virtual-server name="default-host" enable-welcome-root="false">
+        <alias name="localhost"/>
+        <alias name="example.com"/>
+    </virtual-server>
+</subsystem>