1 /*
2 * Copyright (c) 2022-2023. Roland T. Lichti, Kaiserpfalz EDV-Service.
3 *
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18 package de.kaiserpfalzedv.commons.api.resources;
19
20 import java.util.UUID;
21
22 import org.eclipse.microprofile.openapi.annotations.media.Schema;
23
24 import jakarta.validation.constraints.NotNull;
25 import jakarta.validation.constraints.Pattern;
26
27 /**
28 * HasUid --
29 *
30 * @author klenkes74 {@literal <rlichti@kaiserpfalz-edv.de>}
31 * @version 4.0.0 2024-09-08
32 * @since 3.3.3-3 2024-09-08
33 */
34 public interface HasUid {
35 public final String VALID_UID_MSG = "The ID must be a valid UUID.";
36 public final String VALID_UID_PATTERN = "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}";
37
38 @Schema(
39 name = "id",
40 description = "The id of a resource.",
41 pattern = VALID_UID_PATTERN
42 )
43 @NotNull
44 @Pattern(regexp = VALID_UID_PATTERN, message = VALID_UID_MSG)
45 UUID getUid();
46 }