`HttpHeader` object (= <httpHeaders>) is not wrapped by the XML `<property>` tag

[cmoulliard]

Issue

The following Maven Settings XML

<settings>
    <servers>
        <server>
            <id>maven-snapshots</id>
            <configuration>
                <httpHeaders>
                    <property>
                        <name>X-JFrog-Art-Api</name>
                        <value>myApiToken</value>
                    </property>
                </httpHeaders>
            </configuration>
        </server>
    </servers>
</settings>

is generated as such as string during jackson serialization

<settings>
   <servers>
       <server>
           <id>maven-snapshots</id>
           <configuration>
               <httpHeaders>
                   <name>X-JFrog-Art-Api</name>
                   <value>myApiToken</value>
               </httpHeaders>
               <timeout>10000</timeout>
           </configuration>
       </server>
   </servers>
</settings>

As you can see the <httpHeaders> is not wrapped with <property />.

The code is available here:

Here is a snapshot of the java class: https://github.com/ch007m/maven-settings-httpheader-issue/blob/main/src/test/java/dev/snowdrop/jackson/httpheader/issue/MavenSettingsSimplified.java

    public static class ServerConfiguration {
        @JacksonXmlProperty(
            localName = "property"
        )
        @JacksonXmlElementWrapper(
            localName = "httpHeaders",
            useWrapping = true
        )
        @JsonIgnore
        private final @Nullable List<HttpHeader> httpHeaders;
        private final @Nullable Long timeout;

        @JsonCreator
        public ServerConfiguration(@JsonProperty("httpHeaders") @Nullable List<HttpHeader> httpHeaders, @JsonProperty("timeout") @Nullable Long timeout) {
            this.httpHeaders = httpHeaders;
            this.timeout = timeout;
        }

        public @Nullable List<HttpHeader> getHttpHeaders() {
            return this.httpHeaders;
        }

        public @Nullable Long getTimeout() {
            return this.timeout;
        }

        public ServerConfiguration withHttpHeaders(final @Nullable List<HttpHeader> httpHeaders) {
            return this.httpHeaders == httpHeaders ? this : new ServerConfiguration(httpHeaders, this.timeout);
        }

        public ServerConfiguration withTimeout(final @Nullable Long timeout) {
            return this.timeout == timeout ? this : new ServerConfiguration(this.httpHeaders, timeout);
        }
    }

    public static class HttpHeader {
        private final String name;
        private final String value;

        @JsonCreator
        public HttpHeader(@JsonProperty("name") String name, @JsonProperty("value") String value) {
            this.name = name;
            this.value = value;
        }

        public String getName() {
            return this.name;
        }

        public String getValue() {
            return this.value;
        }

        public HttpHeader withName(final String name) {
            return this.name == name ? this : new HttpHeader(name, this.value);
        }

        public HttpHeader withValue(final String value) {
            return this.value == value ? this : new HttpHeader(this.name, value);
        }
    }

Test method which is failing is: https://github.com/ch007m/maven-settings-httpheader-issue/blob/main/src/test/java/dev/snowdrop/jackson/httpheader/issue/SimpleSettingsXmlTest.java#L74

[cowtowncoder]

My suspicion would be wrt @JsonIgnore on:

        @JacksonXmlProperty(
            localName = "property"
        )
        @JacksonXmlElementWrapper(
            localName = "httpHeaders",
            useWrapping = true
        )
        @JsonIgnore
        private final @Nullable List<HttpHeader> httpHeaders;

which might prevent merging of @JacksonXmlElementWrapper annotation with getter.

I don't think @JsonIgnore is needed here; but if you want it, then move other annotations to getter.

But I am also not sure if wrapper/property names are right way (I get confused by them myself).
... or actually, it is likely right. n/m.

Finally, you are probably already doing it but if not, trying out latest version (either 3.0.3 or 2.20.1) is good to rule out issues with annotation merging/property introspection that might have been fixed (if using older version).

[cmoulliard]

Finally, you are probably already doing it but if not, trying out latest version (either 3.0.3 or 2.20.1)

I'm already using 2.20.1.

WARNING: sun.misc.Unsafe::staticFieldBase will be removed in a future release
[INFO] +- com.fasterxml.jackson.core:jackson-core:jar:2.20.1:compile
[INFO] +- com.fasterxml.jackson.core:jackson-databind:jar:2.20.1:compile
[INFO] +- com.fasterxml.jackson.core:jackson-annotations:jar:2.20:compile
[INFO] +- com.fasterxml.jackson.module:jackson-module-jaxb-annotations:jar:2.20.1:compile
[INFO] +- com.fasterxml.jackson.module:jackson-module-jakarta-xmlbind-annotations:jar:2.20.1:compile
[INFO] +- com.fasterxml.jackson.module:jackson-module-parameter-names:jar:2.20.1:compile
[INFO] +- com.fasterxml.jackson.dataformat:jackson-dataformat-xml:jar:2.20.1:compile
[INFO] +- com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:jar:2.20.1:compile
[INFO] \- com.fasterxml.jackson.dataformat:jackson-dataformat-csv:jar:2.20.1:compile

[cmoulliard]

If I do what you suggest (= moving the annotations) to the getter, I got another error no matter if I keep or no @JsonIgnore

[ERROR] dev.snowdrop.jackson.httpheader.issue.SimpleSettingsXmlTest.shouldParseXML -- Time elapsed: 0.113 s <<< ERROR!
com.fasterxml.jackson.databind.exc.InvalidDefinitionException: 
Duplicate property 'httpHeaders' for [simple type, class dev.snowdrop.jackson.httpheader.issue.MavenSettingsSimplified$ServerConfiguration]
 at [Source: (StringReader); line: 1, column: 1]
        at com.fasterxml.jackson.databind.exc.InvalidDefinitionException.from(InvalidDefinitionException.java:67)
        at com.fasterxml.jackson.databind.DeserializationContext.reportBadDefinition(DeserializationContext.java:1943)
        at com.fasterxml.jackson.databind.deser.DeserializerCache._createAndCache2(DeserializerCache.java:322)
        at com.fasterxml.jackson.databind.deser.DeserializerCache._createAndCacheValueDeserializer(DeserializerCache.java:285)
        at com.fasterxml.jackson.databind.deser.DeserializerCache.findValueDeserializer(DeserializerCache.java:175)
        at com.fasterxml.jackson.databind.DeserializationContext.findNonContextualValueDeserializer(DeserializationContext.java:679)
        at com.fasterxml.jackson.databind.deser.BeanDeserializerBase.resolve(BeanDeserializerBase.java:555)
        at com.fasterxml.jackson.databind.deser.std.DelegatingDeserializer.resolve(DelegatingDeserializer.java:60)
        at com.fasterxml.jackson.databind.deser.DeserializerCache._createAndCache2(DeserializerCache.java:348)
        at com.fasterxml.jackson.databind.deser.DeserializerCache._createAndCacheValueDeserializer(DeserializerCache.java:285)
        at com.fasterxml.jackson.databind.deser.DeserializerCache.findValueDeserializer(DeserializerCache.java:175)
        at com.fasterxml.jackson.databind.DeserializationContext.findContextualValueDeserializer(DeserializationContext.java:656)
        at com.fasterxml.jackson.databind.deser.std.CollectionDeserializer.createContextual(CollectionDeserializer.java:189)
        at com.fasterxml.jackson.databind.deser.std.CollectionDeserializer.createContextual(CollectionDeserializer.java:29)
        at com.fasterxml.jackson.databind.DeserializationContext.handlePrimaryContextualization(DeserializationContext.java:884)
        at com.fasterxml.jackson.databind.deser.BeanDeserializerBase.resolve(BeanDeserializerBase.java:566)
        at com.fasterxml.jackson.databind.deser.std.DelegatingDeserializer.resolve(DelegatingDeserializer.java:60)
        at com.fasterxml.jackson.databind.deser.DeserializerCache._createAndCache2(DeserializerCache.java:348)
        at com.fasterxml.jackson.databind.deser.DeserializerCache._createAndCacheValueDeserializer(DeserializerCache.java:285)
        at com.fasterxml.jackson.databind.deser.DeserializerCache.findValueDeserializer(DeserializerCache.java:175)
        at com.fasterxml.jackson.databind.DeserializationContext.findNonContextualValueDeserializer(DeserializationContext.java:679)
        at com.fasterxml.jackson.databind.deser.BeanDeserializerBase.resolve(BeanDeserializerBase.java:555)
        at com.fasterxml.jackson.databind.deser.std.DelegatingDeserializer.resolve(DelegatingDeserializer.java:60)
        at com.fasterxml.jackson.databind.deser.DeserializerCache._createAndCache2(DeserializerCache.java:348)
        at com.fasterxml.jackson.databind.deser.DeserializerCache._createAndCacheValueDeserializer(DeserializerCache.java:285)
        at com.fasterxml.jackson.databind.deser.DeserializerCache.findValueDeserializer(DeserializerCache.java:175)
        at com.fasterxml.jackson.databind.DeserializationContext.findRootValueDeserializer(DeserializationContext.java:689)
        at com.fasterxml.jackson.databind.ObjectMapper._findRootDeserializer(ObjectMapper.java:5169)
        at com.fasterxml.jackson.databind.ObjectMapper._readMapAndClose(ObjectMapper.java:5039)
        at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3954)
        at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3922)
        at dev.snowdrop.jackson.httpheader.issue.SimpleSettingsXmlTest.shouldParseXML(SimpleSettingsXmlTest.java:66)

[INFO] 
[INFO] Results:
[INFO] 
[ERROR] Errors: 
[ERROR]   SimpleSettingsXmlTest.shouldParseXML:66 » InvalidDefinition Duplicate property 'httpHeaders' for [simple type, class dev.snowdrop.jackson.httpheader.issue.MavenSettingsSimplified$ServerConfiguration]
 at [Source: (StringReader); line: 1, column: 1]

Snapshot

    public static class ServerConfiguration {

        @JsonIgnore
        private final @Nullable List<HttpHeader> httpHeaders;
        private final @Nullable Long timeout;

        @JsonCreator
        public ServerConfiguration(@JsonProperty("httpHeaders") @Nullable List<HttpHeader> httpHeaders, @JsonProperty("timeout") @Nullable Long timeout) {
            this.httpHeaders = httpHeaders;
            this.timeout = timeout;
        }

        @JacksonXmlProperty(
            localName = "property"
        )
        @JacksonXmlElementWrapper(
            localName = "httpHeaders",
            useWrapping = true
        )
        public @Nullable List<HttpHeader> getHttpHeaders() {
            return this.httpHeaders;
        }

        public @Nullable Long getTimeout() {
            return this.timeout;
        }

        public ServerConfiguration withHttpHeaders(final @Nullable List<HttpHeader> httpHeaders) {
            return this.httpHeaders == httpHeaders ? this : new ServerConfiguration(httpHeaders, this.timeout);
        }

        public ServerConfiguration withTimeout(final @Nullable Long timeout) {
            return this.timeout == timeout ? this : new ServerConfiguration(this.httpHeaders, timeout);
        }
    }

[cmoulliard]

I was able to fix my issue using the following model definition. I will check if it can be used/combined with what lombok generates now within the openrewrite project

    public static class ServerConfiguration {

        private @Nullable List<HttpHeader> httpHeaders;
        private @Nullable Long timeout;

        public ServerConfiguration() {}

        @JacksonXmlProperty(
            localName = "property"
        )
        @JacksonXmlElementWrapper(
            localName = "httpHeaders",
            useWrapping = true
        )
        public @Nullable List<HttpHeader> getHttpHeaders() {
            return this.httpHeaders;
        }

        public @Nullable Long getTimeout() {
            return this.timeout;
        }

        public void setHttpHeaders(@Nullable List<HttpHeader> httpHeaders) {
            this.httpHeaders = httpHeaders;
        }

        public void setTimeout(@Nullable Long timeout) {
            this.timeout = timeout;
        }
    }

    public static class HttpHeader {
        private final String name;
        private final String value;

        @JsonCreator
        public HttpHeader(@JsonProperty("name") String name, @JsonProperty("value") String value) {
            this.name = name;
            this.value = value;
        }

        public String getName() {
            return this.name;
        }

        public String getValue() {
            return this.value;
        }

        public HttpHeader withName(final String name) {
            return this.name == name ? this : new HttpHeader(name, this.value);
        }

        public HttpHeader withValue(final String value) {
            return this.value == value ? this : new HttpHeader(this.name, value);
        }
    }

[cowtowncoder]

Added a simplified failing test via #808.

[cowtowncoder]

Fixed via #806.