NMS-20107: versioned group management API and PrimeVue Manage Groups page

opennms-webapp-rest/src/main/java/org/opennms/web/rest/v2/api/GroupsRestApi.java

@@ -0,0 +1,83 @@
+/*
+ * Licensed to The OpenNMS Group, Inc (TOG) under one or more
+ * contributor license agreements.  See the LICENSE.md file
+ * distributed with this work for additional information
+ * regarding copyright ownership.
+ *
+ * TOG licenses this file to You under the GNU Affero General
+ * Public License Version 3 (the "License") or (at your option)
+ * any later version.  You may not use this file except in
+ * compliance with the License.  You may obtain a copy of the
+ * License at:
+ *
+ *      https://www.gnu.org/licenses/agpl-3.0.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied.  See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.opennms.web.rest.v2.api;
+
+import javax.ws.rs.Consumes;
+import javax.ws.rs.DELETE;
+import javax.ws.rs.GET;
+import javax.ws.rs.POST;
+import javax.ws.rs.PUT;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.SecurityContext;
+
+import org.opennms.web.rest.v2.model.GroupDto;
+import org.opennms.web.rest.v2.model.GroupRenameRequest;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+
+/**
+ * Versioned group management API backed by groups.xml. Admin-only
+ * (enforced by Spring Security and in-code).
+ */
+@Path("groups")
+@Tag(name = "Groups", description = "Group Management API")
+public interface GroupsRestApi {
+
+    @GET
+    @Produces(MediaType.APPLICATION_JSON)
+    @Operation(summary = "List all groups", operationId = "listGroups")
+    Response listGroups(@Context SecurityContext securityContext);
+
+    @GET
+    @Path("{name}")
+    @Produces(MediaType.APPLICATION_JSON)
+    @Operation(summary = "Get one group", operationId = "getGroup")
+    Response getGroup(@Context SecurityContext securityContext, @PathParam("name") String name);
+
+    @POST
+    @Consumes(MediaType.APPLICATION_JSON)
+    @Operation(summary = "Create a group", operationId = "createGroup")
+    Response createGroup(@Context SecurityContext securityContext, GroupDto group);
+
+    @PUT
+    @Path("{name}")
+    @Consumes(MediaType.APPLICATION_JSON)
+    @Operation(summary = "Update a group (fields not carried by the API are preserved; the user list order drives notification escalation)", operationId = "updateGroup")
+    Response updateGroup(@Context SecurityContext securityContext, @PathParam("name") String name, GroupDto group);
+
+    @POST
+    @Path("{name}/rename")
+    @Consumes(MediaType.APPLICATION_JSON)
+    @Operation(summary = "Rename a group (on-call roles referencing it follow the rename)", operationId = "renameGroup")
+    Response renameGroup(@Context SecurityContext securityContext, @PathParam("name") String name, GroupRenameRequest request);
+
+    @DELETE
+    @Path("{name}")
+    @Operation(summary = "Delete a group (rejected while on-call roles reference it; the Admin group is protected)", operationId = "deleteGroup")
+    Response deleteGroup(@Context SecurityContext securityContext, @PathParam("name") String name);
+}

opennms-webapp-rest/src/main/java/org/opennms/web/rest/v2/model/GroupDto.java

@@ -0,0 +1,85 @@
+/*
+ * Licensed to The OpenNMS Group, Inc (TOG) under one or more
+ * contributor license agreements.  See the LICENSE.md file
+ * distributed with this work for additional information
+ * regarding copyright ownership.
+ *
+ * TOG licenses this file to You under the GNU Affero General
+ * Public License Version 3 (the "License") or (at your option)
+ * any later version.  You may not use this file except in
+ * compliance with the License.  You may obtain a copy of the
+ * License at:
+ *
+ *      https://www.gnu.org/licenses/agpl-3.0.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied.  See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.opennms.web.rest.v2.model;
+
+import java.util.List;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+
+/**
+ * A group as exposed by the v2 user management API. Field names mirror
+ * groups.xml where they overlap. The user list is ordered — the order drives
+ * notification escalation. Fields the API does not expose (default-map) are
+ * preserved server-side on update; list fields default to null (not empty) so
+ * a request body that omits them means "preserve".
+ */
+@XmlRootElement(name = "group")
+@XmlAccessorType(XmlAccessType.FIELD)
+public class GroupDto {
+
+    @XmlElement(name = "name")
+    private String name;
+
+    @XmlElement(name = "comments")
+    private String comments;
+
+    @XmlElement(name = "user")
+    private List<String> users;
+
+    @XmlElement(name = "duty-schedule")
+    private List<String> dutySchedules;
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(final String name) {
+        this.name = name;
+    }
+
+    public String getComments() {
+        return comments;
+    }
+
+    public void setComments(final String comments) {
+        this.comments = comments;
+    }
+
+    public List<String> getUsers() {
+        return users;
+    }
+
+    public void setUsers(final List<String> users) {
+        this.users = users;
+    }
+
+    public List<String> getDutySchedules() {
+        return dutySchedules;
+    }
+
+    public void setDutySchedules(final List<String> dutySchedules) {
+        this.dutySchedules = dutySchedules;
+    }
+}

opennms-webapp-rest/src/main/java/org/opennms/web/rest/v2/model/GroupRenameRequest.java

@@ -0,0 +1,43 @@
+/*
+ * Licensed to The OpenNMS Group, Inc (TOG) under one or more
+ * contributor license agreements.  See the LICENSE.md file
+ * distributed with this work for additional information
+ * regarding copyright ownership.
+ *
+ * TOG licenses this file to You under the GNU Affero General
+ * Public License Version 3 (the "License") or (at your option)
+ * any later version.  You may not use this file except in
+ * compliance with the License.  You may obtain a copy of the
+ * License at:
+ *
+ *      https://www.gnu.org/licenses/agpl-3.0.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied.  See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.opennms.web.rest.v2.model;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+
+@XmlRootElement(name = "group-rename-request")
+@XmlAccessorType(XmlAccessType.FIELD)
+public class GroupRenameRequest {
+
+    @XmlElement(name = "new-name")
+    private String newName;
+
+    public String getNewName() {
+        return newName;
+    }
+
+    public void setNewName(final String newName) {
+        this.newName = newName;
+    }
+}

opennms-webapp-rest/src/main/webapp/WEB-INF/menu/menu-template.json

@@ -411,7 +411,7 @@
         {
           "id": "manageGroups",
           "name": "Manage Groups",
-          "url": "admin/userGroupView/groups/list.htm",
+          "url": "ui/index.html#/admin/groups",
           "locationMatch": "",
           "roles": null
         },