Skip to content

Commit

Permalink
WFCORE-6742 SubsystemExtension needs the ability to define the curren…
Browse files Browse the repository at this point in the history 
…t model/schema version given the stability level of the process
  • Loading branch information
@pferraro
pferraro committed Mar 15, 2024
1 parent 9e50fa6 commit 3fc0e7c
Show file tree
Hide file tree
Showing 2 changed files with 85 additions and 19 deletions.
2 changes: 1 addition & 1 deletion subsystem/src/main/java/org/wildfly/subsystem/SubsystemExtension.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public Optional<PathManager> getPathManager() {
};
// Auto-register subsystem describe handler
this.configuration.getRegistrar().register(registration, registrationContext).registerOperationHandler(GenericSubsystemDescribeHandler.DEFINITION, GenericSubsystemDescribeHandler.INSTANCE);
registration.registerXMLElementWriter(this.persistence.getWriter());
registration.registerXMLElementWriter(this.persistence.getWriter(context.getStability()));
}

@Override
Expand Down
102 changes: 84 additions & 18 deletions subsystem/src/main/java/org/wildfly/subsystem/SubsystemPersistence.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,27 @@
*/
package org.wildfly.subsystem;

import java.util.EnumMap;
import java.util.EnumSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.function.Function;

import org.jboss.as.controller.Feature;
import org.jboss.as.controller.FeatureRegistry;
import org.jboss.as.controller.PersistentResourceXMLDescription;
import org.jboss.as.controller.PersistentResourceXMLDescriptionReader;
import org.jboss.as.controller.PersistentResourceXMLDescriptionWriter;
import org.jboss.as.controller.PersistentSubsystemSchema;
import org.jboss.as.controller.SubsystemSchema;
import org.jboss.as.controller.persistence.SubsystemMarshallingContext;
import org.jboss.as.version.Stability;
import org.jboss.dmr.ModelNode;
import org.jboss.staxmapper.XMLElementReader;
import org.jboss.staxmapper.XMLElementWriter;
import org.wildfly.common.Assert;

/**
* Encapsulates the persistence configuration of a subsystem.
Expand All @@ -36,13 +43,26 @@ public interface SubsystemPersistence<S extends SubsystemSchema<S>> {
* Returns the appropriate StAX reader for the version of the specified schema that parses subsystem XML into a set of management operations.
* @return a StAX reader for the version of the specified schema
*/
XMLElementReader<List<ModelNode>> getReader(S schema);
default XMLElementReader<List<ModelNode>> getReader(S schema) {
return schema;
}

/**
* Returns a StAX writer that writes the subsystem model to XML according to the current schema version.
* @return a StAX writer
* @deprecated Replaced by {@link #getWriter(FeatureRegistry)}
*/
@Deprecated(forRemoval = true)
default XMLElementWriter<SubsystemMarshallingContext> getWriter() {
return this.getWriter(Stability.DEFAULT);
}

/**
* Returns a StAX writer that writes the subsystem model to XML according to the current schema version for the specified stability level.
* @param stability the stability level of the process
* @return a StAX writer
*/
XMLElementWriter<SubsystemMarshallingContext> getWriter();
XMLElementWriter<SubsystemMarshallingContext> getWriter(Stability stability);

/**
* Creates the subsystem persistence configuration for the current version of the schema.
Expand All @@ -51,8 +71,41 @@ public interface SubsystemPersistence<S extends SubsystemSchema<S>> {
* @return a subsystem persistence configuration
*/
static <S extends Enum<S> & PersistentSubsystemSchema<S>> SubsystemPersistence<S> of(S currentSchema) {
PersistentResourceXMLDescription currentXMLDescription = currentSchema.getXMLDescription();
return of(currentSchema, new PersistentResourceXMLDescriptionReader(currentXMLDescription), new PersistentResourceXMLDescriptionWriter(currentXMLDescription));
return of(EnumSet.of(currentSchema));
}

/**
* Creates the subsystem persistence configuration for the current versions of the schema.
* @param <S> the schema type
* @param currentSchemas the current schema versions
* @return a subsystem persistence configuration
*/
static <S extends Enum<S> & PersistentSubsystemSchema<S>> SubsystemPersistence<S> of(Set<S> currentSchemas) {
Assert.assertFalse(currentSchemas.isEmpty());
Class<S> schemaClass = currentSchemas.iterator().next().getDeclaringClass();
// Build PersistentResourceXMLDescription for current schemas to share between reader and writer.
Map<S, PersistentResourceXMLDescription> currentXMLDescriptions = new EnumMap<>(schemaClass);
for (S currentSchema : currentSchemas) {
currentXMLDescriptions.put(currentSchema, currentSchema.getXMLDescription());
}
Map<Stability, S> currentSchemaPerStability = Feature.map(currentSchemas);
return new SubsystemPersistence<>() {
@Override
public Set<S> getSchemas() {
return EnumSet.allOf(schemaClass);
}

@Override
public XMLElementReader<List<ModelNode>> getReader(S schema) {
return Optional.ofNullable(currentXMLDescriptions.get(schema)).<XMLElementReader<List<ModelNode>>>map(PersistentResourceXMLDescriptionReader::new).orElse(schema);
}

@Override
public XMLElementWriter<SubsystemMarshallingContext> getWriter(Stability stability) {
S currentSchema = currentSchemaPerStability.get(stability);
return new PersistentResourceXMLDescriptionWriter(currentXMLDescriptions.get(currentSchema));
}
};
}

/**
Expand All @@ -62,11 +115,29 @@ static <S extends Enum<S> & PersistentSubsystemSchema<S>> SubsystemPersistence<S
* @return a subsystem persistence configuration
*/
static <S extends Enum<S> & SubsystemSchema<S>> SubsystemPersistence<S> of(S currentSchema, XMLElementWriter<SubsystemMarshallingContext> writer) {
return of(currentSchema, currentSchema, writer);
return of(Map.of(currentSchema, writer));
}

private static <S extends Enum<S> & SubsystemSchema<S>> SubsystemPersistence<S> of(S currentSchema, XMLElementReader<List<ModelNode>> currentReader, XMLElementWriter<SubsystemMarshallingContext> writer) {
return of(EnumSet.allOf(currentSchema.getDeclaringClass()), Function.identity(), currentSchema, currentSchema, writer);
/**
* Creates the subsystem persistence configuration for the specified writers for current versions of the schema.
* @param <S> the schema type
* @param currentWirter the schema writer per current schema version
* @return a subsystem persistence configuration
*/
static <S extends Enum<S> & SubsystemSchema<S>> SubsystemPersistence<S> of(Map<S, XMLElementWriter<SubsystemMarshallingContext>> currentWriters) {
Assert.assertFalse(currentWriters.isEmpty());
Class<S> schemaClass = currentWriters.keySet().iterator().next().getDeclaringClass();
return new SubsystemPersistence<>() {
@Override
public Set<S> getSchemas() {
return EnumSet.allOf(schemaClass);
}

@Override
public XMLElementWriter<SubsystemMarshallingContext> getWriter(Stability stability) {
return currentWriters.get(stability);
}
};
}

/**
Expand All @@ -77,7 +148,9 @@ private static <S extends Enum<S> & SubsystemSchema<S>> SubsystemPersistence<S>
* @param readerFactory a factory for creating an XML reader for a specific schema
* @param writer an XML reader
* @return a subsystem persistence configuration
* @deprecated Use {@link #of(Enum, XMLElementWriter) instead
*/
@Deprecated(forRemoval = true)
static <S extends SubsystemSchema<S>, R extends XMLElementReader<List<ModelNode>>> SubsystemPersistence<S> of(Set<S> schemas, Function<S, R> readerFactory, XMLElementWriter<SubsystemMarshallingContext> writer) {
return new DefaultSubsystemPersistence<>(schemas, readerFactory, writer);
}
Expand All @@ -92,26 +165,19 @@ static <S extends SubsystemSchema<S>, R extends XMLElementReader<List<ModelNode>
* @param currentReader the XML reader for the current schema version
* @param writer an XML reader
* @return a subsystem persistence configuration
* @deprecated Use {@link #of(Enum, XMLElementWriter) instead
*/
@Deprecated(forRemoval = true)
static <S extends SubsystemSchema<S>, R extends XMLElementReader<List<ModelNode>>> SubsystemPersistence<S> of(Set<S> schemas, Function<S, R> readerFactory, S currentSchema, XMLElementReader<List<ModelNode>> currentReader, XMLElementWriter<SubsystemMarshallingContext> writer) {
return new DefaultSubsystemPersistence<>(schemas, readerFactory, writer) {
@Override
public Set<S> getSchemas() {
return schemas;
}

@Override
public XMLElementReader<List<ModelNode>> getReader(S schema) {
return (schema == currentSchema) ? currentReader : readerFactory.apply(schema);
}

@Override
public XMLElementWriter<SubsystemMarshallingContext> getWriter() {
return writer;
}
};
}

@Deprecated(forRemoval = true)
class DefaultSubsystemPersistence<S extends SubsystemSchema<S>, R extends XMLElementReader<List<ModelNode>>> implements SubsystemPersistence<S> {
private final Set<S> schemas;
private final Function<S, R> readerFactory;
Expand All @@ -134,7 +200,7 @@ public XMLElementReader<List<ModelNode>> getReader(S schema) {
}

@Override
public XMLElementWriter<SubsystemMarshallingContext> getWriter() {
public XMLElementWriter<SubsystemMarshallingContext> getWriter(Stability stability) {
return this.writer;
}
}
Expand Down

0 comments on commit 3fc0e7c

Please sign in to comment.