WFCORE-6995 Allow stability-specific resource transformations for mixed domains #6214
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| /* | ||
| * Copyright The WildFly Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.jboss.as.controller.transform; | ||
|
|
||
| import java.util.EnumSet; | ||
| import java.util.function.BiConsumer; | ||
|
|
||
| import org.jboss.as.controller.ModelVersion; | ||
| import org.jboss.as.controller.SubsystemModel; | ||
| import org.jboss.as.controller.transform.description.ResourceTransformationDescriptionBuilder; | ||
| import org.jboss.as.controller.transform.description.TransformationDescription; | ||
|
|
||
| /** | ||
| * A transformer registration of a single subsystem. | ||
| */ | ||
| public class SubsystemModelTransformerRegistration<E extends Enum<E> & SubsystemModel> implements ExtensionTransformerRegistration { | ||
|
|
||
| private final String subsystemName; | ||
| private final E currentSubsystemModel; | ||
| private final BiConsumer<ResourceTransformationDescriptionBuilder, ModelVersion> transformation; | ||
|
|
||
| /** | ||
| * Creates a transformer registration for a subsystem. | ||
| * @param subsystemName the subsystem name | ||
| * @param currentSubsystemModel the current subsystem model | ||
| * @param transformation a consumer that builds a transformer description for a given target model version | ||
| */ | ||
| public SubsystemModelTransformerRegistration(String subsystemName, E currentSubsystemModel, BiConsumer<ResourceTransformationDescriptionBuilder, ModelVersion> transformation) { | ||
| this.subsystemName = subsystemName; | ||
| this.currentSubsystemModel = currentSubsystemModel; | ||
| this.transformation = transformation; | ||
| } | ||
|
|
||
| @Override | ||
| public String getSubsystemName() { | ||
| return this.subsystemName; | ||
| } | ||
|
|
||
| @Override | ||
| public void registerTransformers(SubsystemTransformerRegistration registration) { | ||
| // Build and register transformation descriptions for all but the current subsystem model version | ||
| for (E model : EnumSet.complementOf(EnumSet.of(this.currentSubsystemModel))) { | ||
| ModelVersion version = model.getVersion(); | ||
| ResourceTransformationDescriptionBuilder builder = registration.createResourceTransformationDescriptionBuilder(); | ||
| this.transformation.accept(builder, version); | ||
| TransformationDescription.Tools.register(builder.build(), registration, version); | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,6 +22,8 @@ | |
| import org.jboss.as.controller.logging.ControllerLogger; | ||
| import org.jboss.as.controller.registry.GlobalTransformerRegistry; | ||
| import org.jboss.as.controller.registry.OperationTransformerRegistry; | ||
| import org.jboss.as.controller.transform.description.ResourceTransformationDescriptionBuilderFactory; | ||
| import org.jboss.as.version.Stability; | ||
| import org.jboss.dmr.ModelNode; | ||
| import org.jboss.dmr.Property; | ||
| import org.jboss.modules.Module; | ||
|
|
@@ -33,7 +35,7 @@ | |
| * @author <a href="mailto:[email protected]">Tomaz Cerar</a> | ||
| * @author Emanuel Muckenhuber | ||
| */ | ||
| public final class TransformerRegistry implements ResourceTransformationDescriptionBuilderFactory { | ||
|
|
||
| public static final ModelNode DISCARD_OPERATION = new ModelNode(); | ||
| static { | ||
|
|
@@ -46,19 +48,26 @@ public final class TransformerRegistry { | |
| private static final PathElement PROFILE = PathElement.pathElement(ModelDescriptionConstants.PROFILE); | ||
| private static final PathElement SERVER = PathElement.pathElement(ModelDescriptionConstants.RUNNING_SERVER); | ||
|
|
||
| private final Stability stability; | ||
| private final GlobalTransformerRegistry domain = new GlobalTransformerRegistry(); | ||
| private final GlobalTransformerRegistry subsystem = new GlobalTransformerRegistry(); | ||
|
|
||
| TransformerRegistry(Stability stability) { | ||
| this.stability = stability; | ||
| // Initialize the empty paths | ||
| domain.createChildRegistry(PathAddress.pathAddress(PROFILE), ModelVersion.create(0), ResourceTransformer.DEFAULT, false); | ||
| domain.createChildRegistry(PathAddress.pathAddress(HOST), ModelVersion.create(0), ResourceTransformer.DEFAULT, false); | ||
| domain.createChildRegistry(PathAddress.pathAddress(HOST, SERVER), ModelVersion.create(0), ResourceTransformer.DEFAULT, false); | ||
| } | ||
|
|
||
| @Override | ||
| public Stability getStability() { | ||
| return this.stability; | ||
| } | ||
|
|
||
| public void loadAndRegisterTransformers(String name, ModelVersion subsystemVersion, String extensionModuleName) { | ||
| try { | ||
| SubsystemTransformerRegistration transformerRegistration = this.createSubsystemTransformerRegistration(name, subsystemVersion); | ||
| if (Module.getCallerModule() != null) { //only register when running in modular environment, testsuite does its own loading | ||
| for (ExtensionTransformerRegistration registration : Module.loadServiceFromCallerModuleLoader(extensionModuleName, ExtensionTransformerRegistration.class)) { | ||
| if (registration.getSubsystemName().equals(name)) { //to prevent registering transformers for different subsystems | ||
|
|
@@ -71,16 +80,15 @@ public void loadAndRegisterTransformers(String name, ModelVersion subsystemVersi | |
| } | ||
| } | ||
|
|
||
| public SubsystemTransformerRegistration createSubsystemTransformerRegistration(String name, ModelVersion currentVersion) { | ||
| return new SubsystemTransformerRegistrationImpl(name, currentVersion); | ||
| } | ||
|
|
||
| private class SubsystemTransformerRegistrationImpl implements SubsystemTransformerRegistration { | ||
| private final String name; | ||
| private final ModelVersion currentVersion; | ||
|
|
||
| SubsystemTransformerRegistrationImpl(String name, ModelVersion currentVersion) { | ||
| this.name = name; | ||
| this.currentVersion = currentVersion; | ||
| } | ||
|
|
@@ -101,9 +109,14 @@ public TransformersSubRegistration registerModelTransformers(ModelVersionRange v | |
| } | ||
|
|
||
| @Override | ||
| public ModelVersion getCurrentVersion() { | ||
| return currentVersion; | ||
| } | ||
|
|
||
| @Override | ||
| public Stability getStability() { | ||
| return TransformerRegistry.this.getStability(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -275,11 +288,16 @@ public static class Factory { | |
| * Create a new Transformer registry. | ||
| * | ||
| * @return the created transformer registry | ||
| * @deprecated Superseded by {@link #create(Stability)}. | ||
| */ | ||
| @Deprecated(forRemoval = true) | ||
| public static TransformerRegistry create() { | ||
| return create(Stability.DEFAULT); | ||
| } | ||
|
Comment on lines
+293
to
296
There was a problem hiding this comment. What happens with the current usage of this method in our code? Shouldn't we at least force the creation of a transformer registry using a specific Stability level? Otherwise, we will continue using the wrong registry and we won't be able yet to add specific transformations to the subsystems. |
||
|
|
||
| public static TransformerRegistry create(Stability stability) { | ||
| return new TransformerRegistry(stability); | ||
| } | ||
| } | ||
|
|
||
| public static class TransformersSubRegistrationImpl implements TransformersSubRegistration { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have an example of how to use this class?
I'm not a SME in these transformers and it is too big to digest it easily, but I guess what I cannot see is how this new way to register the transformers will be able to match what we currently have. At this moment, transformers are registered as a chain, with a common builder that registers the transformation from one version to another, however here we are only registering a single version with a specific builder, so I get lost on this.