MID-9278 optionalCleanup annotation support added (also resource/sche…

…ma/definition marked as first item)
Evolveum · Nov 28, 2023 · a9cfb4a · a9cfb4a
1 parent 733f646
commit a9cfb4a
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 1 deletion.
diff --git a/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/Definition.java b/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/Definition.java
@@ -103,6 +103,8 @@ default boolean isIgnored() {
 
     String getRemovedSince();
 
+    boolean isOptionalCleanup();
+
     /**
      * Experimental functionality is not stable and it may be changed in any
      * future release without any warning. Use at your own risk.

diff --git a/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/MutableDefinition.java b/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/MutableDefinition.java
@@ -24,6 +24,8 @@ public interface MutableDefinition extends Definition {
 
     void setRemovedSince(String removedSince);
 
+    void setOptionalCleanup(boolean optionalCleanup);
+
     void setExperimental(boolean experimental);
 
     void setEmphasized(boolean emphasized);

diff --git a/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/PrismConstants.java b/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/PrismConstants.java
@@ -112,6 +112,7 @@ public class PrismConstants {
     public static final QName A_SCHEMA_MIGRATION_VERSION = new QName(NS_ANNOTATION, "version");
     public static final QName A_SCHEMA_MIGRATION_OPERATION = new QName(NS_ANNOTATION, "operation");
     public static final QName A_SCHEMA_MIGRATION_REPLACEMENT = new QName(NS_ANNOTATION, "replacement");
+    public static final QName A_OPTIONAL_CLEANUP = new QName(NS_ANNOTATION, "optionalCleanup");
     public static final QName A_DEFAULT_PREFIX = new QName(NS_ANNOTATION, "defaultPrefix");
     public static final QName A_DIAGRAM = new QName(NS_ANNOTATION, "diagram");
     public static final QName A_DIAGRAM_NAME = new QName(NS_ANNOTATION, "name");

diff --git a/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/deleg/DefinitionDelegator.java b/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/deleg/DefinitionDelegator.java
@@ -99,6 +99,11 @@ default String getRemovedSince() {
         return delegate().getRemovedSince();
     }
 
+    @Override
+    default boolean isOptionalCleanup() {
+        return delegate().isOptionalCleanup();
+    }
+
     @Override
     default boolean isExperimental() {
         return delegate().isExperimental();

diff --git a/infra/prism-impl/src/main/java/com/evolveum/midpoint/prism/impl/DefinitionImpl.java b/infra/prism-impl/src/main/java/com/evolveum/midpoint/prism/impl/DefinitionImpl.java
@@ -55,6 +55,7 @@ public abstract class DefinitionImpl extends AbstractFreezable implements Mutabl
     protected String deprecatedSince;
     protected boolean removed = false;
     protected String removedSince;
+    private boolean optionalCleanup;
     protected String plannedRemoval;
     protected boolean experimental = false;
     protected boolean elaborate = false;
@@ -148,6 +149,17 @@ public void setRemoved(boolean removed) {
         this.removed = removed;
     }
 
+    @Override
+    public boolean isOptionalCleanup() {
+        return optionalCleanup;
+    }
+
+    @Override
+    public void setOptionalCleanup(boolean optionalCleanup) {
+        checkMutable();
+        this.optionalCleanup = optionalCleanup;
+    }
+
     @Override
     public String getRemovedSince() {
         return removedSince;

diff --git a/...prism-impl/src/main/java/com/evolveum/midpoint/prism/impl/DummyPrismObjectDefinition.java b/...prism-impl/src/main/java/com/evolveum/midpoint/prism/impl/DummyPrismObjectDefinition.java
@@ -27,6 +27,11 @@
 @Experimental
 public class DummyPrismObjectDefinition implements PrismObjectDefinition<Objectable> {
 
+    @Override
+    public boolean isOptionalCleanup() {
+        throw new UnsupportedOperationException();
+    }
+
     @Override
     public boolean isAlwaysUseForEquals() {
         throw new UnsupportedOperationException();

diff --git a/...ism-impl/src/main/java/com/evolveum/midpoint/prism/impl/schema/annotation/Annotation.java b/...ism-impl/src/main/java/com/evolveum/midpoint/prism/impl/schema/annotation/Annotation.java
@@ -101,6 +101,9 @@ public void process(@NotNull MutableDefinition definition, @NotNull List<Element
     OPERATIONAL(new AnnotationProcessor<MutableItemDefinition<?>, Boolean>(
             A_OPERATIONAL, Boolean.class, MutableItemDefinition.class, MutableItemDefinition::setOperational, true)),
 
+    OPTIONAL_CLEANUP(new AnnotationProcessor<>(
+            A_OPTIONAL_CLEANUP, Boolean.class, MutableDefinition::setOptionalCleanup, true)),
+
     PLANNED_REMOVAL(new AnnotationProcessor<MutableItemDefinition<?>, String>(
             A_PLANNED_REMOVAL, String.class, MutableItemDefinition.class, MutableItemDefinition::setPlannedRemoval, null)),
 
@@ -133,7 +136,7 @@ public static void processAnnotation(MutableDefinition definition, XSAnnotation
         }
 
         List<Element> elements = SchemaProcessorUtil.getAnnotationElements(xsAnnotation, annotation.processor.name);
-        if (elements == null || elements.isEmpty()) {
+        if (elements.isEmpty()) {
             return;
         }
 

diff --git a/infra/prism-impl/src/main/resources/xml/ns/public/annotation-3.xsd b/infra/prism-impl/src/main/resources/xml/ns/public/annotation-3.xsd
@@ -363,6 +363,14 @@
         </xsd:annotation>
     </xsd:element>
 
+    <xsd:element name="optionalCleanup" type="xsd:boolean">
+        <xsd:annotation>
+            <xsd:documentation>
+                Marks item that could be ignored by SCM tools (e.g. Git), or removed before commit.
+            </xsd:documentation>
+        </xsd:annotation>
+    </xsd:element>
+
     <xsd:element name="composite" type="xsd:boolean">
         <xsd:annotation>
             <xsd:documentation>