Defensively create collections in JAXB getters

changelog.html

@@ -46,7 +46,8 @@ <h1>
 
 <p><b>Next Release</b> at some date</p>
 <ul>
-    <li>[<a href='https://github.com/igniterealtime/openfire-restAPI-plugin/issues/127'>#127</a>] - AAdd endpoint that allows for more than one MUC room to be created with one request</li>
+    <li>[<a href='https://github.com/igniterealtime/openfire-restAPI-plugin/issues/137'>#137</a>] - Defensively create collections in JAXB getters</li>
+    <li>[<a href='https://github.com/igniterealtime/openfire-restAPI-plugin/issues/127'>#127</a>] - Add endpoint that allows for more than one MUC room to be created with one request</li>
 </ul>
 
 <p><b>1.8.3</b> July 19, 2022</p>

src/java/org/jivesoftware/openfire/plugin/rest/entity/AdminEntities.java

@@ -20,6 +20,7 @@
 
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
+import java.util.ArrayList;
 import java.util.List;
 
 @XmlRootElement(name = "admins")
@@ -37,6 +38,9 @@ public AdminEntities(List<String> admins) {
     @XmlElement(name = "admin")
     @JsonProperty(value = "admins")
     public List<String> getAdmins() {
+        if (admins == null) {
+            admins = new ArrayList<>();
+        }
         return admins;
     }
 

src/java/org/jivesoftware/openfire/plugin/rest/entity/ClusterNodeEntities.java

@@ -20,6 +20,7 @@
 import javax.annotation.Nonnull;
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
+import java.util.ArrayList;
 import java.util.List;
 
 @XmlRootElement(name = "clusterNodes")
@@ -36,6 +37,9 @@ public ClusterNodeEntities(@Nonnull final List<ClusterNodeEntity> clusterNodeEnt
     @XmlElement(name = "clusterNode")
     @JsonProperty(value = "clusterNodes")
     public List<ClusterNodeEntity> getClusterNodeEntities() {
+        if (clusterNodeEntities == null) {
+            clusterNodeEntities = new ArrayList<>();
+        }
         return clusterNodeEntities;
     }
 

src/java/org/jivesoftware/openfire/plugin/rest/entity/GroupEntities.java

@@ -18,6 +18,7 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+import java.util.ArrayList;
 import java.util.List;
 
 import javax.xml.bind.annotation.XmlElement;
@@ -56,6 +57,9 @@ public GroupEntities(List<GroupEntity> groups) {
     @XmlElement(name = "group")
     @JsonProperty(value = "groups")
     public List<GroupEntity> getGroups() {
+        if (groups == null) {
+            groups = new ArrayList<>();
+        }
         return groups;
     }
 

src/java/org/jivesoftware/openfire/plugin/rest/entity/GroupEntity.java

@@ -20,6 +20,7 @@
 import io.swagger.v3.oas.annotations.media.ArraySchema;
 import io.swagger.v3.oas.annotations.media.Schema;
 
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
 
@@ -121,6 +122,9 @@ public void setDescription(String description) {
     @JsonProperty(value = "admins")
     @ArraySchema(schema = @Schema(example = "jane.smith"), arraySchema = @Schema(description = "List of admins of the group"))
     public List<String> getAdmins() {
+        if (admins == null) {
+            admins = new ArrayList<>();
+        }
         return admins;
     }
 
@@ -134,6 +138,9 @@ public List<String> getAdmins() {
     @JsonProperty(value = "members")
     @ArraySchema(schema = @Schema(example = "john.jones"), arraySchema = @Schema(description = "List of members of the group"))
     public List<String> getMembers() {
+        if (members == null) {
+            members = new ArrayList<>();
+        }
         return members;
     }
 

src/java/org/jivesoftware/openfire/plugin/rest/entity/MUCRoomEntities.java

@@ -18,6 +18,7 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+import java.util.ArrayList;
 import java.util.List;
 
 import javax.xml.bind.annotation.XmlElement;
@@ -37,6 +38,9 @@ public MUCRoomEntities(List<MUCRoomEntity> mucRooms) {
     @XmlElement(name = "chatRoom")
     @JsonProperty(value = "chatRooms")
     public List<MUCRoomEntity> getMucRooms() {
+        if (mucRooms == null) {
+            mucRooms = new ArrayList<>();
+        }
         return mucRooms;
     }
 

src/java/org/jivesoftware/openfire/plugin/rest/entity/MUCRoomEntity.java

@@ -17,7 +17,9 @@
 package org.jivesoftware.openfire.plugin.rest.entity;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
 
+import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
 
@@ -259,20 +261,29 @@ public void setModerated(boolean moderated) {
     @XmlElementWrapper(name = "broadcastPresenceRoles")
     @JsonProperty(value = "broadcastPresenceRoles")
     public List<String> getBroadcastPresenceRoles() {
+        if (broadcastPresenceRoles == null) {
+            broadcastPresenceRoles = new ArrayList<>();
+        }
         return broadcastPresenceRoles;
     }
 
     @XmlElementWrapper(name = "owners")
     @XmlElement(name = "owner")
     @JsonProperty(value = "owners")
     public List<String> getOwners() {
+        if (owners == null) {
+            owners = new ArrayList<>();
+        }
         return owners;
     }
 
     @XmlElementWrapper(name = "ownerGroups")
     @XmlElement(name = "ownerGroup")
     @JsonProperty(value = "ownerGroups")
     public List<String> getOwnerGroups() {
+        if (ownerGroups == null) {
+            ownerGroups = new ArrayList<>();
+        }
         return ownerGroups;
     }
 
@@ -288,13 +299,19 @@ public void setOwnerGroups(List<String> ownerGroups) {
     @XmlElement(name = "member")
     @JsonProperty(value = "members")
     public List<String> getMembers() {
+        if (members == null) {
+            members = new ArrayList<>();
+        }
         return members;
     }
 
     @XmlElementWrapper(name = "memberGroups")
     @XmlElement(name = "memberGroup")
     @JsonProperty(value = "memberGroups")
     public List<String> getmemberGroups() {
+        if (memberGroups == null) {
+            memberGroups = new ArrayList<>();
+        }
         return memberGroups;
     }
 
@@ -310,13 +327,19 @@ public void setMemberGroups(List<String> memberGroups) {
     @XmlElement(name = "outcast")
     @JsonProperty(value = "outcasts")
     public List<String> getOutcasts() {
+        if (outcasts == null) {
+            outcasts = new ArrayList<>();
+        }
         return outcasts;
     }
 
     @XmlElementWrapper(name = "outcastGroups")
     @XmlElement(name = "outcastGroup")
     @JsonProperty(value = "outcastGroups")
     public List<String> getoutcastGroups() {
+        if (outcastGroups == null) {
+            outcastGroups = new ArrayList<>();
+        }
         return outcastGroups;
     }
 
@@ -332,13 +355,19 @@ public void setOutcastGroups(List<String> outcastGroups) {
     @XmlElement(name = "admin")
     @JsonProperty(value = "admins")
     public List<String> getAdmins() {
+        if (admins == null) {
+            admins = new ArrayList<>();
+        }
         return admins;
     }
 
     @XmlElementWrapper(name = "adminGroups")
     @XmlElement(name = "adminGroup")
     @JsonProperty(value = "adminGroups")
     public List<String> getadminGroups() {
+        if (adminGroups == null) {
+            adminGroups = new ArrayList<>();
+        }
         return adminGroups;
     }
 

src/java/org/jivesoftware/openfire/plugin/rest/entity/MUCRoomMessageEntities.java

@@ -18,6 +18,7 @@
 
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
+import java.util.ArrayList;
 import java.util.List;
 
 @XmlRootElement(name = "messages")
@@ -33,6 +34,9 @@ public MUCRoomMessageEntities(List<MUCRoomMessageEntity> messages) {
 
     @XmlElement(name = "message")
     public List<MUCRoomMessageEntity> getMessages() {
+        if (messages == null) {
+            messages = new ArrayList<>();
+        }
         return messages;
     }
 

src/java/org/jivesoftware/openfire/plugin/rest/entity/MemberEntities.java

@@ -20,6 +20,7 @@
 
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
+import java.util.ArrayList;
 import java.util.List;
 
 @XmlRootElement(name = "members")
@@ -37,6 +38,9 @@ public MemberEntities(List<String> members) {
     @XmlElement(name = "member")
     @JsonProperty(value = "members")
     public List<String> getMembers() {
+        if (members == null) {
+            members = new ArrayList<>();
+        }
         return members;
     }
 

src/java/org/jivesoftware/openfire/plugin/rest/entity/OccupantEntities.java

@@ -20,6 +20,7 @@
 
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
+import java.util.ArrayList;
 import java.util.List;
 
 @XmlRootElement(name = "occupants")
@@ -36,6 +37,9 @@ public OccupantEntities(List<OccupantEntity> occupants) {
     @XmlElement(name = "occupant")
     @JsonProperty(value = "occupants")
     public List<OccupantEntity> getOccupants() {
+        if (occupants == null) {
+            occupants = new ArrayList<>();
+        }
         return occupants;
     }
 

src/java/org/jivesoftware/openfire/plugin/rest/entity/OutcastEntities.java

@@ -20,6 +20,7 @@
 
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
+import java.util.ArrayList;
 import java.util.List;
 
 @XmlRootElement(name = "outcasts")
@@ -37,6 +38,9 @@ public OutcastEntities(List<String> outcasts) {
     @XmlElement(name = "outcast")
     @JsonProperty(value = "outcasts")
     public List<String> getOutcasts() {
+        if (outcasts == null) {
+            outcasts = new ArrayList<>();
+        }
         return outcasts;
     }
 

src/java/org/jivesoftware/openfire/plugin/rest/entity/OwnerEntities.java

@@ -20,6 +20,7 @@
 
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
+import java.util.ArrayList;
 import java.util.List;
 
 @XmlRootElement(name = "owners")
@@ -37,6 +38,9 @@ public OwnerEntities(List<String> owners) {
     @XmlElement(name = "owner")
     @JsonProperty(value = "owners")
     public List<String> getOwners() {
+        if (owners == null) {
+            owners = new ArrayList<>();
+        }
         return owners;
     }
 

src/java/org/jivesoftware/openfire/plugin/rest/entity/ParticipantEntities.java

@@ -18,6 +18,7 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+import java.util.ArrayList;
 import java.util.List;
 
 import javax.xml.bind.annotation.XmlElement;
@@ -37,6 +38,9 @@ public ParticipantEntities(List<ParticipantEntity> participants) {
     @XmlElement(name = "participant")
     @JsonProperty(value = "participants")
     public List<ParticipantEntity> getParticipants() {
+        if (participants == null) {
+            participants = new ArrayList<>();
+        }
         return participants;
     }
 

src/java/org/jivesoftware/openfire/plugin/rest/entity/RoomCreationResultEntities.java

@@ -68,6 +68,9 @@ public void addResult(RoomCreationResultEntity resultToAdd) {
     @JsonProperty(value = "success")
     @Schema(description = "All creation results of type success")
     public List<RoomCreationResultEntity> getSuccessResults() {
+        if (successResults == null) {
+            successResults = new ArrayList<>();
+        }
         return successResults;
     }
 
@@ -76,6 +79,9 @@ public List<RoomCreationResultEntity> getSuccessResults() {
     @JsonProperty(value = "failure")
     @Schema(description = "All creation results of type failure")
     public List<RoomCreationResultEntity> getFailureResults() {
+        if (failureResults == null) {
+            failureResults = new ArrayList<>();
+        }
         return failureResults;
     }
 
@@ -84,6 +90,9 @@ public List<RoomCreationResultEntity> getFailureResults() {
     @JsonProperty(value = "other")
     @Schema(description = "All creation results of a type other than success or failure")
     public List<RoomCreationResultEntity> getOtherResults() {
+        if (otherResults == null) {
+            otherResults = new ArrayList<>();
+        }
         return otherResults;
     }
 }

src/java/org/jivesoftware/openfire/plugin/rest/entity/RosterEntities.java

@@ -16,6 +16,7 @@
 
 package org.jivesoftware.openfire.plugin.rest.entity;
 
+import java.util.ArrayList;
 import java.util.List;
 
 import javax.xml.bind.annotation.XmlElement;
@@ -54,6 +55,9 @@ public RosterEntities(List<RosterItemEntity> roster) {
      */
     @XmlElement(name = "rosterItem")
     public List<RosterItemEntity> getRoster() {
+        if (roster == null) {
+            roster = new ArrayList<>();
+        }
         return roster;
     }
 

src/java/org/jivesoftware/openfire/plugin/rest/entity/RosterItemEntity.java

@@ -18,6 +18,7 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+import java.util.ArrayList;
 import java.util.List;
 
 import javax.xml.bind.annotation.XmlElement;
@@ -136,6 +137,9 @@ public void setSubscriptionType(int subscriptionType) {
     @XmlElementWrapper(name = "groups")
     @JsonProperty(value = "groups")
     public List<String> getGroups() {
+        if (groups == null) {
+            groups = new ArrayList<>();
+        }
         return groups;
     }