Add initial user-lists API endpoint

cwms-data-api/src/main/java/cwms/cda/ApiServlet.java

@@ -101,6 +101,8 @@
 import cwms.cda.api.auth.ApiKeyController;
 import cwms.cda.api.auth.users.UserProfileController;
 import cwms.cda.api.auth.users.UsersController;
+import cwms.cda.api.auth.userlists.UserListController;
+import cwms.cda.api.auth.userlists.UserListMembersController;
 import cwms.cda.api.auth.users.roles.AddRoleController;
 import cwms.cda.api.auth.users.roles.DeleteRolesController;
 import cwms.cda.api.auth.users.roles.GetRolesController;
@@ -645,6 +647,8 @@ private void addUserManagementHandlers() {
         crud("/users/{user-name}", new UsersController(metrics), adminRoles);
         get("/roles", new GetRolesController(metrics), adminRoles);
         get("/user/profile", new UserProfileController(metrics), userRoles);
+        get("/user/list/{user-list-id}", new UserListController(metrics), adminRoles);
+        get("/user/list/{user-list-id}/members", new UserListMembersController(metrics), adminRoles);
         post("/user/{user-name}/roles/{office-id}", new AddRoleController(metrics), adminRoles);
         delete("/user/{user-name}/roles/{office-id}", new DeleteRolesController(metrics), adminRoles);
 

cwms-data-api/src/main/java/cwms/cda/api/Controllers.java

@@ -225,6 +225,7 @@ public final class Controllers {
     public static final String PROJECT_LIKE = "project-like";
 
     public static final String USERNAME_LIKE = "username-like";
+    public static final String USER_LIST_ID = "user-list-id";
     public static final String APPLICATION_ID = "application-id";
     public static final String REVOKE_EXISTING = "revoke-existing";
     public static final String REVOKE_TIMEOUT = "revoke-timeout";

cwms-data-api/src/main/java/cwms/cda/api/auth/userlists/UserListController.java

@@ -0,0 +1,93 @@
+package cwms.cda.api.auth.userlists;
+
+import static cwms.cda.api.Controllers.GET_ONE;
+import static cwms.cda.api.Controllers.OFFICE;
+import static cwms.cda.api.Controllers.STATUS_200;
+import static cwms.cda.api.Controllers.USER_LIST_ID;
+import static cwms.cda.data.dao.JooqDao.getDslContext;
+
+import com.codahale.metrics.MetricRegistry;
+import com.codahale.metrics.Timer;
+import cwms.cda.api.Controllers;
+import cwms.cda.api.errors.NotFoundException;
+import cwms.cda.api.errors.RequiredQueryParameterException;
+import cwms.cda.data.dao.UserListDao;
+import cwms.cda.data.dto.Office;
+import cwms.cda.data.dto.auth.userlists.UserList;
+import cwms.cda.formatters.ContentType;
+import cwms.cda.formatters.Formats;
+import io.javalin.core.util.Header;
+import io.javalin.http.Context;
+import io.javalin.http.Handler;
+import io.javalin.plugin.openapi.annotations.HttpMethod;
+import io.javalin.plugin.openapi.annotations.OpenApi;
+import io.javalin.plugin.openapi.annotations.OpenApiContent;
+import io.javalin.plugin.openapi.annotations.OpenApiParam;
+import io.javalin.plugin.openapi.annotations.OpenApiResponse;
+import io.javalin.plugin.openapi.annotations.OpenApiSecurity;
+import org.jooq.DSLContext;
+
+public final class UserListController implements Handler {
+    public static final String TAG = "User Management";
+    private final MetricRegistry metrics;
+
+    public UserListController(MetricRegistry metrics) {
+        this.metrics = metrics;
+    }
+
+    private Timer.Context markAndTime(String subject) {
+        return Controllers.markAndTime(metrics, getClass().getName(), subject);
+    }
+
+    @OpenApi(
+        pathParams = {
+            @OpenApiParam(name = USER_LIST_ID, required = true,
+                description = "The identifier of the user list to retrieve.")
+        },
+        queryParams = {
+            @OpenApiParam(name = OFFICE, required = true,
+                description = "The office that owns the requested user list.")
+        },
+        responses = {
+            @OpenApiResponse(
+                status = STATUS_200,
+                content = {
+                    @OpenApiContent(from = UserList.class, type = Formats.JSON)
+                }
+            )
+        },
+        security = {
+            @OpenApiSecurity(name = "gets overridden allows lock icon.")
+        },
+        description = "Retrieve user list metadata.",
+        method = HttpMethod.GET,
+        tags = {TAG}
+    )
+    @Override
+    public void handle(Context ctx) {
+        try (final Timer.Context ignored = markAndTime(GET_ONE)) {
+            String office = ctx.queryParam(OFFICE);
+            if (office == null || office.isBlank()) {
+                throw new RequiredQueryParameterException(OFFICE);
+            }
+
+            final String officeId = ctx.queryParamAsClass(OFFICE, String.class)
+                    .check(Office::validOfficeNotNull, "Invalid office provided")
+                    .get();
+
+            String userListId = ctx.pathParam(USER_LIST_ID);
+            DSLContext dsl = getDslContext(ctx);
+            UserListDao dao = new UserListDao(dsl);
+            UserList userList = dao.getUserList(officeId, userListId)
+                    .orElseThrow(() -> new NotFoundException("User list not found: "
+                            + officeId + "/" + userListId));
+
+            String formatHeader = ctx.header(Header.ACCEPT);
+            ContentType contentType = Formats.parseHeader(formatHeader, UserList.class);
+            String result = Formats.format(contentType, userList);
+
+            ctx.result(result);
+            ctx.contentType(contentType.toString());
+        }
+    }
+}

cwms-data-api/src/main/java/cwms/cda/api/auth/userlists/UserListMembersController.java

@@ -0,0 +1,90 @@
+package cwms.cda.api.auth.userlists;
+
+import static cwms.cda.api.Controllers.GET_ONE;
+import static cwms.cda.api.Controllers.OFFICE;
+import static cwms.cda.api.Controllers.STATUS_200;
+import static cwms.cda.api.Controllers.USER_LIST_ID;
+import static cwms.cda.data.dao.JooqDao.getDslContext;
+
+import com.codahale.metrics.MetricRegistry;
+import com.codahale.metrics.Timer;
+import cwms.cda.api.Controllers;
+import cwms.cda.api.errors.RequiredQueryParameterException;
+import cwms.cda.data.dao.UserListDao;
+import cwms.cda.data.dto.Office;
+import cwms.cda.data.dto.auth.userlists.UserListMembers;
+import cwms.cda.formatters.ContentType;
+import cwms.cda.formatters.Formats;
+import io.javalin.core.util.Header;
+import io.javalin.http.Context;
+import io.javalin.http.Handler;
+import io.javalin.plugin.openapi.annotations.HttpMethod;
+import io.javalin.plugin.openapi.annotations.OpenApi;
+import io.javalin.plugin.openapi.annotations.OpenApiContent;
+import io.javalin.plugin.openapi.annotations.OpenApiParam;
+import io.javalin.plugin.openapi.annotations.OpenApiResponse;
+import io.javalin.plugin.openapi.annotations.OpenApiSecurity;
+import org.jooq.DSLContext;
+
+public final class UserListMembersController implements Handler {
+    public static final String TAG = "User Management";
+    private final MetricRegistry metrics;
+
+    public UserListMembersController(MetricRegistry metrics) {
+        this.metrics = metrics;
+    }
+
+    private Timer.Context markAndTime(String subject) {
+        return Controllers.markAndTime(metrics, getClass().getName(), subject);
+    }
+
+    @OpenApi(
+        pathParams = {
+            @OpenApiParam(name = USER_LIST_ID, required = true,
+                description = "The identifier of the user list to retrieve members for.")
+        },
+        queryParams = {
+            @OpenApiParam(name = OFFICE, required = true,
+                description = "The office that owns the requested user list.")
+        },
+        responses = {
+            @OpenApiResponse(
+                status = STATUS_200,
+                content = {
+                    @OpenApiContent(from = UserListMembers.class, type = Formats.JSON)
+                }
+            )
+        },
+        security = {
+            @OpenApiSecurity(name = "gets overridden allows lock icon.")
+        },
+        description = "Retrieve the members of a user list.",
+        method = HttpMethod.GET,
+        tags = {TAG}
+    )
+    @Override
+    public void handle(Context ctx) {
+        try (final Timer.Context ignored = markAndTime(GET_ONE)) {
+            String office = ctx.queryParam(OFFICE);
+            if (office == null || office.isBlank()) {
+                throw new RequiredQueryParameterException(OFFICE);
+            }
+
+            office = ctx.queryParamAsClass(OFFICE, String.class)
+                    .check(Office::validOfficeNotNull, "Invalid office provided")
+                    .get();
+
+            String userListId = ctx.pathParam(USER_LIST_ID);
+            DSLContext dsl = getDslContext(ctx);
+            UserListDao dao = new UserListDao(dsl);
+            UserListMembers members = dao.getMembers(office, userListId);
+
+            String formatHeader = ctx.header(Header.ACCEPT);
+            ContentType contentType = Formats.parseHeader(formatHeader, UserListMembers.class);
+            String result = Formats.format(contentType, members);
+
+            ctx.result(result);
+            ctx.contentType(contentType.toString());
+        }
+    }
+}

cwms-data-api/src/main/java/cwms/cda/data/dao/UserListDao.java

@@ -0,0 +1,107 @@
+package cwms.cda.data.dao;
+
+import static org.jooq.impl.DSL.field;
+import static org.jooq.impl.DSL.name;
+import static org.jooq.impl.DSL.selectOne;
+import static org.jooq.impl.DSL.table;
+import static org.jooq.impl.DSL.upper;
+
+import cwms.cda.api.errors.NotFoundException;
+import cwms.cda.data.dto.auth.userlists.UserList;
+import cwms.cda.data.dto.auth.userlists.UserListMember;
+import cwms.cda.data.dto.auth.userlists.UserListMembers;
+import java.sql.Timestamp;
+import java.util.List;
+import java.util.Optional;
+import org.jooq.Condition;
+import org.jooq.DSLContext;
+import org.jooq.Field;
+import org.jooq.Table;
+
+public final class UserListDao extends Dao<UserListMember> {
+
+    private final Table<?> avUserListMembers = table(name("CWMS_20", "AV_USER_LIST_MEMBERS")).as("ulm");
+    private final Table<?> atUserLists = table(name("CWMS_20", "AT_USER_LISTS")).as("ul");
+    private final Table<?> cwmsOffice = table(name("CWMS_20", "CWMS_OFFICE")).as("co");
+
+    public UserListDao(DSLContext dsl) {
+        super(dsl);
+    }
+
+    @Override
+    public Optional<UserListMember> getByUniqueName(String uniqueName, String office) {
+        return Optional.empty();
+    }
+
+    public Optional<UserList> getUserList(String officeId, String userListId) {
+        Field<Long> listOfficeCode = field(name(atUserLists.getName(), "DB_OFFICE_CODE"), Long.class);
+        Field<String> listUserListId = field(name(atUserLists.getName(), "USER_LIST_ID"), String.class);
+        Field<String> listDescription = field(name(atUserLists.getName(), "USER_LIST_DESC"), String.class);
+        Field<String> listOwner = field(name(atUserLists.getName(), "OWNED_BY_USERID"), String.class);
+        Field<Timestamp> listCreatedAt = field(name(atUserLists.getName(), "CREATED_AT"), Timestamp.class);
+        Field<Timestamp> listUpdatedAt = field(name(atUserLists.getName(), "UPDATED_AT"), Timestamp.class);
+        Field<Long> officeCode = field(name(cwmsOffice.getName(), "OFFICE_CODE"), Long.class);
+        Field<String> officeName = field(name(cwmsOffice.getName(), "OFFICE_ID"), String.class);
+
+        return dsl.select(officeName, listUserListId, listDescription, listOwner, listCreatedAt, listUpdatedAt)
+                .from(atUserLists)
+                .join(cwmsOffice).on(listOfficeCode.eq(officeCode))
+                .where(ignoreCaseEq(officeName, officeId))
+                .and(ignoreCaseEq(listUserListId, userListId))
+                .fetchOptional(record -> new UserList(
+                        record.get(officeName),
+                        record.get(listUserListId),
+                        record.get(listDescription),
+                        record.get(listOwner),
+                        record.get(listCreatedAt).toInstant(),
+                        Optional.ofNullable(record.get(listUpdatedAt)).map(Timestamp::toInstant).orElse(null)
+                ));
+    }
+
+    public UserListMembers getMembers(String officeId, String userListId) {
+        if (!userListExists(officeId, userListId)) {
+            throw new NotFoundException("User list not found: " + officeId + "/" + userListId);
+        }
+
+        Field<String> viewOfficeId = field(name(avUserListMembers.getName(), "OFFICE_ID"), String.class);
+        Field<String> viewUserListId = field(name(avUserListMembers.getName(), "USER_LIST_ID"), String.class);
+        Field<String> viewUserId = field(name(avUserListMembers.getName(), "USER_ID"), String.class);
+        Field<String> viewFullName = field(name(avUserListMembers.getName(), "FULL_NAME"), String.class);
+        Field<String> viewEmail = field(name(avUserListMembers.getName(), "EMAIL"), String.class);
+
+        List<UserListMember> members = dsl.select(viewOfficeId, viewUserListId, viewUserId, viewFullName,
+                    viewEmail)
+                .from(avUserListMembers)
+                .where(ignoreCaseEq(viewOfficeId, officeId))
+                .and(ignoreCaseEq(viewUserListId, userListId))
+                .orderBy(viewFullName.asc().nullsLast(), viewUserId.asc())
+                .fetch(record -> new UserListMember(
+                        record.get(viewOfficeId),
+                        record.get(viewUserListId),
+                        record.get(viewUserId),
+                        record.get(viewFullName),
+                        record.get(viewEmail)
+                ));
+
+        return new UserListMembers(members);
+    }
+
+    private boolean userListExists(String officeId, String userListId) {
+        Field<Long> listOfficeCode = field(name(atUserLists.getName(), "DB_OFFICE_CODE"), Long.class);
+        Field<String> listUserListId = field(name(atUserLists.getName(), "USER_LIST_ID"), String.class);
+        Field<Long> officeCode = field(name(cwmsOffice.getName(), "OFFICE_CODE"), Long.class);
+        Field<String> officeName = field(name(cwmsOffice.getName(), "OFFICE_ID"), String.class);
+
+        return dsl.fetchExists(
+                selectOne()
+                        .from(atUserLists)
+                        .join(cwmsOffice).on(listOfficeCode.eq(officeCode))
+                        .where(ignoreCaseEq(officeName, officeId))
+                        .and(ignoreCaseEq(listUserListId, userListId))
+        );
+    }
+
+    private static Condition ignoreCaseEq(Field<String> field, String value) {
+        return upper(field).eq(value.toUpperCase());
+    }
+}

cwms-data-api/src/main/java/cwms/cda/data/dto/auth/userlists/UserList.java

@@ -0,0 +1,72 @@
+package cwms.cda.data.dto.auth.userlists;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import cwms.cda.data.dto.CwmsDTOBase;
+import cwms.cda.formatters.Formats;
+import cwms.cda.formatters.annotations.FormattableWith;
+import cwms.cda.formatters.json.JsonV1;
+import io.swagger.v3.oas.annotations.media.Schema;
+import java.time.Instant;
+
+@JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
+@FormattableWith(contentType = Formats.JSONV1, formatter = JsonV1.class,
+    aliases = {Formats.DEFAULT, Formats.JSON})
+public final class UserList extends CwmsDTOBase {
+
+    @JsonProperty(required = true)
+    @Schema(description = "The owning CWMS office identifier for the user list.")
+    private final String officeId;
+
+    @JsonProperty(required = true)
+    @Schema(description = "The identifier of the user list.")
+    private final String userListId;
+
+    @Schema(description = "The user list description.")
+    private final String description;
+
+    @Schema(description = "The user id of the list owner.")
+    private final String ownedByUserId;
+
+    @JsonProperty(required = true)
+    @Schema(description = "The time the user list was created.")
+    private final Instant createdAt;
+
+    @Schema(description = "The time the user list was last updated.")
+    private final Instant updatedAt;
+
+    public UserList(String officeId, String userListId, String description, String ownedByUserId,
+            Instant createdAt, Instant updatedAt) {
+        this.officeId = officeId;
+        this.userListId = userListId;
+        this.description = description;
+        this.ownedByUserId = ownedByUserId;
+        this.createdAt = createdAt;
+        this.updatedAt = updatedAt;
+    }
+
+    public String getOfficeId() {
+        return officeId;
+    }
+
+    public String getUserListId() {
+        return userListId;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public String getOwnedByUserId() {
+        return ownedByUserId;
+    }
+
+    public Instant getCreatedAt() {
+        return createdAt;
+    }
+
+    public Instant getUpdatedAt() {
+        return updatedAt;
+    }
+}