Compare commits
19 Commits
1b4e6ca239
...
2bc7a2c5e3
Author | SHA1 | Date | |
---|---|---|---|
2bc7a2c5e3 | |||
![]() |
6c69bc63c6 | ||
85ac72648f | |||
1281415c48 | |||
![]() |
a4521853c3 | ||
![]() |
abe2dd9480 | ||
![]() |
b7af0b4575 | ||
![]() |
5412eadf2e | ||
![]() |
d5e2e0f5b3 | ||
28ab6c49d4 | |||
260a3abd13 | |||
895e8c2b37 | |||
1673f1680b | |||
04a82250d8 | |||
0326bde209 | |||
c1ccaf20ec | |||
2174d7689f | |||
15113807b3 | |||
ffdc6c1249 |
@ -30,15 +30,6 @@
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry kind="src" output="target/test-classes" path="target/generated-test-sources/test-annotations">
|
||||
<attributes>
|
||||
<attribute name="test" value="true"/>
|
||||
<attribute name="optional" value="true"/>
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
<attribute name="ignore_optional_problems" value="true"/>
|
||||
<attribute name="m2e-apt" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry kind="src" path="target/generated-sources/annotations">
|
||||
<attributes>
|
||||
<attribute name="optional" value="true"/>
|
||||
|
28
.github/dependabot.yml
vendored
28
.github/dependabot.yml
vendored
@ -1,12 +1,24 @@
|
||||
# To get started with Dependabot version updates, you'll need to specify which
|
||||
# package ecosystems to update and where the package manifests are located.
|
||||
# Please see the documentation for all configuration options:
|
||||
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
|
||||
|
||||
---
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "" # See documentation for possible values
|
||||
directory: "/" # Location of package manifests
|
||||
- package-ecosystem: "github-actions"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
interval: "daily"
|
||||
time: "05:00"
|
||||
timezone: "Europe/Paris"
|
||||
commit-message:
|
||||
prefix: "[DEV-OPS] (dependabot) "
|
||||
assignees:
|
||||
- HeeroYui
|
||||
|
||||
- package-ecosystem: "maven"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "daily"
|
||||
time: "06:00"
|
||||
timezone: "Europe/Paris"
|
||||
commit-message:
|
||||
prefix: "[DEV-OPS] (dependabot) "
|
||||
assignees:
|
||||
- HeeroYui
|
||||
|
4
.github/workflows/check-title.yml
vendored
4
.github/workflows/check-title.yml
vendored
@ -9,6 +9,8 @@ on:
|
||||
- synchronize
|
||||
- ready_for_review
|
||||
- reopened
|
||||
- labeled
|
||||
- unlabeled
|
||||
|
||||
jobs:
|
||||
check-title:
|
||||
@ -17,7 +19,7 @@ jobs:
|
||||
- name: "Check title"
|
||||
uses: Slashgear/action-check-pr-title@v4.3.0
|
||||
with:
|
||||
regexp: "\\[(API,)?(API|DEV-OPS|DOC|FEAT|FIX|FIX\\-CI|STYLE)\\]( \\([A-Za-z0-9.\\-]+\\))? [A-Za-z0-9 ,.'\\-!]+$"
|
||||
regexp: "\\[(API,)?(API|DEV-OPS|DOC|FEAT|FIX|FIX\\-CI|STYLE)\\]( \\([A-Za-z0-9.\\-/_]+\\))? [A-Za-z0-9: ,.'\\-!/_]+$"
|
||||
helpMessage: |
|
||||
Title of the PR MUST respect format: "[{TYPE}] clear description without typos in english" with {TYPE}:
|
||||
* [API] Change API that permit to access on the application (un-compatibility only). This one can specifically added with [API,{TYPE}]
|
||||
|
87
pom.xml
87
pom.xml
@ -3,17 +3,7 @@
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<groupId>kangaroo-and-rabbit</groupId>
|
||||
<artifactId>archidata</artifactId>
|
||||
<version>0.24.0</version>
|
||||
<properties>
|
||||
<java.version>21</java.version>
|
||||
<maven.compiler.version>3.1</maven.compiler.version>
|
||||
<maven.compiler.source>21</maven.compiler.source>
|
||||
<maven.compiler.target>21</maven.compiler.target>
|
||||
<maven.dependency.version>3.1.1</maven.dependency.version>
|
||||
<jersey.version>3.1.5</jersey.version>
|
||||
<jaxb.version>2.3.1</jaxb.version>
|
||||
<istack.version>4.1.1</istack.version>
|
||||
</properties>
|
||||
<version>0.25.0</version>
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>gitea</id>
|
||||
@ -35,7 +25,7 @@
|
||||
<dependency>
|
||||
<groupId>org.glassfish.jersey</groupId>
|
||||
<artifactId>jersey-bom</artifactId>
|
||||
<version>${jersey.version}</version>
|
||||
<version>4.0.0-M2</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
@ -58,13 +48,13 @@
|
||||
<dependency>
|
||||
<groupId>com.twelvemonkeys.imageio</groupId>
|
||||
<artifactId>imageio-webp</artifactId>
|
||||
<version>3.11.0</version>
|
||||
<version>3.12.0</version>
|
||||
</dependency>
|
||||
<!-- Decode JPEG image -->
|
||||
<dependency>
|
||||
<groupId>com.twelvemonkeys.imageio</groupId>
|
||||
<artifactId>imageio-jpeg</artifactId>
|
||||
<version>3.11.0</version>
|
||||
<version>3.12.0</version>
|
||||
</dependency>
|
||||
<!-- Encode file in webp -->
|
||||
<dependency>
|
||||
@ -76,7 +66,7 @@
|
||||
<dependency>
|
||||
<groupId>org.apache.tika</groupId>
|
||||
<artifactId>tika-core</artifactId>
|
||||
<version>3.0.0-BETA2</version>
|
||||
<version>3.1.0</version>
|
||||
</dependency>
|
||||
<!-- https://mvnrepository.com/artifact/org.glassfish.jersey.media/jersey-media-multipart -->
|
||||
<dependency>
|
||||
@ -95,10 +85,19 @@
|
||||
<groupId>org.glassfish.jersey.containers</groupId>
|
||||
<artifactId>jersey-container-grizzly2-http</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.glassfish.jersey.ext</groupId>
|
||||
<artifactId>jersey-bean-validation</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>javax.xml.bind</groupId>
|
||||
<artifactId>jaxb-api</artifactId>
|
||||
<version>${jaxb.version}</version>
|
||||
<version>2.4.0-b180830.0359</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.sun.xml.bind</groupId>
|
||||
<artifactId>jaxb-impl</artifactId>
|
||||
<version>4.0.5</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.glassfish.jaxb</groupId>
|
||||
@ -110,15 +109,10 @@
|
||||
<artifactId>jakarta.ws.rs-api</artifactId>
|
||||
<version>4.0.0</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.sun.xml.bind</groupId>
|
||||
<artifactId>jaxb-impl</artifactId>
|
||||
<version>${jaxb.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.sun.istack</groupId>
|
||||
<artifactId>istack-commons-runtime</artifactId>
|
||||
<version>${istack.version}</version>
|
||||
<version>4.2.0</version>
|
||||
</dependency>
|
||||
<!-- continu to be needed ??? -->
|
||||
<dependency>
|
||||
@ -134,18 +128,18 @@
|
||||
<dependency>
|
||||
<groupId>com.fasterxml.jackson.core</groupId>
|
||||
<artifactId>jackson-databind</artifactId>
|
||||
<version>2.18.1</version>
|
||||
<version>2.18.3</version>
|
||||
</dependency>
|
||||
<!-- encode output in CSV -->
|
||||
<dependency>
|
||||
<groupId>com.fasterxml.jackson.dataformat</groupId>
|
||||
<artifactId>jackson-dataformat-csv</artifactId>
|
||||
<version>2.18.1</version>
|
||||
<version>2.18.3</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.fasterxml.jackson.datatype</groupId>
|
||||
<artifactId>jackson-datatype-jsr310</artifactId>
|
||||
<version>2.18.1</version>
|
||||
<version>2.18.3</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>jakarta.servlet</groupId>
|
||||
@ -157,18 +151,18 @@
|
||||
<dependency>
|
||||
<groupId>com.mysql</groupId>
|
||||
<artifactId>mysql-connector-j</artifactId>
|
||||
<version>9.0.0</version>
|
||||
<version>9.2.0</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.xerial</groupId>
|
||||
<artifactId>sqlite-jdbc</artifactId>
|
||||
<version>3.46.1.0</version>
|
||||
<version>3.49.1.0</version>
|
||||
</dependency>
|
||||
<!-- Interface for JWT token -->
|
||||
<dependency>
|
||||
<groupId>com.nimbusds</groupId>
|
||||
<artifactId>nimbus-jose-jwt</artifactId>
|
||||
<version>9.41.1</version>
|
||||
<version>10.0.2</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>jakarta.persistence</groupId>
|
||||
@ -179,32 +173,32 @@
|
||||
<dependency>
|
||||
<groupId>io.swagger.core.v3</groupId>
|
||||
<artifactId>swagger-jaxrs2-jakarta</artifactId>
|
||||
<version>2.2.23</version>
|
||||
<version>2.2.29</version>
|
||||
</dependency>
|
||||
<!-- spotbug tooling -->
|
||||
<dependency>
|
||||
<groupId>com.github.spotbugs</groupId>
|
||||
<artifactId>spotbugs-annotations</artifactId>
|
||||
<version>4.8.6</version>
|
||||
<version>4.9.3</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
<!-- Morphia -->
|
||||
<dependency>
|
||||
<groupId>dev.morphia.morphia</groupId>
|
||||
<artifactId>morphia-core</artifactId>
|
||||
<version>2.3.0</version>
|
||||
<version>2.4.15</version>
|
||||
</dependency>
|
||||
<!-- MongoDB Java Driver -->
|
||||
<dependency>
|
||||
<groupId>org.mongodb</groupId>
|
||||
<artifactId>mongodb-driver-sync</artifactId>
|
||||
<version>4.3.0</version>
|
||||
<version>5.4.0-alpha0</version>
|
||||
</dependency>
|
||||
<!-- Bean Validation (JSR 303 / 380) -->
|
||||
<dependency>
|
||||
<groupId>org.hibernate.validator</groupId>
|
||||
<artifactId>hibernate-validator</artifactId>
|
||||
<version>7.0.0.Final</version>
|
||||
<version>9.0.0.CR1</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>javax.validation</groupId>
|
||||
@ -219,24 +213,24 @@
|
||||
<dependency>
|
||||
<groupId>org.junit.jupiter</groupId>
|
||||
<artifactId>junit-jupiter-api</artifactId>
|
||||
<version>5.11.0</version>
|
||||
<version>5.12.1</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.junit.jupiter</groupId>
|
||||
<artifactId>junit-jupiter-engine</artifactId>
|
||||
<version>5.11.0</version>
|
||||
<version>5.12.1</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>net.revelc.code.formatter</groupId>
|
||||
<artifactId>formatter-maven-plugin</artifactId>
|
||||
<version>2.24.1</version>
|
||||
<version>2.25.0</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-checkstyle-plugin</artifactId>
|
||||
<version>3.5.0</version>
|
||||
<version>3.6.0</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<build>
|
||||
@ -256,18 +250,17 @@
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-compiler-plugin</artifactId>
|
||||
<version>${maven.compiler.version}</version>
|
||||
<version>3.14.0</version>
|
||||
<configuration>
|
||||
<source>${maven.compiler.source}</source>
|
||||
<target>${maven.compiler.target}</target>
|
||||
<!--<encoding>${project.build.sourceEncoding}</encoding>-->
|
||||
<source>21</source>
|
||||
<target>21</target>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<!-- Create the source bundle -->
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-source-plugin</artifactId>
|
||||
<version>3.3.0</version>
|
||||
<version>3.3.1</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>attach-sources</id>
|
||||
@ -295,7 +288,7 @@
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-surefire-plugin</artifactId>
|
||||
<version>3.0.0-M5</version>
|
||||
<version>3.5.2</version>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<artifactId>maven-assembly-plugin</artifactId>
|
||||
@ -314,7 +307,7 @@
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>3.2.0</version>
|
||||
<version>3.3.0</version>
|
||||
<configuration>
|
||||
<show>private</show>
|
||||
<nohelp>true</nohelp>
|
||||
@ -324,7 +317,7 @@
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-checkstyle-plugin</artifactId>
|
||||
<version>3.3.1</version>
|
||||
<version>3.6.0</version>
|
||||
<configuration>
|
||||
<configLocation>CheckStyle.xml</configLocation>
|
||||
<consoleOutput>true</consoleOutput>
|
||||
@ -336,7 +329,7 @@
|
||||
<plugin>
|
||||
<groupId>net.revelc.code.formatter</groupId>
|
||||
<artifactId>formatter-maven-plugin</artifactId>
|
||||
<version>2.23.0</version>
|
||||
<version>2.24.1</version>
|
||||
<configuration>
|
||||
<encoding>UTF-8</encoding>
|
||||
<lineEnding>LF</lineEnding>
|
||||
@ -385,7 +378,7 @@
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>3.2.0</version>
|
||||
<version>3.3.0</version>
|
||||
<configuration>
|
||||
<show>public</show>
|
||||
</configuration>
|
||||
|
@ -2,6 +2,7 @@ package org.kar.archidata.annotation;
|
||||
|
||||
import java.lang.annotation.Annotation;
|
||||
import java.lang.reflect.Field;
|
||||
import java.lang.reflect.Parameter;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
@ -41,6 +42,24 @@ import jakarta.ws.rs.DefaultValue;
|
||||
public class AnnotationTools {
|
||||
static final Logger LOGGER = LoggerFactory.getLogger(AnnotationTools.class);
|
||||
|
||||
public static <TYPE extends Annotation> TYPE get(final Parameter param, final Class<TYPE> clazz) {
|
||||
final TYPE[] annotations = param.getDeclaredAnnotationsByType(clazz);
|
||||
|
||||
if (annotations.length == 0) {
|
||||
return null;
|
||||
}
|
||||
return annotations[0];
|
||||
}
|
||||
|
||||
public static <TYPE extends Annotation> TYPE[] gets(final Parameter param, final Class<TYPE> clazz) {
|
||||
final TYPE[] annotations = param.getDeclaredAnnotationsByType(clazz);
|
||||
|
||||
if (annotations.length == 0) {
|
||||
return null;
|
||||
}
|
||||
return annotations;
|
||||
}
|
||||
|
||||
public static <TYPE extends Annotation> TYPE get(final Field element, final Class<TYPE> clazz) {
|
||||
final TYPE[] annotations = element.getDeclaredAnnotationsByType(clazz);
|
||||
|
||||
@ -59,6 +78,24 @@ public class AnnotationTools {
|
||||
return annotations;
|
||||
}
|
||||
|
||||
public static <TYPE extends Annotation> TYPE get(final Class<?> classObject, final Class<TYPE> clazz) {
|
||||
final TYPE[] annotations = classObject.getDeclaredAnnotationsByType(clazz);
|
||||
|
||||
if (annotations.length == 0) {
|
||||
return null;
|
||||
}
|
||||
return annotations[0];
|
||||
}
|
||||
|
||||
public static <TYPE extends Annotation> TYPE[] gets(final Class<?> classObject, final Class<TYPE> clazz) {
|
||||
final TYPE[] annotations = classObject.getDeclaredAnnotationsByType(clazz);
|
||||
|
||||
if (annotations.length == 0) {
|
||||
return null;
|
||||
}
|
||||
return annotations;
|
||||
}
|
||||
|
||||
// For SQL declaration table Name
|
||||
public static String getTableName(final Class<?> clazz, final QueryOptions options) throws DataAccessException {
|
||||
if (options != null) {
|
||||
@ -121,14 +158,6 @@ public class AnnotationTools {
|
||||
return get(element, CollectionNotEmpty.class);
|
||||
}
|
||||
|
||||
public static boolean getSchemaReadOnly(final Field element) {
|
||||
final Annotation[] annotation = element.getDeclaredAnnotationsByType(Schema.class);
|
||||
if (annotation.length == 0) {
|
||||
return false;
|
||||
}
|
||||
return ((Schema) annotation[0]).readOnly();
|
||||
}
|
||||
|
||||
public static String getSchemaExample(final Class<?> element) {
|
||||
final Annotation[] annotation = element.getDeclaredAnnotationsByType(Schema.class);
|
||||
if (annotation.length == 0) {
|
||||
@ -137,14 +166,6 @@ public class AnnotationTools {
|
||||
return ((Schema) annotation[0]).example();
|
||||
}
|
||||
|
||||
public static boolean getNoWriteSpecificMode(final Class<?> element) {
|
||||
final Annotation[] annotation = element.getDeclaredAnnotationsByType(NoWriteSpecificMode.class);
|
||||
if (annotation.length == 0) {
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
public static String getSchemaDescription(final Class<?> element) {
|
||||
final Annotation[] annotation = element.getDeclaredAnnotationsByType(Schema.class);
|
||||
if (annotation.length == 0) {
|
||||
|
@ -5,6 +5,39 @@ import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
/**
|
||||
* The CreationTimestamp annotation is used to automatically set the creation
|
||||
* date of an object in the database. This annotation ensures that the field
|
||||
* marked with @CreationTimestamp is populated with the current timestamp
|
||||
* when the object is first created.
|
||||
*
|
||||
* <p>Usage:
|
||||
* - Target: This annotation can be applied to fields within a class.
|
||||
* - Retention: The annotation is retained at runtime, allowing it to be
|
||||
* processed by frameworks or libraries that handle data persistence logic.
|
||||
*
|
||||
* <p>Behavior:
|
||||
* - When a field is annotated with @CreationTimestamp, it will automatically
|
||||
* be set to the current date and time when the object is inserted into the
|
||||
* database.
|
||||
* - This annotation is typically used in conjunction with other annotations
|
||||
* such as @Column to define database column properties.
|
||||
*
|
||||
* <p>Example:
|
||||
* <pre>{@code
|
||||
* public class MyEntity {
|
||||
* @DataNotRead
|
||||
* @CreationTimestamp
|
||||
* @Column(nullable = false, insertable = false, updatable = false)
|
||||
* @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX") // optional depend on the configuration
|
||||
* @Nullable
|
||||
* public Date createdAt = null;
|
||||
* }
|
||||
* }</pre>
|
||||
*
|
||||
* In this example, the createdAt field will be automatically set to the
|
||||
* current timestamp when a new User object is created in the database.
|
||||
*/
|
||||
@Target(ElementType.FIELD)
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface CreationTimestamp {
|
||||
|
@ -5,6 +5,40 @@ import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
/**
|
||||
* The DataDeleted annotation is used to manage a boolean variable that marks
|
||||
* an object as 'deleted' in the database. This annotation helps in soft deletion
|
||||
* by excluding marked objects from being automatically retrieved unless
|
||||
* explicitly specified.
|
||||
*
|
||||
* <p>Usage:
|
||||
* - Target: This annotation can be applied to fields within a class.
|
||||
* - Retention: The annotation is retained at runtime, allowing it to be
|
||||
* processed by frameworks or libraries that handle data retrieval logic.
|
||||
*
|
||||
* <p>Behavior:
|
||||
* - When a field is annotated with @DataDeleted, it will not be included in the
|
||||
* default data retrieval process from the database if its value is false.
|
||||
* - To override this behavior and access deleted items, the query must include
|
||||
* the option AccessDeletedItems.
|
||||
*
|
||||
* <p>Example:
|
||||
* <pre>{@code
|
||||
* public class MyEntity {
|
||||
* public String username;
|
||||
*
|
||||
* @DataDeleted
|
||||
* @DataNotRead
|
||||
* @Column(nullable = false)
|
||||
* @DefaultValue("'0'")
|
||||
* public Boolean deleted = null;
|
||||
* }
|
||||
* }</pre>
|
||||
*
|
||||
* In this example, objects with `deleted` set to true will not be retrieved
|
||||
* by default. To include them in the query results, the AccessDeletedItems
|
||||
* option must be specified in the query.
|
||||
*/
|
||||
@Target(ElementType.FIELD)
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface DataDeleted {
|
||||
|
@ -5,6 +5,41 @@ import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
/**
|
||||
* The DataJson annotation is used to convert fields or classes to JSON format
|
||||
* for storage in a database. This annotation allows storing complex data types
|
||||
* such as lists, maps, and other objects in SQL databases as JSON or STRING
|
||||
* (for SQLite).
|
||||
*
|
||||
* <p>Usage:
|
||||
* - Target: This annotation can be applied to both fields and classes.
|
||||
* - Retention: The annotation is retained at runtime, allowing it to be
|
||||
* processed by frameworks or libraries that handle data persistence logic.
|
||||
*
|
||||
* <p>Behavior:
|
||||
* - When applied to a field or class, the DataJson annotation enables the
|
||||
* conversion of the annotated element to JSON format before storing it in
|
||||
* the database.
|
||||
* - This is particularly useful in SQL databases where only basic data types
|
||||
* (char, short, int, long, float, string, timestamp) can be stored directly.
|
||||
* The DataJson annotation makes it possible to store complex data structures
|
||||
* by converting them to JSON.
|
||||
*
|
||||
* <p>Attributes:
|
||||
* - targetEntity: Specifies the target entity class to which the JSON data
|
||||
* should be mapped. Defaults auto-detect if not specified.
|
||||
*
|
||||
* <p>Example:
|
||||
* <pre>{@code
|
||||
* public class User {
|
||||
* @DataJson
|
||||
* public Map<String, Object> additionalData;
|
||||
* }
|
||||
* }</pre>
|
||||
*
|
||||
* In this example, the additionalData field can store complex data structures
|
||||
* as JSON in the database.
|
||||
*/
|
||||
@Target({ ElementType.TYPE, ElementType.FIELD })
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface DataJson {
|
||||
|
@ -5,6 +5,37 @@ import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
/**
|
||||
* The DataNotRead annotation is used to mark fields in a class that should not
|
||||
* be automatically read from the database. This annotation helps in optimizing
|
||||
* data retrieval by excluding certain fields from being fetched unless
|
||||
* explicitly specified.
|
||||
*
|
||||
* <p>Usage:
|
||||
* - Target: This annotation can be applied to fields within a class.
|
||||
* - Retention: The annotation is retained at runtime, allowing it to be
|
||||
* processed by frameworks or libraries that handle data retrieval logic.
|
||||
*
|
||||
* <p>Behavior:
|
||||
* - When a field is annotated with @DataNotRead, it will not be included in the
|
||||
* default data retrieval process from the database.
|
||||
* - To override this behavior and read all columns, including those marked with
|
||||
* @DataNotRead, the query must include the option ReadAllColumn.
|
||||
*
|
||||
* <p>Example:
|
||||
* <pre>{@code
|
||||
* public class MyEntity {
|
||||
* public String username;
|
||||
*
|
||||
* @DataNotRead
|
||||
* private String sensitiveData;
|
||||
* }
|
||||
* }</pre>
|
||||
*
|
||||
* In this example, the sensitiveData field will not be read from the database
|
||||
* by default. To include it in the query results, the ReadAllColumn option must
|
||||
* be specified in the query.
|
||||
*/
|
||||
@Target(ElementType.FIELD)
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface DataNotRead {
|
||||
|
@ -1,12 +0,0 @@
|
||||
package org.kar.archidata.annotation;
|
||||
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
@Target({ ElementType.PARAMETER })
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface FormDataOptional {
|
||||
|
||||
}
|
@ -1,13 +0,0 @@
|
||||
package org.kar.archidata.annotation;
|
||||
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
/** When we wend to have only One type for read and write mode (Wrapping API). */
|
||||
@Target({ ElementType.TYPE })
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface NoWriteSpecificMode {
|
||||
|
||||
}
|
@ -1,11 +0,0 @@
|
||||
package org.kar.archidata.annotation;
|
||||
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
/** In case of the update parameter with String input to detect null element. */
|
||||
@Target({ ElementType.PARAMETER, ElementType.METHOD })
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface TypeScriptProgress {}
|
@ -5,6 +5,38 @@ import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
/**
|
||||
* The UpdateTimestamp annotation is used to automatically update the timestamp
|
||||
* of an object in the database whenever it is modified. This annotation ensures
|
||||
* that the field marked with @UpdateTimestamp is set to the current timestamp
|
||||
* each time the object is updated.
|
||||
*
|
||||
* <p>Usage:
|
||||
* - Target: This annotation can be applied to fields within a class.
|
||||
* - Retention: The annotation is retained at runtime, allowing it to be
|
||||
* processed by frameworks or libraries that handle data persistence logic.
|
||||
*
|
||||
* <p>Behavior:
|
||||
* - When a field is annotated with @UpdateTimestamp, it will automatically
|
||||
* be updated to the current date and time whenever the object is modified
|
||||
* in the database.
|
||||
* - This annotation is typically used in conjunction with other annotations
|
||||
* such as @Column to define database column properties.
|
||||
*
|
||||
* <p>Example:
|
||||
* <pre>{@code
|
||||
* public class MyEntity {
|
||||
* @UpdateTimestamp
|
||||
* @Column(nullable = false, insertable = false, updatable = false)
|
||||
* @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX")
|
||||
* @Nullable
|
||||
* public Date updatedAt = null;
|
||||
* }
|
||||
* }</pre>
|
||||
*
|
||||
* In this example, the updatedAt field will be automatically set to the
|
||||
* current timestamp whenever the User object is modified in the database.
|
||||
*/
|
||||
@Target(ElementType.FIELD)
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface UpdateTimestamp {
|
||||
|
@ -0,0 +1,21 @@
|
||||
package org.kar.archidata.annotation.apiGenerator;
|
||||
|
||||
import static java.lang.annotation.ElementType.FIELD;
|
||||
import static java.lang.annotation.RetentionPolicy.RUNTIME;
|
||||
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
@Retention(RUNTIME)
|
||||
@Target(FIELD)
|
||||
public @interface ApiAccessLimitation {
|
||||
/**
|
||||
* (Optional) The field is accessible in creation (POST)
|
||||
*/
|
||||
boolean creatable() default true;
|
||||
|
||||
/**
|
||||
* (Optional) The field is accessible in update mode (PUT, PATCH)
|
||||
*/
|
||||
boolean updatable() default true;
|
||||
}
|
@ -1,4 +1,4 @@
|
||||
package org.kar.archidata.annotation;
|
||||
package org.kar.archidata.annotation.apiGenerator;
|
||||
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
@ -8,7 +8,7 @@ import java.lang.annotation.Target;
|
||||
/** In case of the update parameter with String input to detect null element. */
|
||||
@Target({ ElementType.PARAMETER, ElementType.METHOD })
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface AsyncType {
|
||||
public @interface ApiAsyncType {
|
||||
// Possible class values.
|
||||
Class<?>[] value();
|
||||
|
@ -0,0 +1,57 @@
|
||||
package org.kar.archidata.annotation.apiGenerator;
|
||||
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
/**
|
||||
* The ApiGenerationMode annotation is used to indicate the generation mode for
|
||||
* API operations when producing code for other languages. This annotation is
|
||||
* particularly useful in code generators for client libraries where specific
|
||||
* data structures for read, create, and update operations may or may not be needed.
|
||||
*
|
||||
* <p>Usage:
|
||||
* - Target: This annotation can be applied to class types.
|
||||
* - Retention: The annotation is retained at runtime, allowing it to be
|
||||
* processed by frameworks or libraries that handle code generation logic.
|
||||
*
|
||||
* <p>Behavior:
|
||||
* - When applied to a class, the ApiGenerationMode annotation specifies
|
||||
* which API operations (read, create, update) should generate specific
|
||||
* data structures. This can simplify the generated code by avoiding the
|
||||
* creation of unnecessary structures.
|
||||
*
|
||||
* <p>Example:
|
||||
* <pre>{@code
|
||||
* @ApiGenerationMode(creatable=false, updatable=false)
|
||||
* public class User {
|
||||
* public String username;
|
||||
* public String email;
|
||||
* }
|
||||
* }</pre>
|
||||
*
|
||||
* In this example, the User class will not generate separate data structures
|
||||
* for create and update operations in the client code, only for read operations.
|
||||
*/
|
||||
@Target({ ElementType.TYPE })
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface ApiGenerationMode {
|
||||
/**
|
||||
* (Optional) Enable the generation of specific code for read access
|
||||
* (generate object: MyClass).
|
||||
*/
|
||||
boolean read() default true;
|
||||
|
||||
/**
|
||||
* (Optional) Enable the generation of specific code for create access
|
||||
* (generate object: MyClassCreate).
|
||||
*/
|
||||
boolean create() default false;
|
||||
|
||||
/**
|
||||
* (Optional) Enable the generation of specific code for update access
|
||||
* (generate object: MyClassUpdate).
|
||||
*/
|
||||
boolean update() default false;
|
||||
}
|
@ -0,0 +1,76 @@
|
||||
package org.kar.archidata.annotation.apiGenerator;
|
||||
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
/**
|
||||
* The FormDataOptional annotation is used to indicate that a form data parameter
|
||||
* is optional when generating client code. By default, form data parameters are
|
||||
* required, but this annotation allows them to be optional, enabling the creation
|
||||
* of polymorphic APIs.
|
||||
*
|
||||
* <p>Usage:
|
||||
* - Target: This annotation can be applied to method parameters.
|
||||
* - Retention: The annotation is retained at runtime, allowing it to be
|
||||
* processed by frameworks or libraries that handle code generation logic.
|
||||
*
|
||||
* <p>Behavior:
|
||||
* - When applied to a parameter, the FormDataOptional annotation specifies that
|
||||
* the parameter is optional in the generated client code. This allows for
|
||||
* more flexible API designs where certain inputs can be omitted.
|
||||
*
|
||||
* <p>Example:
|
||||
* <pre>{@code
|
||||
* public class AlbumService {
|
||||
*
|
||||
* @POST
|
||||
* @Path("{id}/cover")
|
||||
* @RolesAllowed("ADMIN")
|
||||
* @Consumes({ MediaType.MULTIPART_FORM_DATA })
|
||||
* @Operation(description = "Add a cover on a specific album")
|
||||
* @TypeScriptProgress
|
||||
* public Album uploadCover(@PathParam("id") final Long id,
|
||||
* @ApiInputOptional @FormDataParam("uri") final String uri,
|
||||
* @ApiInputOptional @FormDataParam("file") final InputStream fileInputStream,
|
||||
* @ApiInputOptional @FormDataParam("file") final FormDataContentDisposition fileMetaData)
|
||||
* throws Exception {
|
||||
* // some code
|
||||
* }
|
||||
* }
|
||||
* }</pre>
|
||||
*
|
||||
* Note: @FormDataParam must be allway at the last position.
|
||||
*
|
||||
* In this example, the uri, fileInputStream, and fileMetaData parameters are
|
||||
* marked as optional, allowing the client to omit them when calling the API.
|
||||
*
|
||||
* <p>Generated TypeScript code example:
|
||||
* <pre>{@code
|
||||
* //Add a cover on a specific album
|
||||
* export function uploadCover({
|
||||
* restConfig,
|
||||
* params,
|
||||
* data,
|
||||
* callbacks,
|
||||
* }: {
|
||||
* restConfig: RESTConfig,
|
||||
* params: {
|
||||
* id: Long,
|
||||
* },
|
||||
* data: {
|
||||
* file?: File, // element is optional
|
||||
* uri?: string, // element is optional
|
||||
* },
|
||||
* callbacks?: RESTCallbacks,
|
||||
* }): Promise<Album> { ...
|
||||
* }</pre>
|
||||
*
|
||||
* The generated TypeScript function reflects the optional nature of the form data parameters.
|
||||
*/
|
||||
@Target({ ElementType.PARAMETER })
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface ApiInputOptional {
|
||||
|
||||
}
|
@ -0,0 +1,71 @@
|
||||
package org.kar.archidata.annotation.apiGenerator;
|
||||
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
/**
|
||||
* The TypeScriptProgress annotation is used to specify that an API method
|
||||
* will take a significant amount of time to complete, and thus requires a
|
||||
* callback API to provide more precise progress tracking, particularly for
|
||||
* upload operations.
|
||||
*
|
||||
* <p>Usage:
|
||||
* - Target: This annotation can be applied to method parameters and methods.
|
||||
* - Retention: The annotation is retained at runtime, allowing it to be
|
||||
* processed by frameworks or libraries that handle code generation logic.
|
||||
*
|
||||
* <p>Behavior:
|
||||
* - When applied to a method or parameter, the TypeScriptProgress annotation
|
||||
* indicates that the client code generator should provide a callback API
|
||||
* for tracking the progress of the operation.
|
||||
* - Note: The use of this annotation implies that the standard browser fetch
|
||||
* API is not used, as the callback API is not yet operational. Instead,
|
||||
* the older XMLHttpRequest interface is utilized.
|
||||
*
|
||||
* <p>Example:
|
||||
* <pre>{@code
|
||||
* public class SeasonService {
|
||||
*
|
||||
* @POST
|
||||
* @Path("{id}/cover")
|
||||
* @RolesAllowed("ADMIN")
|
||||
* @Consumes(MediaType.MULTIPART_FORM_DATA)
|
||||
* @Operation(description = "Upload a new season cover season", tags = "GLOBAL")
|
||||
* @TypeScriptProgress
|
||||
* public Season uploadCover(@PathParam("id") final Long id,
|
||||
* @FormDataParam("file") final InputStream fileInputStream,
|
||||
* @FormDataParam("file") final FormDataContentDisposition fileMetaData)
|
||||
* throws Exception {
|
||||
* // Upload logic
|
||||
* }
|
||||
* }
|
||||
* }</pre>
|
||||
*
|
||||
* In this example, the uploadCover method will generate a client-side API
|
||||
* with progress tracking capabilities using XMLHttpRequest.
|
||||
*
|
||||
* <p>Generated TypeScript code example:
|
||||
* <pre>{@code
|
||||
* export function uploadCover({
|
||||
* restConfig,
|
||||
* params,
|
||||
* data,
|
||||
* callbacks, // add this callback handle
|
||||
* }: {
|
||||
* restConfig: RESTConfig,
|
||||
* params: {
|
||||
* id: Long,
|
||||
* },
|
||||
* data: {
|
||||
* file: File,
|
||||
* },
|
||||
* callbacks?: RESTCallbacks,
|
||||
* }): Promise<Season> {...
|
||||
* }</pre>
|
||||
*
|
||||
*/
|
||||
@Target({ ElementType.PARAMETER, ElementType.METHOD })
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface ApiTypeScriptProgress {}
|
@ -5,8 +5,18 @@ import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
@Target({ ElementType.TYPE, ElementType.FIELD })
|
||||
import jakarta.validation.Constraint;
|
||||
import jakarta.validation.Payload;
|
||||
|
||||
@Constraint(validatedBy = CheckForeignKeyValidator.class)
|
||||
@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD })
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface CheckForeignKey {
|
||||
Class<?> target();
|
||||
|
||||
String message() default "Foreign-key does not exist in the DB";
|
||||
|
||||
Class<?>[] groups() default {};
|
||||
|
||||
Class<? extends Payload>[] payload() default {};
|
||||
}
|
||||
|
@ -0,0 +1,43 @@
|
||||
package org.kar.archidata.annotation.checker;
|
||||
|
||||
import java.util.Collection;
|
||||
|
||||
import org.kar.archidata.dataAccess.DataAccess;
|
||||
|
||||
import jakarta.validation.ConstraintValidator;
|
||||
import jakarta.validation.ConstraintValidatorContext;
|
||||
|
||||
public class CheckForeignKeyValidator implements ConstraintValidator<CheckForeignKey, Object> {
|
||||
Class<?> target = null;
|
||||
|
||||
@Override
|
||||
public void initialize(final CheckForeignKey annotation) {
|
||||
this.target = annotation.target();
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isValid(final Object value, final ConstraintValidatorContext context) {
|
||||
if (value != null) {
|
||||
return true;
|
||||
}
|
||||
if (value instanceof final Collection<?> tmpCollection) {
|
||||
final Object[] elements = tmpCollection.toArray();
|
||||
for (final Object element : elements) {
|
||||
if (element == null) {
|
||||
continue;
|
||||
}
|
||||
try {
|
||||
final long count = DataAccess.count(this.target, element);
|
||||
if (count != 1) {
|
||||
return false;
|
||||
|
||||
}
|
||||
} catch (final Exception e) {
|
||||
// TODO ...
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
@ -7,6 +7,44 @@ import java.lang.annotation.Target;
|
||||
|
||||
import org.kar.archidata.dataAccess.options.CheckFunctionInterface;
|
||||
|
||||
/**
|
||||
* The Checker annotation is used to specify a checker class that automatically
|
||||
* validates data for a parent class. This annotation can be applied to both
|
||||
* classes and fields to enforce validation rules defined in the checker class.
|
||||
*
|
||||
* <p>Usage:
|
||||
* - Target: This annotation can be applied to types (classes) and fields.
|
||||
* - Retention: The annotation is retained at runtime, allowing it to be
|
||||
* processed by frameworks or libraries that handle data validation logic.
|
||||
*
|
||||
* <p>Behavior:
|
||||
* - When applied to a class or field, the Checker annotation specifies a
|
||||
* checker class that implements the CheckFunctionInterface. This checker
|
||||
* class is responsible for validating the data associated with the annotated
|
||||
* element.
|
||||
* - The validation is automatically triggered when the data of the parent class
|
||||
* is validated, ensuring that the data adheres to the specified rules.
|
||||
*
|
||||
* <p>Attributes:
|
||||
* - value: Specifies the checker class that implements the validation logic.
|
||||
* This class must extend the CheckFunctionInterface.
|
||||
*
|
||||
* <p>Example:
|
||||
* <pre>{@code
|
||||
* public class User {
|
||||
*
|
||||
* @Checker(UserDataChecker.class)
|
||||
* public String email;
|
||||
* }
|
||||
*
|
||||
* public class UserDataChecker implements CheckFunctionInterface {
|
||||
* ...
|
||||
* }
|
||||
* }</pre>
|
||||
*
|
||||
* In this example, the email field in the User class is validated using the
|
||||
* UserDataChecker class whenever the User class data is validated.
|
||||
*/
|
||||
@Target({ ElementType.TYPE, ElementType.FIELD })
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface Checker {
|
||||
|
@ -5,8 +5,16 @@ import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
@Target(ElementType.FIELD)
|
||||
import jakarta.validation.Constraint;
|
||||
import jakarta.validation.Payload;
|
||||
|
||||
@Constraint(validatedBy = CollectionItemNotNullValidator.class)
|
||||
@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD })
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface CollectionItemNotNull {
|
||||
String message() default "Collection can not contain NULL item";
|
||||
|
||||
Class<?>[] groups() default {};
|
||||
|
||||
Class<? extends Payload>[] payload() default {};
|
||||
}
|
||||
|
@ -0,0 +1,31 @@
|
||||
package org.kar.archidata.annotation.checker;
|
||||
|
||||
import java.util.Collection;
|
||||
|
||||
import jakarta.validation.ConstraintValidator;
|
||||
import jakarta.validation.ConstraintValidatorContext;
|
||||
|
||||
public class CollectionItemNotNullValidator implements ConstraintValidator<CollectionItemNotNull, Object> {
|
||||
|
||||
@Override
|
||||
public void initialize(final CollectionItemNotNull annotation) {
|
||||
// nothing to do...
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isValid(final Object value, final ConstraintValidatorContext context) {
|
||||
if (value == null) {
|
||||
return true;
|
||||
}
|
||||
if (value instanceof final Collection<?> tmpCollection) {
|
||||
final Object[] elements = tmpCollection.toArray();
|
||||
for (final Object element : elements) {
|
||||
if (element == null) {
|
||||
return false;
|
||||
//throw new InputException(baseName + fieldName + '[' + iii + ']', "Collection can not contain NULL item");
|
||||
}
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
@ -5,8 +5,17 @@ import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
@Target(ElementType.FIELD)
|
||||
import jakarta.validation.Constraint;
|
||||
import jakarta.validation.Payload;
|
||||
|
||||
@Constraint(validatedBy = CollectionItemUniqueValidator.class)
|
||||
@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD })
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface CollectionItemUnique {
|
||||
|
||||
String message() default "Cannot insert multiple times the same elements";
|
||||
|
||||
Class<?>[] groups() default {};
|
||||
|
||||
Class<? extends Payload>[] payload() default {};
|
||||
}
|
||||
|
@ -0,0 +1,30 @@
|
||||
package org.kar.archidata.annotation.checker;
|
||||
|
||||
import java.util.Collection;
|
||||
import java.util.HashSet;
|
||||
import java.util.Set;
|
||||
|
||||
import jakarta.validation.ConstraintValidator;
|
||||
import jakarta.validation.ConstraintValidatorContext;
|
||||
|
||||
public class CollectionItemUniqueValidator implements ConstraintValidator<CollectionItemUnique, Object> {
|
||||
|
||||
@Override
|
||||
public void initialize(final CollectionItemUnique annotation) {
|
||||
// nothing to do...
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isValid(final Object value, final ConstraintValidatorContext context) {
|
||||
if (value == null) {
|
||||
return true;
|
||||
}
|
||||
if (value instanceof final Collection<?> tmpCollection) {
|
||||
final Set<Object> uniqueValues = new HashSet<>(tmpCollection);
|
||||
if (uniqueValues.size() != tmpCollection.size()) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
@ -5,8 +5,17 @@ import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
@Target(ElementType.FIELD)
|
||||
import jakarta.validation.Constraint;
|
||||
import jakarta.validation.Payload;
|
||||
|
||||
@Constraint(validatedBy = CollectionNotEmptyValidator.class)
|
||||
@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD })
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface CollectionNotEmpty {
|
||||
|
||||
String message() default "Collection can not be empty";
|
||||
|
||||
Class<?>[] groups() default {};
|
||||
|
||||
Class<? extends Payload>[] payload() default {};
|
||||
}
|
||||
|
@ -0,0 +1,27 @@
|
||||
package org.kar.archidata.annotation.checker;
|
||||
|
||||
import java.util.Collection;
|
||||
|
||||
import jakarta.validation.ConstraintValidator;
|
||||
import jakarta.validation.ConstraintValidatorContext;
|
||||
|
||||
public class CollectionNotEmptyValidator implements ConstraintValidator<CollectionNotEmpty, Object> {
|
||||
|
||||
@Override
|
||||
public void initialize(final CollectionNotEmpty annotation) {
|
||||
// nothing to do...
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isValid(final Object value, final ConstraintValidatorContext context) {
|
||||
if (value == null) {
|
||||
return true;
|
||||
}
|
||||
if (value instanceof final Collection<?> tmpCollection) {
|
||||
if (tmpCollection.isEmpty()) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
20
src/org/kar/archidata/annotation/checker/ReadOnlyField.java
Normal file
20
src/org/kar/archidata/annotation/checker/ReadOnlyField.java
Normal file
@ -0,0 +1,20 @@
|
||||
package org.kar.archidata.annotation.checker;
|
||||
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
import jakarta.validation.Constraint;
|
||||
import jakarta.validation.Payload;
|
||||
|
||||
@Constraint(validatedBy = ReadOnlyFieldValidator.class)
|
||||
@Target({ ElementType.METHOD, ElementType.FIELD })
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface ReadOnlyField {
|
||||
String message() default "Field can not be set, it is a read-only field.";
|
||||
|
||||
Class<?>[] groups() default {};
|
||||
|
||||
Class<? extends Payload>[] payload() default {};
|
||||
}
|
@ -0,0 +1,20 @@
|
||||
package org.kar.archidata.annotation.checker;
|
||||
|
||||
import jakarta.validation.ConstraintValidator;
|
||||
import jakarta.validation.ConstraintValidatorContext;
|
||||
|
||||
public class ReadOnlyFieldValidator implements ConstraintValidator<ReadOnlyField, Object> {
|
||||
|
||||
@Override
|
||||
public void initialize(final ReadOnlyField annotation) {
|
||||
// nothing to do...
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isValid(final Object value, final ConstraintValidatorContext context) {
|
||||
if (value != null) {
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
@ -24,6 +24,7 @@ import javax.imageio.ImageIO;
|
||||
import org.bson.types.ObjectId;
|
||||
import org.glassfish.jersey.media.multipart.FormDataContentDisposition;
|
||||
import org.glassfish.jersey.media.multipart.FormDataParam;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiInputOptional;
|
||||
import org.kar.archidata.annotation.security.PermitTokenInURI;
|
||||
import org.kar.archidata.dataAccess.DataAccess;
|
||||
import org.kar.archidata.dataAccess.QueryCondition;
|
||||
@ -426,7 +427,7 @@ public class DataResource {
|
||||
public Response retrieveDataFull(
|
||||
@Context final SecurityContext sc,
|
||||
@QueryParam(HttpHeaders.AUTHORIZATION) final String token,
|
||||
@HeaderParam("Range") final String range,
|
||||
@ApiInputOptional @HeaderParam("Range") final String range,
|
||||
@PathParam("oid") final ObjectId oid,
|
||||
@PathParam("name") final String name) throws Exception {
|
||||
final GenericContext gc = (GenericContext) sc.getUserPrincipal();
|
||||
|
@ -0,0 +1,47 @@
|
||||
package org.kar.archidata.catcher;
|
||||
|
||||
import java.time.Instant;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collections;
|
||||
import java.util.Comparator;
|
||||
import java.util.List;
|
||||
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import jakarta.validation.ConstraintViolationException;
|
||||
import jakarta.ws.rs.core.MediaType;
|
||||
import jakarta.ws.rs.core.Response;
|
||||
import jakarta.ws.rs.ext.ExceptionMapper;
|
||||
|
||||
public class ConstraintViolationExceptionCatcher implements ExceptionMapper<ConstraintViolationException> {
|
||||
private static final Logger LOGGER = LoggerFactory.getLogger(ConstraintViolationExceptionCatcher.class);
|
||||
|
||||
@Override
|
||||
public Response toResponse(final ConstraintViolationException exception) {
|
||||
LOGGER.warn("Catch ConstraintViolationException: {}", exception.getLocalizedMessage());
|
||||
final RestErrorResponse ret = build(exception);
|
||||
LOGGER.error("Error OID={}", ret.oid);
|
||||
return Response.status(Response.Status.BAD_REQUEST).entity(ret).type(MediaType.APPLICATION_JSON).build();
|
||||
}
|
||||
|
||||
private RestErrorResponse build(final ConstraintViolationException exception) {
|
||||
final List<RestInputError> inputError = new ArrayList<>();
|
||||
for (final var cv : exception.getConstraintViolations()) {
|
||||
if (cv == null) {
|
||||
continue;
|
||||
}
|
||||
inputError.add(new RestInputError(cv.getPropertyPath(), cv.getMessage()));
|
||||
}
|
||||
Collections.sort(inputError, Comparator.comparing(RestInputError::getFullPath));
|
||||
String errorType = "Multiple error on input";
|
||||
if (inputError.size() == 0) {
|
||||
errorType = "Constraint Violation";
|
||||
} else if (inputError.size() == 1) {
|
||||
errorType = "Error on input='" + inputError.get(0).path + "'";
|
||||
}
|
||||
return new RestErrorResponse(Response.Status.BAD_REQUEST, Instant.now().toString(), errorType,
|
||||
exception.getMessage(), inputError);
|
||||
}
|
||||
|
||||
}
|
@ -19,6 +19,7 @@ public class GenericCatcher {
|
||||
rc.register(FailExceptionCatcher.class);
|
||||
// generic Exception catcher
|
||||
rc.register(ExceptionCatcher.class);
|
||||
rc.register(ConstraintViolationExceptionCatcher.class);
|
||||
}
|
||||
|
||||
}
|
||||
|
@ -1,15 +1,16 @@
|
||||
package org.kar.archidata.catcher;
|
||||
|
||||
import java.time.Instant;
|
||||
import java.util.List;
|
||||
|
||||
import org.bson.types.ObjectId;
|
||||
import org.kar.archidata.annotation.NoWriteSpecificMode;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiGenerationMode;
|
||||
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.validation.constraints.NotNull;
|
||||
import jakarta.ws.rs.core.Response;
|
||||
|
||||
@NoWriteSpecificMode
|
||||
@ApiGenerationMode
|
||||
public class RestErrorResponse {
|
||||
public ObjectId oid = new ObjectId();
|
||||
@NotNull
|
||||
@ -27,6 +28,18 @@ public class RestErrorResponse {
|
||||
@Column(length = 0)
|
||||
final public String statusMessage;
|
||||
|
||||
final public List<RestInputError> inputError;
|
||||
|
||||
public RestErrorResponse(final Response.Status status, final String time, final String error, final String message,
|
||||
final List<RestInputError> inputError) {
|
||||
this.time = time;
|
||||
this.name = error;
|
||||
this.message = message;
|
||||
this.status = status.getStatusCode();
|
||||
this.statusMessage = status.getReasonPhrase();
|
||||
this.inputError = inputError;
|
||||
}
|
||||
|
||||
public RestErrorResponse(final Response.Status status, final String time, final String error,
|
||||
final String message) {
|
||||
this.time = time;
|
||||
@ -34,6 +47,7 @@ public class RestErrorResponse {
|
||||
this.message = message;
|
||||
this.status = status.getStatusCode();
|
||||
this.statusMessage = status.getReasonPhrase();
|
||||
this.inputError = null;
|
||||
}
|
||||
|
||||
public RestErrorResponse(final Response.Status status, final String error, final String message) {
|
||||
@ -42,6 +56,7 @@ public class RestErrorResponse {
|
||||
this.message = message;
|
||||
this.status = status.getStatusCode();
|
||||
this.statusMessage = status.getReasonPhrase();
|
||||
this.inputError = null;
|
||||
}
|
||||
|
||||
public RestErrorResponse(final Response.Status status) {
|
||||
@ -50,6 +65,7 @@ public class RestErrorResponse {
|
||||
this.time = Instant.now().toString();
|
||||
this.status = status.getStatusCode();
|
||||
this.statusMessage = status.getReasonPhrase();
|
||||
this.inputError = null;
|
||||
}
|
||||
|
||||
}
|
||||
|
50
src/org/kar/archidata/catcher/RestInputError.java
Normal file
50
src/org/kar/archidata/catcher/RestInputError.java
Normal file
@ -0,0 +1,50 @@
|
||||
package org.kar.archidata.catcher;
|
||||
|
||||
import java.util.regex.Matcher;
|
||||
import java.util.regex.Pattern;
|
||||
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.validation.Path;
|
||||
import jakarta.validation.constraints.NotNull;
|
||||
|
||||
public class RestInputError {
|
||||
private static Pattern PATTERN = Pattern.compile("^([^.]+)\\.([^.]+)(\\.(.*))?");
|
||||
@Column(length = 0)
|
||||
public String argument;
|
||||
@Column(length = 0)
|
||||
public String path;
|
||||
@NotNull
|
||||
@Column(length = 0)
|
||||
public String message;
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "RestInputError [argument=" + this.argument + ", path=" + this.path + ", message=" + this.message + "]";
|
||||
}
|
||||
|
||||
public RestInputError() {}
|
||||
|
||||
public RestInputError(final Path path, final String message) {
|
||||
final Matcher matcher = PATTERN.matcher(path.toString());
|
||||
if (matcher.find()) {
|
||||
//String firstPart = matcher.group(1); this is the request base element ==> not needed
|
||||
this.argument = matcher.group(2);
|
||||
this.path = matcher.group(4);
|
||||
} else {
|
||||
this.path = path.toString();
|
||||
}
|
||||
this.message = message;
|
||||
}
|
||||
|
||||
public RestInputError(final String path, final String message) {
|
||||
this.path = path;
|
||||
this.message = message;
|
||||
}
|
||||
|
||||
String getFullPath() {
|
||||
if (this.path == null) {
|
||||
return this.argument;
|
||||
}
|
||||
return this.argument + "." + this.path;
|
||||
}
|
||||
}
|
@ -9,6 +9,7 @@ import org.kar.archidata.exception.DataAccessException;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import edu.umd.cs.findbugs.annotations.Nullable;
|
||||
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
|
||||
import jakarta.ws.rs.InternalServerErrorException;
|
||||
|
||||
@ -189,6 +190,7 @@ public class DataAccess {
|
||||
}
|
||||
}
|
||||
|
||||
@Nullable
|
||||
public static <T, ID_TYPE> T get(final Class<T> clazz, final ID_TYPE id, final QueryOption... options)
|
||||
throws Exception {
|
||||
try (DBAccess db = DBAccess.createInterface()) {
|
||||
|
@ -1,6 +1,9 @@
|
||||
package org.kar.archidata.exception;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import org.bson.types.ObjectId;
|
||||
import org.kar.archidata.catcher.RestInputError;
|
||||
|
||||
public class RESTErrorResponseException extends Exception {
|
||||
private static final long serialVersionUID = 1L;
|
||||
@ -10,6 +13,7 @@ public class RESTErrorResponseException extends Exception {
|
||||
public String message;
|
||||
public int status;
|
||||
public String statusMessage;
|
||||
public List<RestInputError> inputError;
|
||||
|
||||
public RESTErrorResponseException() {
|
||||
this.oid = new ObjectId();
|
||||
@ -18,16 +22,18 @@ public class RESTErrorResponseException extends Exception {
|
||||
this.message = null;
|
||||
this.status = 0;
|
||||
this.statusMessage = null;
|
||||
this.inputError = null;
|
||||
}
|
||||
|
||||
public RESTErrorResponseException(final ObjectId oid, final String time, final String name, final String message,
|
||||
final int status, final String statusMessage) {
|
||||
final int status, final String statusMessage, final List<RestInputError> inputError) {
|
||||
this.oid = oid;
|
||||
this.time = time;
|
||||
this.name = name;
|
||||
this.message = message;
|
||||
this.status = status;
|
||||
this.statusMessage = statusMessage;
|
||||
this.inputError = inputError;
|
||||
}
|
||||
|
||||
@Override
|
||||
|
@ -151,13 +151,6 @@ public class DotClassElement {
|
||||
return ".optional()";
|
||||
}
|
||||
|
||||
public String readOnlyZod(final FieldProperty field) {
|
||||
if (field.readOnly()) {
|
||||
return ".readonly()";
|
||||
}
|
||||
return "";
|
||||
}
|
||||
|
||||
public String generateBaseObject() {
|
||||
final StringBuilder out = new StringBuilder();
|
||||
return out.toString();
|
||||
|
@ -9,9 +9,13 @@ import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import org.kar.archidata.annotation.AnnotationTools;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import jakarta.ws.rs.HeaderParam;
|
||||
import jakarta.ws.rs.core.Context;
|
||||
|
||||
public class ApiModel {
|
||||
static final Logger LOGGER = LoggerFactory.getLogger(ApiModel.class);
|
||||
|
||||
@ -37,6 +41,8 @@ public class ApiModel {
|
||||
public String name;
|
||||
// list of all parameters (/{key}/...
|
||||
public final Map<String, List<ClassModel>> parameters = new HashMap<>();
|
||||
// list of all headers of the request (/{key}/...
|
||||
public final Map<String, OptionalClassModel> headers = new HashMap<>();
|
||||
// list of all query (?key...)
|
||||
public final Map<String, List<ClassModel>> queries = new HashMap<>();
|
||||
// when request multi-part, need to separate it.
|
||||
@ -153,11 +159,12 @@ public class ApiModel {
|
||||
} else {
|
||||
parameterModel.add(previousModel.add(parameterType));
|
||||
}
|
||||
|
||||
final Context contextAnnotation = AnnotationTools.get(parameter, Context.class);
|
||||
final HeaderParam headerParam = AnnotationTools.get(parameter, HeaderParam.class);
|
||||
final String pathParam = ApiTool.apiAnnotationGetPathParam(parameter);
|
||||
final String queryParam = ApiTool.apiAnnotationGetQueryParam(parameter);
|
||||
final String formDataParam = ApiTool.apiAnnotationGetFormDataParam(parameter);
|
||||
final boolean formDataParamOptional = ApiTool.apiAnnotationGetFormDataOptional(parameter);
|
||||
final boolean apiInputOptional = ApiTool.apiAnnotationGetApiInputOptional(parameter);
|
||||
if (queryParam != null) {
|
||||
if (!this.queries.containsKey(queryParam)) {
|
||||
this.queries.put(queryParam, parameterModel);
|
||||
@ -169,7 +176,13 @@ public class ApiModel {
|
||||
} else if (formDataParam != null) {
|
||||
if (!this.multiPartParameters.containsKey(formDataParam)) {
|
||||
this.multiPartParameters.put(formDataParam,
|
||||
new OptionalClassModel(parameterModel, formDataParamOptional));
|
||||
new OptionalClassModel(parameterModel, apiInputOptional));
|
||||
}
|
||||
} else if (contextAnnotation != null) {
|
||||
// out of scope parameters
|
||||
} else if (headerParam != null) {
|
||||
if (!this.headers.containsKey(headerParam.value())) {
|
||||
this.headers.put(headerParam.value(), new OptionalClassModel(parameterModel, apiInputOptional));
|
||||
}
|
||||
} else {
|
||||
this.unnamedElement.addAll(parameterModel);
|
||||
|
@ -7,9 +7,9 @@ import java.util.Arrays;
|
||||
import java.util.List;
|
||||
|
||||
import org.glassfish.jersey.media.multipart.FormDataParam;
|
||||
import org.kar.archidata.annotation.AsyncType;
|
||||
import org.kar.archidata.annotation.FormDataOptional;
|
||||
import org.kar.archidata.annotation.TypeScriptProgress;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiInputOptional;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiAsyncType;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiTypeScriptProgress;
|
||||
import org.kar.archidata.annotation.method.ARCHIVE;
|
||||
import org.kar.archidata.annotation.method.RESTORE;
|
||||
|
||||
@ -53,7 +53,7 @@ public class ApiTool {
|
||||
}
|
||||
|
||||
public static boolean apiAnnotationTypeScriptProgress(final Method element) throws Exception {
|
||||
final Annotation[] annotation = element.getDeclaredAnnotationsByType(TypeScriptProgress.class);
|
||||
final Annotation[] annotation = element.getDeclaredAnnotationsByType(ApiTypeScriptProgress.class);
|
||||
if (annotation.length == 0) {
|
||||
return false;
|
||||
}
|
||||
@ -159,8 +159,8 @@ public class ApiTool {
|
||||
return ((QueryParam) annotation[0]).value();
|
||||
}
|
||||
|
||||
public static boolean apiAnnotationGetFormDataOptional(final Parameter element) throws Exception {
|
||||
final Annotation[] annotation = element.getDeclaredAnnotationsByType(FormDataOptional.class);
|
||||
public static boolean apiAnnotationGetApiInputOptional(final Parameter element) throws Exception {
|
||||
final Annotation[] annotation = element.getDeclaredAnnotationsByType(ApiInputOptional.class);
|
||||
if (annotation.length == 0) {
|
||||
return false;
|
||||
}
|
||||
@ -176,19 +176,19 @@ public class ApiTool {
|
||||
}
|
||||
|
||||
public static Class<?>[] apiAnnotationGetAsyncType(final Parameter element) throws Exception {
|
||||
final Annotation[] annotation = element.getDeclaredAnnotationsByType(AsyncType.class);
|
||||
final Annotation[] annotation = element.getDeclaredAnnotationsByType(ApiAsyncType.class);
|
||||
if (annotation.length == 0) {
|
||||
return null;
|
||||
}
|
||||
return ((AsyncType) annotation[0]).value();
|
||||
return ((ApiAsyncType) annotation[0]).value();
|
||||
}
|
||||
|
||||
public static Class<?>[] apiAnnotationGetAsyncType(final Method element) throws Exception {
|
||||
final Annotation[] annotation = element.getDeclaredAnnotationsByType(AsyncType.class);
|
||||
final Annotation[] annotation = element.getDeclaredAnnotationsByType(ApiAsyncType.class);
|
||||
if (annotation.length == 0) {
|
||||
return null;
|
||||
}
|
||||
return ((AsyncType) annotation[0]).value();
|
||||
return ((ApiAsyncType) annotation[0]).value();
|
||||
}
|
||||
|
||||
public static List<String> apiAnnotationGetConsumes(final Method element) throws Exception {
|
||||
|
@ -6,11 +6,14 @@ import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
|
||||
public class ClassEnumModel extends ClassModel {
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiGenerationMode;
|
||||
import org.kar.archidata.tools.AnnotationCreator;
|
||||
|
||||
public class ClassEnumModel extends ClassModel {
|
||||
protected ClassEnumModel(final Class<?> clazz) {
|
||||
this.originClasses = clazz;
|
||||
this.noWriteSpecificMode = true;
|
||||
this.apiGenerationMode = AnnotationCreator.createAnnotation(ApiGenerationMode.class, "readable", true,
|
||||
"creatable", false, "updatable", false);
|
||||
}
|
||||
|
||||
@Override
|
||||
|
@ -8,18 +8,24 @@ import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiGenerationMode;
|
||||
import org.kar.archidata.tools.AnnotationCreator;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
public abstract class ClassModel {
|
||||
private static final Logger LOGGER = LoggerFactory.getLogger(ClassModel.class);
|
||||
protected boolean analyzeDone = false;
|
||||
protected Class<?> originClasses = null;
|
||||
protected boolean noWriteSpecificMode = false;
|
||||
protected ApiGenerationMode apiGenerationMode = AnnotationCreator.createAnnotation(ApiGenerationMode.class);
|
||||
protected List<ClassModel> dependencyModels = new ArrayList<>();
|
||||
|
||||
public Class<?> getOriginClasses() {
|
||||
return this.originClasses;
|
||||
}
|
||||
|
||||
public boolean isNoWriteSpecificMode() {
|
||||
return this.noWriteSpecificMode;
|
||||
public ApiGenerationMode getApiGenerationMode() {
|
||||
return this.apiGenerationMode;
|
||||
}
|
||||
|
||||
protected boolean isCompatible(final Class<?> clazz) {
|
||||
@ -76,7 +82,15 @@ public abstract class ClassModel {
|
||||
|
||||
public abstract Set<ClassModel> getAlls();
|
||||
|
||||
public List<String> getReadOnlyField() {
|
||||
public List<String> getReadOnlyFields() {
|
||||
return List.of();
|
||||
}
|
||||
|
||||
public List<String> getCreateFields() {
|
||||
return List.of();
|
||||
}
|
||||
|
||||
public List<String> getUpdateFields() {
|
||||
return List.of();
|
||||
}
|
||||
|
||||
|
@ -11,7 +11,10 @@ import java.util.List;
|
||||
import java.util.Set;
|
||||
|
||||
import org.kar.archidata.annotation.AnnotationTools;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiAccessLimitation;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiGenerationMode;
|
||||
import org.kar.archidata.exception.DataAccessException;
|
||||
import org.kar.archidata.tools.AnnotationCreator;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
@ -31,6 +34,10 @@ public class ClassObjectModel extends ClassModel {
|
||||
|
||||
public ClassObjectModel(final Class<?> clazz) {
|
||||
this.originClasses = clazz;
|
||||
final ApiGenerationMode tmp = AnnotationTools.get(clazz, ApiGenerationMode.class);
|
||||
if (tmp != null) {
|
||||
this.apiGenerationMode = tmp;
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
@ -74,15 +81,16 @@ public class ClassObjectModel extends ClassModel {
|
||||
DecimalMax decimalMax,
|
||||
Pattern pattern,
|
||||
Email email,
|
||||
Boolean readOnly,
|
||||
ApiAccessLimitation accessLimitation,
|
||||
Boolean notNull,
|
||||
Boolean columnNotNull,
|
||||
Boolean nullable) {
|
||||
|
||||
public FieldProperty(final String name, final ClassModel model, final ClassModel linkClass,
|
||||
final String comment, final Size stringSize, final Min min, final Max max, final DecimalMin decimalMin,
|
||||
final DecimalMax decimalMax, final Pattern pattern, final Email email, final Boolean readOnly,
|
||||
final Boolean notNull, final Boolean columnNotNull, final Boolean nullable) {
|
||||
final DecimalMax decimalMax, final Pattern pattern, final Email email,
|
||||
final ApiAccessLimitation accessLimitation, final Boolean notNull, final Boolean columnNotNull,
|
||||
final Boolean nullable) {
|
||||
this.name = name;
|
||||
this.model = model;
|
||||
this.linkClass = linkClass;
|
||||
@ -94,7 +102,11 @@ public class ClassObjectModel extends ClassModel {
|
||||
this.email = email;
|
||||
this.min = min;
|
||||
this.max = max;
|
||||
this.readOnly = readOnly;
|
||||
if (accessLimitation == null) {
|
||||
this.accessLimitation = AnnotationCreator.createAnnotation(ApiAccessLimitation.class);
|
||||
} else {
|
||||
this.accessLimitation = accessLimitation;
|
||||
}
|
||||
this.notNull = notNull;
|
||||
this.columnNotNull = columnNotNull;
|
||||
this.nullable = nullable;
|
||||
@ -146,7 +158,7 @@ public class ClassObjectModel extends ClassModel {
|
||||
AnnotationTools.getConstraintsDecimalMax(field), //
|
||||
AnnotationTools.getConstraintsPattern(field), //
|
||||
AnnotationTools.getConstraintsEmail(field), //
|
||||
AnnotationTools.getSchemaReadOnly(field), //
|
||||
AnnotationTools.get(field, ApiAccessLimitation.class), //
|
||||
AnnotationTools.getConstraintsNotNull(field), //
|
||||
AnnotationTools.getColumnNotNull(field), //
|
||||
AnnotationTools.getNullable(field));
|
||||
@ -192,7 +204,6 @@ public class ClassObjectModel extends ClassModel {
|
||||
}
|
||||
this.analyzeDone = true;
|
||||
final Class<?> clazz = this.originClasses;
|
||||
this.noWriteSpecificMode = AnnotationTools.getNoWriteSpecificMode(clazz);
|
||||
this.isPrimitive = clazz.isPrimitive();
|
||||
if (this.isPrimitive) {
|
||||
return;
|
||||
@ -259,15 +270,43 @@ public class ClassObjectModel extends ClassModel {
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<String> getReadOnlyField() {
|
||||
public List<String> getReadOnlyFields() {
|
||||
final List<String> out = new ArrayList<>();
|
||||
for (final FieldProperty field : this.fields) {
|
||||
if (field.readOnly()) {
|
||||
if (!field.accessLimitation().creatable() && !field.accessLimitation().updatable()) {
|
||||
out.add(field.name);
|
||||
}
|
||||
}
|
||||
if (this.extendsClass != null) {
|
||||
out.addAll(this.extendsClass.getReadOnlyField());
|
||||
out.addAll(this.extendsClass.getReadOnlyFields());
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<String> getCreateFields() {
|
||||
final List<String> out = new ArrayList<>();
|
||||
for (final FieldProperty field : this.fields) {
|
||||
if (field.accessLimitation().creatable()) {
|
||||
out.add(field.name);
|
||||
}
|
||||
}
|
||||
if (this.extendsClass != null) {
|
||||
out.addAll(this.extendsClass.getReadOnlyFields());
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<String> getUpdateFields() {
|
||||
final List<String> out = new ArrayList<>();
|
||||
for (final FieldProperty field : this.fields) {
|
||||
if (field.accessLimitation().updatable()) {
|
||||
out.add(field.name);
|
||||
}
|
||||
}
|
||||
if (this.extendsClass != null) {
|
||||
out.addAll(this.extendsClass.getReadOnlyFields());
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
@ -45,7 +45,9 @@ public class TsApiGeneration {
|
||||
final ClassEnumModel model,
|
||||
final TsClassElementGroup tsGroup,
|
||||
final Set<ClassModel> imports,
|
||||
final Set<ClassModel> importWrite) throws IOException {
|
||||
final Set<ClassModel> importUpdate,
|
||||
final Set<ClassModel> importCreate,
|
||||
final boolean partialObject) throws IOException {
|
||||
imports.add(model);
|
||||
final TsClassElement tsModel = tsGroup.find(model);
|
||||
return tsModel.tsTypeName;
|
||||
@ -55,34 +57,47 @@ public class TsApiGeneration {
|
||||
final ClassObjectModel model,
|
||||
final TsClassElementGroup tsGroup,
|
||||
final Set<ClassModel> imports,
|
||||
final Set<ClassModel> importWrite) throws IOException {
|
||||
final Set<ClassModel> importUpdate,
|
||||
final Set<ClassModel> importCreate,
|
||||
final boolean partialObject) throws IOException {
|
||||
final TsClassElement tsModel = tsGroup.find(model);
|
||||
if (tsModel.nativeType != DefinedPosition.NATIVE) {
|
||||
if (importWrite == null || tsModel.models.get(0).isNoWriteSpecificMode()) {
|
||||
imports.add(model);
|
||||
if (importCreate != null && tsModel.models.get(0).getApiGenerationMode().create()) {
|
||||
importCreate.add(model);
|
||||
} else if (importUpdate != null && tsModel.models.get(0).getApiGenerationMode().update()) {
|
||||
importUpdate.add(model);
|
||||
} else {
|
||||
importWrite.add(model);
|
||||
imports.add(model);
|
||||
}
|
||||
}
|
||||
String out = tsModel.tsTypeName;
|
||||
if (tsModel.nativeType != DefinedPosition.NORMAL) {
|
||||
return tsModel.tsTypeName;
|
||||
out = tsModel.tsTypeName;
|
||||
} else if (importCreate != null && tsModel.models.get(0).getApiGenerationMode().create()) {
|
||||
out = tsModel.tsTypeName + TsClassElement.MODEL_TYPE_CREATE;
|
||||
} else if (importUpdate != null && tsModel.models.get(0).getApiGenerationMode().update()) {
|
||||
out = tsModel.tsTypeName + TsClassElement.MODEL_TYPE_UPDATE;
|
||||
}
|
||||
if (importWrite != null && !tsModel.models.get(0).isNoWriteSpecificMode()) {
|
||||
return tsModel.tsTypeName + "Write";
|
||||
if (partialObject) {
|
||||
return "Partial<" + out + ">";
|
||||
}
|
||||
return tsModel.tsTypeName;
|
||||
return out;
|
||||
}
|
||||
|
||||
public static String generateClassMapModelTypescript(
|
||||
final ClassMapModel model,
|
||||
final TsClassElementGroup tsGroup,
|
||||
final Set<ClassModel> imports,
|
||||
final Set<ClassModel> importWrite) throws IOException {
|
||||
final Set<ClassModel> importUpdate,
|
||||
final Set<ClassModel> importCreate,
|
||||
final boolean partialObject) throws IOException {
|
||||
final StringBuilder out = new StringBuilder();
|
||||
out.append("{[key: ");
|
||||
out.append(generateClassModelTypescript(model.keyModel, tsGroup, imports, importWrite));
|
||||
out.append(generateClassModelTypescript(model.keyModel, tsGroup, imports, importUpdate, importCreate,
|
||||
partialObject));
|
||||
out.append("]: ");
|
||||
out.append(generateClassModelTypescript(model.valueModel, tsGroup, imports, importWrite));
|
||||
out.append(generateClassModelTypescript(model.valueModel, tsGroup, imports, importUpdate, importCreate,
|
||||
partialObject));
|
||||
out.append(";}");
|
||||
return out.toString();
|
||||
}
|
||||
@ -91,9 +106,12 @@ public class TsApiGeneration {
|
||||
final ClassListModel model,
|
||||
final TsClassElementGroup tsGroup,
|
||||
final Set<ClassModel> imports,
|
||||
final Set<ClassModel> importWrite) throws IOException {
|
||||
final Set<ClassModel> importUpdate,
|
||||
final Set<ClassModel> importCreate,
|
||||
final boolean partialObject) throws IOException {
|
||||
final StringBuilder out = new StringBuilder();
|
||||
out.append(generateClassModelTypescript(model.valueModel, tsGroup, imports, importWrite));
|
||||
out.append(generateClassModelTypescript(model.valueModel, tsGroup, imports, importUpdate, importCreate,
|
||||
partialObject));
|
||||
out.append("[]");
|
||||
return out.toString();
|
||||
}
|
||||
@ -102,18 +120,24 @@ public class TsApiGeneration {
|
||||
final ClassModel model,
|
||||
final TsClassElementGroup tsGroup,
|
||||
final Set<ClassModel> imports,
|
||||
final Set<ClassModel> importWrite) throws IOException {
|
||||
final Set<ClassModel> importUpdate,
|
||||
final Set<ClassModel> importCreate,
|
||||
final boolean partialObject) throws IOException {
|
||||
if (model instanceof final ClassObjectModel objectModel) {
|
||||
return generateClassObjectModelTypescript(objectModel, tsGroup, imports, importWrite);
|
||||
return generateClassObjectModelTypescript(objectModel, tsGroup, imports, importUpdate, importCreate,
|
||||
partialObject);
|
||||
}
|
||||
if (model instanceof final ClassListModel listModel) {
|
||||
return generateClassListModelTypescript(listModel, tsGroup, imports, importWrite);
|
||||
return generateClassListModelTypescript(listModel, tsGroup, imports, importUpdate, importCreate,
|
||||
partialObject);
|
||||
}
|
||||
if (model instanceof final ClassMapModel mapModel) {
|
||||
return generateClassMapModelTypescript(mapModel, tsGroup, imports, importWrite);
|
||||
return generateClassMapModelTypescript(mapModel, tsGroup, imports, importUpdate, importCreate,
|
||||
partialObject);
|
||||
}
|
||||
if (model instanceof final ClassEnumModel enumModel) {
|
||||
return generateClassEnumModelTypescript(enumModel, tsGroup, imports, importWrite);
|
||||
return generateClassEnumModelTypescript(enumModel, tsGroup, imports, importUpdate, importCreate,
|
||||
partialObject);
|
||||
}
|
||||
throw new IOException("Impossible model:" + model);
|
||||
}
|
||||
@ -122,7 +146,9 @@ public class TsApiGeneration {
|
||||
final List<ClassModel> models,
|
||||
final TsClassElementGroup tsGroup,
|
||||
final Set<ClassModel> imports,
|
||||
final Set<ClassModel> importWrite) throws IOException {
|
||||
final Set<ClassModel> importUpdate,
|
||||
final Set<ClassModel> importCreate,
|
||||
final boolean partialObject) throws IOException {
|
||||
if (models.size() == 0) {
|
||||
return "void";
|
||||
}
|
||||
@ -134,7 +160,8 @@ public class TsApiGeneration {
|
||||
} else {
|
||||
out.append(" | ");
|
||||
}
|
||||
final String data = generateClassModelTypescript(model, tsGroup, imports, importWrite);
|
||||
final String data = generateClassModelTypescript(model, tsGroup, imports, importUpdate, importCreate,
|
||||
partialObject);
|
||||
out.append(data);
|
||||
}
|
||||
return out.toString();
|
||||
@ -159,7 +186,8 @@ public class TsApiGeneration {
|
||||
final Set<ClassModel> imports = new HashSet<>();
|
||||
final Set<ClassModel> zodImports = new HashSet<>();
|
||||
final Set<ClassModel> isImports = new HashSet<>();
|
||||
final Set<ClassModel> writeImports = new HashSet<>();
|
||||
final Set<ClassModel> updateImports = new HashSet<>();
|
||||
final Set<ClassModel> createImports = new HashSet<>();
|
||||
final Set<String> toolImports = new HashSet<>();
|
||||
for (final ApiModel interfaceElement : element.interfaces) {
|
||||
final List<String> consumes = interfaceElement.consumes;
|
||||
@ -172,6 +200,7 @@ public class TsApiGeneration {
|
||||
data.append("\n\n");
|
||||
data.append(returnComplexModel.replaceAll("(?m)^", "\t"));
|
||||
for (final ClassModel elem : interfaceElement.returnTypes) {
|
||||
// TODO maybe need to update this with the type of zod requested (like update, create ...
|
||||
zodImports.addAll(elem.getDependencyGroupModels());
|
||||
}
|
||||
}
|
||||
@ -195,6 +224,9 @@ public class TsApiGeneration {
|
||||
if (interfaceElement.unnamedElement.size() == 1 || interfaceElement.multiPartParameters.size() != 0) {
|
||||
data.append("\n\t\t\tdata,");
|
||||
}
|
||||
if (!interfaceElement.headers.isEmpty()) {
|
||||
data.append("\n\t\t\theaders,");
|
||||
}
|
||||
if (needGenerateProgress) {
|
||||
data.append("\n\t\t\tcallbacks,");
|
||||
}
|
||||
@ -207,7 +239,8 @@ public class TsApiGeneration {
|
||||
data.append("\n\t\t\t");
|
||||
data.append(queryEntry.getKey());
|
||||
data.append("?: ");
|
||||
data.append(generateClassModelsTypescript(queryEntry.getValue(), tsGroup, imports, null));
|
||||
data.append(
|
||||
generateClassModelsTypescript(queryEntry.getValue(), tsGroup, imports, null, null, false));
|
||||
data.append(",");
|
||||
}
|
||||
data.append("\n\t\t},");
|
||||
@ -218,15 +251,27 @@ public class TsApiGeneration {
|
||||
data.append("\n\t\t\t");
|
||||
data.append(paramEntry.getKey());
|
||||
data.append(": ");
|
||||
data.append(generateClassModelsTypescript(paramEntry.getValue(), tsGroup, imports, null));
|
||||
data.append(
|
||||
generateClassModelsTypescript(paramEntry.getValue(), tsGroup, imports, null, null, false));
|
||||
data.append(",");
|
||||
}
|
||||
data.append("\n\t\t},");
|
||||
}
|
||||
if (interfaceElement.unnamedElement.size() == 1) {
|
||||
data.append("\n\t\tdata: ");
|
||||
data.append(generateClassModelTypescript(interfaceElement.unnamedElement.get(0), tsGroup, imports,
|
||||
writeImports));
|
||||
if (interfaceElement.restTypeRequest == RestTypeRequest.POST) {
|
||||
data.append(generateClassModelTypescript(interfaceElement.unnamedElement.get(0), tsGroup, imports,
|
||||
null, createImports, false));
|
||||
} else if (interfaceElement.restTypeRequest == RestTypeRequest.PUT) {
|
||||
data.append(generateClassModelTypescript(interfaceElement.unnamedElement.get(0), tsGroup, imports,
|
||||
updateImports, null, false));
|
||||
} else if (interfaceElement.restTypeRequest == RestTypeRequest.PATCH) {
|
||||
data.append(generateClassModelTypescript(interfaceElement.unnamedElement.get(0), tsGroup, imports,
|
||||
updateImports, null, true));
|
||||
} else {
|
||||
data.append(generateClassModelTypescript(interfaceElement.unnamedElement.get(0), tsGroup, imports,
|
||||
null, null, true));
|
||||
}
|
||||
data.append(",");
|
||||
} else if (interfaceElement.multiPartParameters.size() != 0) {
|
||||
data.append("\n\t\tdata: {");
|
||||
@ -238,8 +283,34 @@ public class TsApiGeneration {
|
||||
data.append("?");
|
||||
}
|
||||
data.append(": ");
|
||||
data.append(generateClassModelsTypescript(pathEntry.getValue().model(), tsGroup, imports,
|
||||
writeImports));
|
||||
if (interfaceElement.restTypeRequest == RestTypeRequest.POST) {
|
||||
data.append(generateClassModelsTypescript(pathEntry.getValue().model(), tsGroup, imports, null,
|
||||
createImports, false));
|
||||
} else if (interfaceElement.restTypeRequest == RestTypeRequest.PUT) {
|
||||
data.append(generateClassModelsTypescript(pathEntry.getValue().model(), tsGroup, imports,
|
||||
updateImports, null, false));
|
||||
} else if (interfaceElement.restTypeRequest == RestTypeRequest.PATCH) {
|
||||
data.append(generateClassModelsTypescript(pathEntry.getValue().model(), tsGroup, imports,
|
||||
updateImports, null, true));
|
||||
} else {
|
||||
data.append(generateClassModelsTypescript(pathEntry.getValue().model(), tsGroup, imports, null,
|
||||
null, true));
|
||||
}
|
||||
data.append(",");
|
||||
}
|
||||
data.append("\n\t\t},");
|
||||
}
|
||||
if (!interfaceElement.headers.isEmpty()) {
|
||||
data.append("\n\t\theaders?: {");
|
||||
for (final Entry<String, OptionalClassModel> headerEntry : interfaceElement.headers.entrySet()) {
|
||||
data.append("\n\t\t\t");
|
||||
data.append(headerEntry.getKey());
|
||||
if (headerEntry.getValue().optional()) {
|
||||
data.append("?");
|
||||
}
|
||||
data.append(": ");
|
||||
data.append(generateClassModelsTypescript(headerEntry.getValue().model(), tsGroup, imports, null,
|
||||
null, false));
|
||||
data.append(",");
|
||||
}
|
||||
data.append("\n\t\t},");
|
||||
@ -287,7 +358,7 @@ public class TsApiGeneration {
|
||||
toolImports.add("RESTRequestJson");
|
||||
} else {
|
||||
final String returnType = generateClassModelsTypescript(interfaceElement.returnTypes, tsGroup, imports,
|
||||
null);
|
||||
null, null, false);
|
||||
data.append(returnType);
|
||||
data.append("> {");
|
||||
if ("void".equals(returnType)) {
|
||||
@ -332,7 +403,7 @@ public class TsApiGeneration {
|
||||
data.append("\n\t\t\t\taccept: produce,");
|
||||
} else {
|
||||
final String returnType = generateClassModelsTypescript(interfaceElement.returnTypes, tsGroup,
|
||||
imports, null);
|
||||
imports, null, null, false);
|
||||
if (!"void".equals(returnType)) {
|
||||
for (final String elem : produces) {
|
||||
if (MediaType.APPLICATION_JSON.equals(elem)) {
|
||||
@ -360,6 +431,9 @@ public class TsApiGeneration {
|
||||
if (needGenerateProgress) {
|
||||
data.append("\n\t\t\tcallbacks,");
|
||||
}
|
||||
if (!interfaceElement.headers.isEmpty()) {
|
||||
data.append("\n\t\t\theaders,");
|
||||
}
|
||||
data.append("\n\t\t}");
|
||||
if (returnComplexModel != null) {
|
||||
data.append(", is");
|
||||
@ -419,17 +493,30 @@ public class TsApiGeneration {
|
||||
if (tsModel.nativeType == DefinedPosition.NATIVE) {
|
||||
continue;
|
||||
}
|
||||
if (!tsModel.models.get(0).getApiGenerationMode().read()) {
|
||||
continue;
|
||||
}
|
||||
finalImportSet.add("Zod" + tsModel.tsTypeName);
|
||||
}
|
||||
for (final ClassModel model : writeImports) {
|
||||
for (final ClassModel model : updateImports) {
|
||||
final TsClassElement tsModel = tsGroup.find(model);
|
||||
if (tsModel.nativeType != DefinedPosition.NORMAL) {
|
||||
continue;
|
||||
}
|
||||
if (tsModel.models.get(0).isNoWriteSpecificMode()) {
|
||||
if (!tsModel.models.get(0).getApiGenerationMode().update()) {
|
||||
continue;
|
||||
}
|
||||
finalImportSet.add(tsModel.tsTypeName + "Write");
|
||||
finalImportSet.add(tsModel.tsTypeName + TsClassElement.MODEL_TYPE_UPDATE);
|
||||
}
|
||||
for (final ClassModel model : createImports) {
|
||||
final TsClassElement tsModel = tsGroup.find(model);
|
||||
if (tsModel.nativeType != DefinedPosition.NORMAL) {
|
||||
continue;
|
||||
}
|
||||
if (!tsModel.models.get(0).getApiGenerationMode().create()) {
|
||||
continue;
|
||||
}
|
||||
finalImportSet.add(tsModel.tsTypeName + TsClassElement.MODEL_TYPE_CREATE);
|
||||
}
|
||||
|
||||
if (finalImportSet.size() != 0) {
|
||||
|
@ -27,6 +27,9 @@ public class TsClassElement {
|
||||
NORMAL // Normal Object to interpret.
|
||||
}
|
||||
|
||||
public static final String MODEL_TYPE_UPDATE = "Update";
|
||||
public static final String MODEL_TYPE_CREATE = "Create";
|
||||
|
||||
public List<ClassModel> models;
|
||||
public String zodName;
|
||||
public String tsTypeName;
|
||||
@ -138,7 +141,7 @@ public class TsClassElement {
|
||||
out.append(this.tsTypeName);
|
||||
out.append(");\n");
|
||||
}
|
||||
out.append(generateExportCheckFunctionWrite(""));
|
||||
out.append(generateExportCheckFunctionAppended(""));
|
||||
return out.toString();
|
||||
}
|
||||
|
||||
@ -168,9 +171,9 @@ public class TsClassElement {
|
||||
return out.toString();
|
||||
}
|
||||
|
||||
private String generateExportCheckFunctionWrite(final String writeString) {
|
||||
return generateExportCheckFunction(this.tsCheckType + writeString, this.tsTypeName + writeString,
|
||||
this.zodName + writeString);
|
||||
private String generateExportCheckFunctionAppended(final String appendString) {
|
||||
return generateExportCheckFunction(this.tsCheckType + appendString, this.tsTypeName + appendString,
|
||||
this.zodName + appendString);
|
||||
}
|
||||
|
||||
public String generateImports(final List<ClassModel> depModels, final TsClassElementGroup tsGroup)
|
||||
@ -180,11 +183,23 @@ public class TsClassElement {
|
||||
final TsClassElement tsModel = tsGroup.find(depModel);
|
||||
if (tsModel.nativeType != DefinedPosition.NATIVE) {
|
||||
out.append("import {");
|
||||
out.append(tsModel.zodName);
|
||||
if (tsModel.nativeType == DefinedPosition.NORMAL && !(tsModel.models.get(0).isNoWriteSpecificMode())) {
|
||||
if (tsModel.nativeType != DefinedPosition.NORMAL
|
||||
|| tsModel.models.get(0).getApiGenerationMode().read()) {
|
||||
out.append(tsModel.zodName);
|
||||
}
|
||||
if (tsModel.nativeType == DefinedPosition.NORMAL
|
||||
&& tsModel.models.get(0).getApiGenerationMode().update()) {
|
||||
out.append(", ");
|
||||
out.append(tsModel.zodName);
|
||||
out.append("Write ");
|
||||
out.append(MODEL_TYPE_UPDATE);
|
||||
out.append(" ");
|
||||
}
|
||||
if (tsModel.nativeType == DefinedPosition.NORMAL
|
||||
&& tsModel.models.get(0).getApiGenerationMode().create()) {
|
||||
out.append(", ");
|
||||
out.append(tsModel.zodName);
|
||||
out.append(MODEL_TYPE_CREATE);
|
||||
out.append(" ");
|
||||
}
|
||||
out.append("} from \"./");
|
||||
out.append(tsModel.fileName);
|
||||
@ -321,7 +336,7 @@ public class TsClassElement {
|
||||
}
|
||||
|
||||
public String readOnlyZod(final FieldProperty field) {
|
||||
if (field.readOnly()) {
|
||||
if (!field.accessLimitation().creatable() && !field.accessLimitation().updatable()) {
|
||||
return ".readonly()";
|
||||
}
|
||||
return "";
|
||||
@ -343,18 +358,32 @@ public class TsClassElement {
|
||||
|
||||
public String generateObject(final ClassObjectModel model, final TsClassElementGroup tsGroup) throws IOException {
|
||||
final StringBuilder out = new StringBuilder();
|
||||
|
||||
out.append(getBaseHeader());
|
||||
out.append(generateImports(model.getDependencyModels(), tsGroup));
|
||||
out.append("\n");
|
||||
// ------------------------------------------------------------------------
|
||||
// -- Generate read mode
|
||||
// ------------------------------------------------------------------------
|
||||
|
||||
if (model.getApiGenerationMode().read()) {
|
||||
out.append(generateObjectRead(model, tsGroup));
|
||||
}
|
||||
if (model.getApiGenerationMode().update()) {
|
||||
out.append(generateObjectUpdate(model, tsGroup));
|
||||
}
|
||||
if (model.getApiGenerationMode().create()) {
|
||||
out.append(generateObjectCreate(model, tsGroup));
|
||||
}
|
||||
return out.toString();
|
||||
}
|
||||
|
||||
public String generateObjectRead(final ClassObjectModel model, final TsClassElementGroup tsGroup)
|
||||
throws IOException {
|
||||
final StringBuilder out = new StringBuilder();
|
||||
out.append(generateComment(model));
|
||||
out.append("export const ");
|
||||
out.append(this.zodName);
|
||||
out.append(" = ");
|
||||
// Check if the object is empty:
|
||||
boolean isEmpty = model.getFields().size() == 0;
|
||||
final boolean isEmpty = model.getFields().size() == 0;
|
||||
|
||||
if (model.getExtendsClass() != null) {
|
||||
final ClassModel parentClass = model.getExtendsClass();
|
||||
@ -392,98 +421,138 @@ public class TsClassElement {
|
||||
out.append(optionalTypeZod(field));
|
||||
out.append(",\n");
|
||||
}
|
||||
final List<String> omitField = model.getReadOnlyField();
|
||||
if (model.getExtendsClass() != null && isEmpty) {
|
||||
out.append(";\n");
|
||||
} else {
|
||||
out.append("\n});\n");
|
||||
}
|
||||
out.append(generateZodInfer(this.tsTypeName, this.zodName));
|
||||
out.append(generateExportCheckFunctionWrite(""));
|
||||
// check if we need to generate write mode :
|
||||
if (!model.isNoWriteSpecificMode()) {
|
||||
// ------------------------------------------------------------------------
|
||||
// -- Generate write mode
|
||||
// ------------------------------------------------------------------------
|
||||
//out.append(generateComment(model));
|
||||
out.append("export const ");
|
||||
out.append(this.zodName);
|
||||
out.append("Write = ");
|
||||
isEmpty = model.getFields().stream().filter(field -> !field.readOnly()).count() == 0;
|
||||
if (model.getExtendsClass() != null) {
|
||||
final ClassModel parentClass = model.getExtendsClass();
|
||||
final TsClassElement tsParentModel = tsGroup.find(parentClass);
|
||||
out.append(tsParentModel.zodName);
|
||||
out.append("Write");
|
||||
if (!isEmpty) {
|
||||
out.append(".extend({\n");
|
||||
}
|
||||
} else {
|
||||
out.append("zod.object({\n");
|
||||
out.append(generateExportCheckFunctionAppended(""));
|
||||
return out.toString();
|
||||
}
|
||||
|
||||
public String generateObjectUpdate(final ClassObjectModel model, final TsClassElementGroup tsGroup)
|
||||
throws IOException {
|
||||
final StringBuilder out = new StringBuilder();
|
||||
final String modeleType = MODEL_TYPE_UPDATE;
|
||||
out.append("export const ");
|
||||
out.append(this.zodName);
|
||||
out.append(modeleType);
|
||||
out.append(" = ");
|
||||
// Check if at minimum One fiend is updatable to generate the local object
|
||||
final boolean isEmpty = model.getFields().stream().filter(field -> field.accessLimitation().updatable())
|
||||
.count() == 0;
|
||||
if (model.getExtendsClass() != null) {
|
||||
final ClassModel parentClass = model.getExtendsClass();
|
||||
final TsClassElement tsParentModel = tsGroup.find(parentClass);
|
||||
out.append(tsParentModel.zodName);
|
||||
out.append(modeleType);
|
||||
if (!isEmpty) {
|
||||
out.append(".extend({\n");
|
||||
}
|
||||
for (final FieldProperty field : model.getFields()) {
|
||||
// remove all readOnly field
|
||||
if (field.readOnly()) {
|
||||
continue;
|
||||
}
|
||||
final ClassModel fieldModel = field.model();
|
||||
if (field.comment() != null) {
|
||||
out.append("\t/**\n");
|
||||
out.append("\t * ");
|
||||
out.append(field.comment());
|
||||
out.append("\n\t */\n");
|
||||
}
|
||||
out.append("\t");
|
||||
out.append(field.name());
|
||||
out.append(": ");
|
||||
if (fieldModel instanceof ClassEnumModel || fieldModel instanceof ClassObjectModel) {
|
||||
final TsClassElement tsFieldModel = tsGroup.find(fieldModel);
|
||||
out.append(tsFieldModel.zodName);
|
||||
} else if (fieldModel instanceof final ClassListModel fieldListModel) {
|
||||
final String data = generateTsList(fieldListModel, tsGroup);
|
||||
out.append(data);
|
||||
} else if (fieldModel instanceof final ClassMapModel fieldMapModel) {
|
||||
final String data = generateTsMap(fieldMapModel, tsGroup);
|
||||
out.append(data);
|
||||
}
|
||||
out.append(maxSizeZod(field));
|
||||
out.append(optionalWriteTypeZod(field));
|
||||
// all write field are optional
|
||||
if (field.model() instanceof final ClassObjectModel plop) {
|
||||
if (!plop.isPrimitive()) {
|
||||
out.append(".optional()");
|
||||
}
|
||||
} else {
|
||||
out.append(".optional()");
|
||||
}
|
||||
out.append(",\n");
|
||||
}
|
||||
if (model.getExtendsClass() != null && isEmpty) {
|
||||
out.append(";\n");
|
||||
} else {
|
||||
out.append("\n});\n");
|
||||
}
|
||||
out.append(generateZodInfer(this.tsTypeName + "Write", this.zodName + "Write"));
|
||||
// Check only the input value ==> no need of the output
|
||||
out.append(generateExportCheckFunctionWrite("Write"));
|
||||
// Generate the Write Type associated.
|
||||
/*
|
||||
out.append("\nexport const ");
|
||||
out.append(this.zodName);
|
||||
out.append("Write = ");
|
||||
out.append(this.zodName);
|
||||
if (omitField.size() != 0) {
|
||||
out.append(".omit({\n");
|
||||
for (final String elem : omitField) {
|
||||
out.append("\t");
|
||||
out.append(elem);
|
||||
out.append(": true,\n");
|
||||
}
|
||||
out.append("\n})");
|
||||
}
|
||||
out.append(".partial();\n");
|
||||
*/
|
||||
} else {
|
||||
out.append("zod.object({\n");
|
||||
}
|
||||
for (final FieldProperty field : model.getFields()) {
|
||||
// remove all readOnly field
|
||||
if (!field.accessLimitation().updatable()) {
|
||||
continue;
|
||||
}
|
||||
final ClassModel fieldModel = field.model();
|
||||
if (field.comment() != null) {
|
||||
out.append("\t/**\n");
|
||||
out.append("\t * ");
|
||||
out.append(field.comment());
|
||||
out.append("\n\t */\n");
|
||||
}
|
||||
out.append("\t");
|
||||
out.append(field.name());
|
||||
out.append(": ");
|
||||
if (fieldModel instanceof ClassEnumModel || fieldModel instanceof ClassObjectModel) {
|
||||
final TsClassElement tsFieldModel = tsGroup.find(fieldModel);
|
||||
out.append(tsFieldModel.zodName);
|
||||
} else if (fieldModel instanceof final ClassListModel fieldListModel) {
|
||||
final String data = generateTsList(fieldListModel, tsGroup);
|
||||
out.append(data);
|
||||
} else if (fieldModel instanceof final ClassMapModel fieldMapModel) {
|
||||
final String data = generateTsMap(fieldMapModel, tsGroup);
|
||||
out.append(data);
|
||||
}
|
||||
out.append(maxSizeZod(field));
|
||||
out.append(optionalWriteTypeZod(field));
|
||||
out.append(optionalTypeZod(field));
|
||||
out.append(",\n");
|
||||
}
|
||||
if (model.getExtendsClass() != null && isEmpty) {
|
||||
out.append(";\n");
|
||||
} else {
|
||||
out.append("\n});\n");
|
||||
}
|
||||
out.append(generateZodInfer(this.tsTypeName + modeleType, this.zodName + modeleType));
|
||||
// Check only the input value ==> no need of the output
|
||||
out.append(generateExportCheckFunctionAppended(modeleType));
|
||||
return out.toString();
|
||||
}
|
||||
|
||||
public String generateObjectCreate(final ClassObjectModel model, final TsClassElementGroup tsGroup)
|
||||
throws IOException {
|
||||
final StringBuilder out = new StringBuilder();
|
||||
final String modeleType = MODEL_TYPE_CREATE;
|
||||
out.append("export const ");
|
||||
out.append(this.zodName);
|
||||
out.append(modeleType);
|
||||
out.append(" = ");
|
||||
final boolean isEmpty = model.getFields().stream().filter(field -> field.accessLimitation().creatable())
|
||||
.count() == 0;
|
||||
if (model.getExtendsClass() != null) {
|
||||
final ClassModel parentClass = model.getExtendsClass();
|
||||
final TsClassElement tsParentModel = tsGroup.find(parentClass);
|
||||
out.append(tsParentModel.zodName);
|
||||
out.append(modeleType);
|
||||
if (!isEmpty) {
|
||||
out.append(".extend({\n");
|
||||
}
|
||||
} else {
|
||||
out.append("zod.object({\n");
|
||||
}
|
||||
for (final FieldProperty field : model.getFields()) {
|
||||
// remove all readOnly field
|
||||
if (!field.accessLimitation().creatable()) {
|
||||
continue;
|
||||
}
|
||||
final ClassModel fieldModel = field.model();
|
||||
if (field.comment() != null) {
|
||||
out.append("\t/**\n");
|
||||
out.append("\t * ");
|
||||
out.append(field.comment());
|
||||
out.append("\n\t */\n");
|
||||
}
|
||||
out.append("\t");
|
||||
out.append(field.name());
|
||||
out.append(": ");
|
||||
if (fieldModel instanceof ClassEnumModel || fieldModel instanceof ClassObjectModel) {
|
||||
final TsClassElement tsFieldModel = tsGroup.find(fieldModel);
|
||||
out.append(tsFieldModel.zodName);
|
||||
} else if (fieldModel instanceof final ClassListModel fieldListModel) {
|
||||
final String data = generateTsList(fieldListModel, tsGroup);
|
||||
out.append(data);
|
||||
} else if (fieldModel instanceof final ClassMapModel fieldMapModel) {
|
||||
final String data = generateTsMap(fieldMapModel, tsGroup);
|
||||
out.append(data);
|
||||
}
|
||||
out.append(maxSizeZod(field));
|
||||
out.append(optionalWriteTypeZod(field));
|
||||
out.append(optionalTypeZod(field));
|
||||
out.append(",\n");
|
||||
}
|
||||
if (model.getExtendsClass() != null && isEmpty) {
|
||||
out.append(";\n");
|
||||
} else {
|
||||
out.append("\n});\n");
|
||||
}
|
||||
out.append(generateZodInfer(this.tsTypeName + modeleType, this.zodName + modeleType));
|
||||
// Check only the input value ==> no need of the output
|
||||
out.append(generateExportCheckFunctionAppended(modeleType));
|
||||
return out.toString();
|
||||
}
|
||||
|
||||
|
@ -1,6 +1,7 @@
|
||||
package org.kar.archidata.model;
|
||||
|
||||
import org.kar.archidata.annotation.DataIfNotExists;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiAccessLimitation;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonInclude;
|
||||
|
||||
@ -16,12 +17,15 @@ public class Data extends OIDGenericDataSoftDelete {
|
||||
@Column(length = 128, nullable = false)
|
||||
@Schema(description = "Sha512 of the data")
|
||||
@Size(max = 512)
|
||||
@ApiAccessLimitation(creatable = false, updatable = false)
|
||||
public String sha512;
|
||||
@Column(length = 128, nullable = false)
|
||||
@Schema(description = "Mime -type of the media")
|
||||
@Size(max = 512)
|
||||
@ApiAccessLimitation(creatable = false, updatable = false)
|
||||
public String mimeType;
|
||||
@Column(nullable = false)
|
||||
@Schema(description = "Size in Byte of the data")
|
||||
@ApiAccessLimitation(creatable = false, updatable = false)
|
||||
public Long size;
|
||||
}
|
||||
|
@ -1,15 +1,20 @@
|
||||
package org.kar.archidata.model;
|
||||
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiAccessLimitation;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiGenerationMode;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.persistence.GeneratedValue;
|
||||
import jakarta.persistence.GenerationType;
|
||||
import jakarta.persistence.Id;
|
||||
|
||||
@ApiGenerationMode(create = true, update = true)
|
||||
public class GenericData extends GenericTiming {
|
||||
@Id
|
||||
@GeneratedValue(strategy = GenerationType.IDENTITY)
|
||||
@Column(nullable = false, unique = true)
|
||||
@Schema(description = "Unique Id of the object", required = false, readOnly = true, example = "123456")
|
||||
@Schema(description = "Unique Id of the object", example = "123456")
|
||||
@ApiAccessLimitation(creatable = false, updatable = false)
|
||||
public Long id = null;
|
||||
}
|
||||
|
@ -2,18 +2,22 @@ package org.kar.archidata.model;
|
||||
|
||||
import org.kar.archidata.annotation.DataDeleted;
|
||||
import org.kar.archidata.annotation.DataNotRead;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiAccessLimitation;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiGenerationMode;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import jakarta.annotation.Nullable;
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.ws.rs.DefaultValue;
|
||||
|
||||
@ApiGenerationMode(create = true, update = true)
|
||||
public class GenericDataSoftDelete extends GenericData {
|
||||
@DataNotRead
|
||||
@Column(nullable = false)
|
||||
@DefaultValue("'0'")
|
||||
@DataDeleted
|
||||
@Schema(description = "Deleted state", hidden = true, required = false, readOnly = true)
|
||||
@Schema(description = "Deleted state", hidden = true)
|
||||
@Nullable
|
||||
@ApiAccessLimitation(creatable = false, updatable = false)
|
||||
public Boolean deleted = null;
|
||||
}
|
||||
|
@ -5,6 +5,8 @@ import java.util.Date;
|
||||
import org.kar.archidata.annotation.CreationTimestamp;
|
||||
import org.kar.archidata.annotation.DataNotRead;
|
||||
import org.kar.archidata.annotation.UpdateTimestamp;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiAccessLimitation;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiGenerationMode;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonFormat;
|
||||
|
||||
@ -12,20 +14,22 @@ import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import jakarta.annotation.Nullable;
|
||||
import jakarta.persistence.Column;
|
||||
|
||||
@ApiGenerationMode(create = true, update = true)
|
||||
public class GenericTiming {
|
||||
@DataNotRead
|
||||
@CreationTimestamp
|
||||
@Column(nullable = false)
|
||||
@Schema(description = "Create time of the object", required = false, example = "2000-01-23T01:23:45.678+01:00", readOnly = true)
|
||||
@Column(nullable = false, insertable = false, updatable = false)
|
||||
@Schema(description = "Create time of the object", example = "2000-01-23T01:23:45.678+01:00")
|
||||
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX")
|
||||
@Nullable
|
||||
@ApiAccessLimitation(creatable = false, updatable = false)
|
||||
public Date createdAt = null;
|
||||
@DataNotRead
|
||||
@UpdateTimestamp
|
||||
@Column(nullable = false)
|
||||
@Schema(description = "When update the object", required = false, example = "2000-01-23T00:23:45.678Z", readOnly = true)
|
||||
@Column(nullable = false, insertable = false, updatable = false)
|
||||
@Schema(description = "When update the object", example = "2000-01-23T00:23:45.678Z")
|
||||
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX")
|
||||
// public Instant updatedAt = null;
|
||||
@Nullable
|
||||
@ApiAccessLimitation(creatable = false, updatable = false)
|
||||
public Date updatedAt = null;
|
||||
}
|
||||
|
@ -1,17 +1,21 @@
|
||||
package org.kar.archidata.model;
|
||||
|
||||
import org.bson.types.ObjectId;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiAccessLimitation;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiGenerationMode;
|
||||
|
||||
import dev.morphia.annotations.Id;
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.validation.constraints.NotNull;
|
||||
|
||||
@ApiGenerationMode(create = true, update = true)
|
||||
public class OIDGenericData extends GenericTiming {
|
||||
@Id
|
||||
@jakarta.persistence.Id
|
||||
@Column(nullable = false, unique = true, name = "_id")
|
||||
@Schema(description = "Unique ObjectID of the object", required = false, readOnly = true, example = "65161616841351")
|
||||
@Schema(description = "Unique ObjectID of the object", example = "65161616841351")
|
||||
@NotNull
|
||||
@ApiAccessLimitation(creatable = false, updatable = false)
|
||||
public ObjectId oid = null;
|
||||
}
|
||||
|
@ -2,18 +2,22 @@ package org.kar.archidata.model;
|
||||
|
||||
import org.kar.archidata.annotation.DataDeleted;
|
||||
import org.kar.archidata.annotation.DataNotRead;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiAccessLimitation;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiGenerationMode;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import jakarta.annotation.Nullable;
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.ws.rs.DefaultValue;
|
||||
|
||||
@ApiGenerationMode(create = true, update = true)
|
||||
public class OIDGenericDataSoftDelete extends OIDGenericData {
|
||||
@DataNotRead
|
||||
@Column(nullable = false)
|
||||
@DefaultValue("'0'")
|
||||
@DataDeleted
|
||||
@Schema(description = "Deleted state", hidden = true, required = false, readOnly = true)
|
||||
@Schema(description = "Deleted state", hidden = true)
|
||||
@Nullable
|
||||
@ApiAccessLimitation(creatable = false, updatable = false)
|
||||
public Boolean deleted = null;
|
||||
}
|
||||
|
@ -2,17 +2,22 @@ package org.kar.archidata.model;
|
||||
|
||||
import java.util.UUID;
|
||||
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiAccessLimitation;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiGenerationMode;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.persistence.Id;
|
||||
import jakarta.validation.constraints.NotNull;
|
||||
import jakarta.ws.rs.DefaultValue;
|
||||
|
||||
@ApiGenerationMode(create = true, update = true)
|
||||
public class UUIDGenericData extends GenericTiming {
|
||||
@Id
|
||||
@DefaultValue("(UUID_TO_BIN(UUID(), TRUE))")
|
||||
@Column(nullable = false, unique = true)
|
||||
@Schema(description = "Unique UUID of the object", required = false, readOnly = true, example = "e6b33c1c-d24d-11ee-b616-02420a030102")
|
||||
@Schema(description = "Unique UUID of the object", example = "e6b33c1c-d24d-11ee-b616-02420a030102")
|
||||
@NotNull
|
||||
@ApiAccessLimitation(creatable = false, updatable = false)
|
||||
public UUID uuid = null;
|
||||
}
|
||||
|
@ -2,18 +2,22 @@ package org.kar.archidata.model;
|
||||
|
||||
import org.kar.archidata.annotation.DataDeleted;
|
||||
import org.kar.archidata.annotation.DataNotRead;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiAccessLimitation;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiGenerationMode;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import jakarta.annotation.Nullable;
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.ws.rs.DefaultValue;
|
||||
|
||||
@ApiGenerationMode(create = true, update = true)
|
||||
public class UUIDGenericDataSoftDelete extends UUIDGenericData {
|
||||
@DataNotRead
|
||||
@Column(nullable = false)
|
||||
@DefaultValue("'0'")
|
||||
@DataDeleted
|
||||
@Schema(description = "Deleted state", hidden = true, required = false, readOnly = true)
|
||||
@Schema(description = "Deleted state", hidden = true)
|
||||
@Nullable
|
||||
@ApiAccessLimitation(creatable = false, updatable = false)
|
||||
public Boolean deleted = null;
|
||||
}
|
||||
|
48
src/org/kar/archidata/tools/AnnotationCreator.java
Normal file
48
src/org/kar/archidata/tools/AnnotationCreator.java
Normal file
@ -0,0 +1,48 @@
|
||||
package org.kar.archidata.tools;
|
||||
|
||||
import java.lang.annotation.Annotation;
|
||||
import java.lang.reflect.InvocationHandler;
|
||||
import java.lang.reflect.Method;
|
||||
import java.lang.reflect.Proxy;
|
||||
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiGenerationMode;
|
||||
|
||||
public class AnnotationCreator {
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
public static <A extends Annotation> A createAnnotation(final Class<A> annotationClass, final Object... values) {
|
||||
return (A) Proxy.newProxyInstance(annotationClass.getClassLoader(), new Class<?>[] { annotationClass },
|
||||
new InvocationHandler() {
|
||||
@Override
|
||||
public Object invoke(final Object proxy, final Method method, final Object[] args)
|
||||
throws Throwable {
|
||||
if ("annotationType".equals(method.getName())) {
|
||||
return annotationClass;
|
||||
}
|
||||
if ("toString".equals(method.getName())) {
|
||||
return "@" + annotationClass.getName() + values;
|
||||
}
|
||||
for (int i = 0; i < values.length; i += 2) {
|
||||
if (method.getName().equals(values[i])) {
|
||||
return values[i + 1];
|
||||
}
|
||||
}
|
||||
return method.getDefaultValue();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
public static void main(final String[] args) {
|
||||
final ApiGenerationMode myAnnotation = AnnotationCreator.createAnnotation(ApiGenerationMode.class, "readable",
|
||||
true, "creatable", false, "updatable", false);
|
||||
|
||||
System.out.println("readable: " + myAnnotation.read()); // Output: example
|
||||
System.out.println("creatable: " + myAnnotation.create()); // Output: 100
|
||||
System.out.println("updatable: " + myAnnotation.update()); // Output: 100
|
||||
final ApiGenerationMode myAnnotation2 = AnnotationCreator.createAnnotation(ApiGenerationMode.class);
|
||||
|
||||
System.out.println("readable: " + myAnnotation2.read()); // Output: example
|
||||
System.out.println("creatable: " + myAnnotation2.create()); // Output: 100
|
||||
System.out.println("updatable: " + myAnnotation2.update()); // Output: 100
|
||||
}
|
||||
}
|
@ -17,6 +17,7 @@ import org.slf4j.LoggerFactory;
|
||||
|
||||
import com.fasterxml.jackson.core.JsonParseException;
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import com.fasterxml.jackson.databind.exc.InvalidDefinitionException;
|
||||
import com.fasterxml.jackson.databind.exc.MismatchedInputException;
|
||||
|
||||
import jakarta.ws.rs.core.HttpHeaders;
|
||||
@ -36,7 +37,7 @@ public class RESTApi {
|
||||
this.token = token;
|
||||
}
|
||||
|
||||
public <T> List<T> gets(final Class<T> clazz, final String urlOffset)
|
||||
public <TYPE_RESPONSE> List<TYPE_RESPONSE> gets(final Class<TYPE_RESPONSE> clazz, final String urlOffset)
|
||||
throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
final HttpClient client = HttpClient.newHttpClient();
|
||||
Builder requestBuilding = HttpRequest.newBuilder().version(Version.HTTP_1_1)
|
||||
@ -60,58 +61,79 @@ public class RESTApi {
|
||||
this.mapper.getTypeFactory().constructCollectionType(List.class, clazz));
|
||||
}
|
||||
|
||||
public <T> T get(final Class<T> clazz, final String urlOffset)
|
||||
public <TYPE_RESPONSE> TYPE_RESPONSE get(final Class<TYPE_RESPONSE> clazz, final String urlOffset)
|
||||
throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
return modelSendJson("GET", clazz, urlOffset, null);
|
||||
}
|
||||
|
||||
public <T, U> T post(final Class<T> clazz, final String urlOffset, final U data)
|
||||
throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
public <TYPE_RESPONSET, TYPE_BODY> TYPE_RESPONSET post(
|
||||
final Class<TYPE_RESPONSET> clazz,
|
||||
final String urlOffset,
|
||||
final TYPE_BODY data) throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
return modelSend("POST", clazz, urlOffset, data);
|
||||
}
|
||||
|
||||
public <T, U> T postJson(final Class<T> clazz, final String urlOffset, final String body)
|
||||
throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
public <TYPE_RESPONSE> TYPE_RESPONSE postJson(
|
||||
final Class<TYPE_RESPONSE> clazz,
|
||||
final String urlOffset,
|
||||
final String body) throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
return modelSendJson("POST", clazz, urlOffset, body);
|
||||
}
|
||||
|
||||
public <T> T postMap(final Class<T> clazz, final String urlOffset, final Map<String, Object> data)
|
||||
throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
public <TYPE_RESPONSE> TYPE_RESPONSE postMap(
|
||||
final Class<TYPE_RESPONSE> clazz,
|
||||
final String urlOffset,
|
||||
final Map<String, Object> data) throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
return modelSendMap("POST", clazz, urlOffset, data);
|
||||
}
|
||||
|
||||
public <T, U> T put(final Class<T> clazz, final String urlOffset, final U data)
|
||||
throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
public <TYPE_RESPONSE, TYPE_BODY> TYPE_RESPONSE put(
|
||||
final Class<TYPE_RESPONSE> clazz,
|
||||
final String urlOffset,
|
||||
final TYPE_BODY data) throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
return modelSend("PUT", clazz, urlOffset, data);
|
||||
}
|
||||
|
||||
public <T, U> T putJson(final Class<T> clazz, final String urlOffset, final String body)
|
||||
throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
public <TYPE_RESPONSE> TYPE_RESPONSE putJson(
|
||||
final Class<TYPE_RESPONSE> clazz,
|
||||
final String urlOffset,
|
||||
final String body) throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
return modelSendJson("PUT", clazz, urlOffset, body);
|
||||
}
|
||||
|
||||
public <T> T putMap(final Class<T> clazz, final String urlOffset, final Map<String, Object> data)
|
||||
throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
public <TYPE_RESPONSE> TYPE_RESPONSE putMap(
|
||||
final Class<TYPE_RESPONSE> clazz,
|
||||
final String urlOffset,
|
||||
final Map<String, Object> data) throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
return modelSendMap("PUT", clazz, urlOffset, data);
|
||||
}
|
||||
|
||||
public <T, U> T patch(final Class<T> clazz, final String urlOffset, final U data)
|
||||
throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
public <TYPE_RESPONSE, TYPE_BODY> TYPE_RESPONSE patch(
|
||||
final Class<TYPE_RESPONSE> clazz,
|
||||
final String urlOffset,
|
||||
final TYPE_BODY data) throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
return modelSend("PATCH", clazz, urlOffset, data);
|
||||
}
|
||||
|
||||
public <T, U> T patchJson(final Class<T> clazz, final String urlOffset, final String body)
|
||||
throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
public <TYPE_RESPONSE, TYPE_BODY> TYPE_RESPONSE patchJson(
|
||||
final Class<TYPE_RESPONSE> clazz,
|
||||
final String urlOffset,
|
||||
final String body) throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
return modelSendJson("PATCH", clazz, urlOffset, body);
|
||||
}
|
||||
|
||||
public <T> T patchMap(final Class<T> clazz, final String urlOffset, final Map<String, Object> data)
|
||||
throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
public <TYPE_RESPONSE> TYPE_RESPONSE patchMap(
|
||||
final Class<TYPE_RESPONSE> clazz,
|
||||
final String urlOffset,
|
||||
final Map<String, Object> data) throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
return modelSendMap("PATCH", clazz, urlOffset, data);
|
||||
}
|
||||
|
||||
protected <T, U> T modelSend(final String model, final Class<T> clazz, final String urlOffset, final U data)
|
||||
throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
protected <TYPE_RESPONSE, TYPE_BODY> TYPE_RESPONSE modelSend(
|
||||
final String model,
|
||||
final Class<TYPE_RESPONSE> clazz,
|
||||
final String urlOffset,
|
||||
final TYPE_BODY data) throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
if (data == null) {
|
||||
return modelSendJson(model, clazz, urlOffset, null);
|
||||
} else {
|
||||
@ -121,8 +143,11 @@ public class RESTApi {
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
public <T, U> T modelSendJson(final String model, final Class<T> clazz, final String urlOffset, String body)
|
||||
throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
public <TYPE_RESPONSE> TYPE_RESPONSE modelSendJson(
|
||||
final String model,
|
||||
final Class<TYPE_RESPONSE> clazz,
|
||||
final String urlOffset,
|
||||
String body) throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
final HttpClient client = HttpClient.newHttpClient();
|
||||
// client.property(HttpUrlConnectorProvider.SET_METHOD_WORKAROUND, true);
|
||||
Builder requestBuilding = HttpRequest.newBuilder().version(Version.HTTP_1_1)
|
||||
@ -146,30 +171,37 @@ public class RESTApi {
|
||||
final RESTErrorResponseException out = this.mapper.readValue(httpResponse.body(),
|
||||
RESTErrorResponseException.class);
|
||||
throw out;
|
||||
} catch (final InvalidDefinitionException ex) {
|
||||
ex.printStackTrace();
|
||||
LOGGER.error("body: {}", httpResponse.body());
|
||||
throw new IOException("RestAPI Fail to parse the error " + ex.getClass().getName() + " ["
|
||||
+ httpResponse.statusCode() + "] " + httpResponse.body());
|
||||
} catch (final MismatchedInputException ex) {
|
||||
throw new IOException(
|
||||
"Fail to get the data [" + httpResponse.statusCode() + "] " + httpResponse.body());
|
||||
ex.printStackTrace();
|
||||
LOGGER.error("body: {}", httpResponse.body());
|
||||
throw new IOException("RestAPI Fail to parse the error " + ex.getClass().getName() + " ["
|
||||
+ httpResponse.statusCode() + "] " + httpResponse.body());
|
||||
} catch (final JsonParseException ex) {
|
||||
ex.printStackTrace();
|
||||
LOGGER.error("body: {}", httpResponse.body());
|
||||
throw new IOException(
|
||||
"Fail to get the ERROR data [" + httpResponse.statusCode() + "] " + httpResponse.body());
|
||||
throw new IOException("RestAPI Fail to parse the error " + ex.getClass().getName() + " ["
|
||||
+ httpResponse.statusCode() + "] " + httpResponse.body());
|
||||
}
|
||||
}
|
||||
if (clazz == Void.class || clazz == void.class) {
|
||||
return null;
|
||||
}
|
||||
if (clazz.equals(String.class)) {
|
||||
return (T) httpResponse.body();
|
||||
return (TYPE_RESPONSE) httpResponse.body();
|
||||
}
|
||||
LOGGER.trace("Receive model: {} with data: '{}'", clazz.getCanonicalName(), httpResponse.body());
|
||||
return this.mapper.readValue(httpResponse.body(), clazz);
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
public <T> T modelSendMap(
|
||||
public <TYPE_RESPONSE> TYPE_RESPONSE modelSendMap(
|
||||
final String model,
|
||||
final Class<T> clazz,
|
||||
final Class<TYPE_RESPONSE> clazz,
|
||||
final String urlOffset,
|
||||
final Map<String, Object> data) throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
final HttpClient client = HttpClient.newHttpClient();
|
||||
@ -201,7 +233,7 @@ public class RESTApi {
|
||||
return null;
|
||||
}
|
||||
if (clazz.equals(String.class)) {
|
||||
return (T) httpResponse.body();
|
||||
return (TYPE_RESPONSE) httpResponse.body();
|
||||
}
|
||||
return this.mapper.readValue(httpResponse.body(), clazz);
|
||||
}
|
||||
@ -216,12 +248,12 @@ public class RESTApi {
|
||||
|
||||
/**
|
||||
* Call a DELETE on a REST API with retrieving some data
|
||||
* @param <T> Type of data that might be received.
|
||||
* @param <TYPE_RESPONSE> Type of data that might be received.
|
||||
* @param clazz Class model of the data that might be parsed.
|
||||
* @param urlOffset Offset to call the API
|
||||
* @return The parsed object received.
|
||||
*/
|
||||
public <T> T delete(final Class<T> clazz, final String urlOffset)
|
||||
public <TYPE_RESPONSE> TYPE_RESPONSE delete(final Class<TYPE_RESPONSE> clazz, final String urlOffset)
|
||||
throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
return simpleRequest("DELETE", clazz, urlOffset);
|
||||
}
|
||||
@ -236,12 +268,12 @@ public class RESTApi {
|
||||
|
||||
/**
|
||||
* Call a ARCHIVE on a REST API with retrieving some data
|
||||
* @param <T> Type of data that might be received.
|
||||
* @param <TYPE_RESPONSE> Type of data that might be received.
|
||||
* @param clazz Class model of the data that might be parsed.
|
||||
* @param urlOffset Offset to call the API
|
||||
* @return The parsed object received.
|
||||
*/
|
||||
public <T> T archive(final Class<T> clazz, final String urlOffset)
|
||||
public <TYPE_RESPONSE> TYPE_RESPONSE archive(final Class<TYPE_RESPONSE> clazz, final String urlOffset)
|
||||
throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
return simpleRequest("ARCHIVE", clazz, urlOffset);
|
||||
}
|
||||
@ -268,14 +300,16 @@ public class RESTApi {
|
||||
|
||||
/**
|
||||
* Call a key on a REST API with retrieving some data
|
||||
* @param <T> Type of data that might be received.
|
||||
* @param <TYPE_RESPONSE> Type of data that might be received.
|
||||
* @param model name of the key for the REST call
|
||||
* @param clazz Class model of the data that might be parsed.
|
||||
* @param urlOffset Offset to call the API
|
||||
* @return The parsed object received.
|
||||
*/
|
||||
public <T> T simpleRequest(final String model, final Class<T> clazz, final String urlOffset)
|
||||
throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
public <TYPE_RESPONSE> TYPE_RESPONSE simpleRequest(
|
||||
final String model,
|
||||
final Class<TYPE_RESPONSE> clazz,
|
||||
final String urlOffset) throws RESTErrorResponseException, IOException, InterruptedException {
|
||||
final HttpClient client = HttpClient.newHttpClient();
|
||||
Builder requestBuilding = HttpRequest.newBuilder().version(Version.HTTP_1_1)
|
||||
.uri(URI.create(this.baseUrl + urlOffset));
|
||||
@ -298,7 +332,7 @@ public class RESTApi {
|
||||
return null;
|
||||
}
|
||||
if (clazz.equals(String.class)) {
|
||||
return (T) httpResponse.body();
|
||||
return (TYPE_RESPONSE) httpResponse.body();
|
||||
}
|
||||
return this.mapper.readValue(httpResponse.body(), clazz);
|
||||
}
|
||||
|
@ -3,30 +3,29 @@
|
||||
* @copyright 2024, Edouard DUPIN, all right reserved
|
||||
* @license MPL-2
|
||||
*/
|
||||
|
||||
import { RestErrorResponse, isRestErrorResponse } from "./model";
|
||||
import { RestErrorResponse, isRestErrorResponse } from './model';
|
||||
|
||||
export enum HTTPRequestModel {
|
||||
ARCHIVE = "ARCHIVE",
|
||||
DELETE = "DELETE",
|
||||
HEAD = "HEAD",
|
||||
GET = "GET",
|
||||
OPTION = "OPTION",
|
||||
PATCH = "PATCH",
|
||||
POST = "POST",
|
||||
PUT = "PUT",
|
||||
RESTORE = "RESTORE",
|
||||
ARCHIVE = 'ARCHIVE',
|
||||
DELETE = 'DELETE',
|
||||
HEAD = 'HEAD',
|
||||
GET = 'GET',
|
||||
OPTION = 'OPTION',
|
||||
PATCH = 'PATCH',
|
||||
POST = 'POST',
|
||||
PUT = 'PUT',
|
||||
RESTORE = 'RESTORE',
|
||||
}
|
||||
export enum HTTPMimeType {
|
||||
ALL = "*/*",
|
||||
CSV = "text/csv",
|
||||
IMAGE = "image/*",
|
||||
IMAGE_JPEG = "image/jpeg",
|
||||
IMAGE_PNG = "image/png",
|
||||
JSON = "application/json",
|
||||
MULTIPART = "multipart/form-data",
|
||||
OCTET_STREAM = "application/octet-stream",
|
||||
TEXT_PLAIN = "text/plain",
|
||||
ALL = '*/*',
|
||||
CSV = 'text/csv',
|
||||
IMAGE = 'image/*',
|
||||
IMAGE_JPEG = 'image/jpeg',
|
||||
IMAGE_PNG = 'image/png',
|
||||
JSON = 'application/json',
|
||||
MULTIPART = 'multipart/form-data',
|
||||
OCTET_STREAM = 'application/octet-stream',
|
||||
TEXT_PLAIN = 'text/plain',
|
||||
}
|
||||
|
||||
export interface RESTConfig {
|
||||
@ -54,6 +53,14 @@ export interface ModelResponseHttp {
|
||||
data: any;
|
||||
}
|
||||
|
||||
export type ErrorRestApiCallback = (response: Response) => void;
|
||||
|
||||
let errorApiGlobalCallback: ErrorRestApiCallback | undefined = undefined;
|
||||
|
||||
export const setErrorApiGlobalCallback = (callback: ErrorRestApiCallback) => {
|
||||
errorApiGlobalCallback = callback;
|
||||
};
|
||||
|
||||
function isNullOrUndefined(data: any): data is undefined | null {
|
||||
return data === undefined || data === null;
|
||||
}
|
||||
@ -78,6 +85,7 @@ export interface RESTRequestType {
|
||||
data?: any;
|
||||
params?: object;
|
||||
queries?: object;
|
||||
headers?: any;
|
||||
callbacks?: RESTCallbacks;
|
||||
}
|
||||
|
||||
@ -87,15 +95,15 @@ function replaceAll(input, searchValue, replaceValue) {
|
||||
|
||||
function removeTrailingSlashes(input: string): string {
|
||||
if (isNullOrUndefined(input)) {
|
||||
return "undefined";
|
||||
return 'undefined';
|
||||
}
|
||||
return input.replace(/\/+$/, "");
|
||||
return input.replace(/\/+$/, '');
|
||||
}
|
||||
function removeLeadingSlashes(input: string): string {
|
||||
if (isNullOrUndefined(input)) {
|
||||
return "";
|
||||
return '';
|
||||
}
|
||||
return input.replace(/^\/+/, "");
|
||||
return input.replace(/^\/+/, '');
|
||||
}
|
||||
|
||||
export function RESTUrl({
|
||||
@ -133,9 +141,9 @@ export function RESTUrl({
|
||||
}
|
||||
}
|
||||
if (restConfig.token !== undefined && restModel.tokenInUrl === true) {
|
||||
searchParams.append("Authorization", `Bearer ${restConfig.token}`);
|
||||
searchParams.append('Authorization', `Bearer ${restConfig.token}`);
|
||||
}
|
||||
return generateUrl + "?" + searchParams.toString();
|
||||
return generateUrl + '?' + searchParams.toString();
|
||||
}
|
||||
|
||||
export function fetchProgress(
|
||||
@ -159,7 +167,7 @@ export function fetchProgress(
|
||||
return new Promise((resolve, reject) => {
|
||||
// Stream the upload progress
|
||||
if (progressUpload) {
|
||||
xhr.io?.upload.addEventListener("progress", (dataEvent) => {
|
||||
xhr.io?.upload.addEventListener('progress', (dataEvent) => {
|
||||
if (dataEvent.lengthComputable) {
|
||||
progressUpload(dataEvent.loaded, dataEvent.total);
|
||||
}
|
||||
@ -167,7 +175,7 @@ export function fetchProgress(
|
||||
}
|
||||
// Stream the download progress
|
||||
if (progressDownload) {
|
||||
xhr.io?.addEventListener("progress", (dataEvent) => {
|
||||
xhr.io?.addEventListener('progress', (dataEvent) => {
|
||||
if (dataEvent.lengthComputable) {
|
||||
progressDownload(dataEvent.loaded, dataEvent.total);
|
||||
}
|
||||
@ -187,19 +195,19 @@ export function fetchProgress(
|
||||
};
|
||||
}
|
||||
// Check if we have an internal Fail:
|
||||
xhr.io?.addEventListener("error", () => {
|
||||
xhr.io?.addEventListener('error', () => {
|
||||
xhr.io = undefined;
|
||||
reject(new TypeError("Failed to fetch"));
|
||||
reject(new TypeError('Failed to fetch'));
|
||||
});
|
||||
|
||||
// Capture the end of the stream
|
||||
xhr.io?.addEventListener("loadend", () => {
|
||||
xhr.io?.addEventListener('loadend', () => {
|
||||
if (xhr.io?.readyState !== XMLHttpRequest.DONE) {
|
||||
return;
|
||||
}
|
||||
if (xhr.io?.status === 0) {
|
||||
//the stream has been aborted
|
||||
reject(new TypeError("Fetch has been aborted"));
|
||||
reject(new TypeError('Fetch has been aborted'));
|
||||
return;
|
||||
}
|
||||
// Stream is ended, transform in a generic response:
|
||||
@ -209,17 +217,17 @@ export function fetchProgress(
|
||||
});
|
||||
const headersArray = replaceAll(
|
||||
xhr.io.getAllResponseHeaders().trim(),
|
||||
"\r\n",
|
||||
"\n"
|
||||
).split("\n");
|
||||
'\r\n',
|
||||
'\n'
|
||||
).split('\n');
|
||||
headersArray.forEach(function (header) {
|
||||
const firstColonIndex = header.indexOf(":");
|
||||
const firstColonIndex = header.indexOf(':');
|
||||
if (firstColonIndex !== -1) {
|
||||
const key = header.substring(0, firstColonIndex).trim();
|
||||
const value = header.substring(firstColonIndex + 1).trim();
|
||||
response.headers.set(key, value);
|
||||
} else {
|
||||
response.headers.set(header, "");
|
||||
response.headers.set(header, '');
|
||||
}
|
||||
});
|
||||
xhr.io = undefined;
|
||||
@ -241,27 +249,29 @@ export function RESTRequest({
|
||||
data,
|
||||
params,
|
||||
queries,
|
||||
headers = {},
|
||||
callbacks,
|
||||
}: RESTRequestType): Promise<ModelResponseHttp> {
|
||||
// Create the URL PATH:
|
||||
let generateUrl = RESTUrl({ restModel, restConfig, data, params, queries });
|
||||
let headers: any = {};
|
||||
if (restConfig.token !== undefined && restModel.tokenInUrl !== true) {
|
||||
headers["Authorization"] = `Bearer ${restConfig.token}`;
|
||||
headers['Authorization'] = `Bearer ${restConfig.token}`;
|
||||
}
|
||||
if (restModel.accept !== undefined) {
|
||||
headers["Accept"] = restModel.accept;
|
||||
headers['Accept'] = restModel.accept;
|
||||
}
|
||||
if (restModel.requestType !== HTTPRequestModel.GET &&
|
||||
restModel.requestType !== HTTPRequestModel.ARCHIVE &&
|
||||
restModel.requestType !== HTTPRequestModel.RESTORE
|
||||
if (
|
||||
restModel.requestType !== HTTPRequestModel.GET &&
|
||||
restModel.requestType !== HTTPRequestModel.ARCHIVE &&
|
||||
restModel.requestType !== HTTPRequestModel.RESTORE
|
||||
) {
|
||||
// if Get we have not a content type, the body is empty
|
||||
if (restModel.contentType !== HTTPMimeType.MULTIPART &&
|
||||
restModel.contentType !== undefined
|
||||
) {
|
||||
if (
|
||||
restModel.contentType !== HTTPMimeType.MULTIPART &&
|
||||
restModel.contentType !== undefined
|
||||
) {
|
||||
// special case of multi-part ==> no content type otherwise the browser does not set the ";bundary=--****"
|
||||
headers["Content-Type"] = restModel.contentType;
|
||||
headers['Content-Type'] = restModel.contentType;
|
||||
}
|
||||
}
|
||||
let body = data;
|
||||
@ -302,19 +312,27 @@ export function RESTRequest({
|
||||
}
|
||||
action
|
||||
.then((response: Response) => {
|
||||
if (
|
||||
errorApiGlobalCallback &&
|
||||
400 <= response.status &&
|
||||
response.status <= 499
|
||||
) {
|
||||
// Detect an error and trigger the generic error callback:
|
||||
errorApiGlobalCallback(response);
|
||||
}
|
||||
if (response.status >= 200 && response.status <= 299) {
|
||||
const contentType = response.headers.get("Content-Type");
|
||||
const contentType = response.headers.get('Content-Type');
|
||||
if (
|
||||
!isNullOrUndefined(restModel.accept) &&
|
||||
restModel.accept !== contentType
|
||||
) {
|
||||
reject({
|
||||
name: "Model accept type incompatible",
|
||||
name: 'Model accept type incompatible',
|
||||
time: Date().toString(),
|
||||
status: 901,
|
||||
message: `REST Content type are not compatible: ${restModel.accept} != ${contentType}`,
|
||||
statusMessage: "Fetch error",
|
||||
error: "rest-tools.ts Wrong type in the message return type",
|
||||
statusMessage: 'Fetch error',
|
||||
error: 'rest-tools.ts Wrong type in the message return type',
|
||||
} as RestErrorResponse);
|
||||
} else if (contentType === HTTPMimeType.JSON) {
|
||||
response
|
||||
@ -324,12 +342,12 @@ export function RESTRequest({
|
||||
})
|
||||
.catch((reason: Error) => {
|
||||
reject({
|
||||
name: "API serialization error",
|
||||
name: 'API serialization error',
|
||||
time: Date().toString(),
|
||||
status: 902,
|
||||
message: `REST parse json fail: ${reason}`,
|
||||
statusMessage: "Fetch parse error",
|
||||
error: "rest-tools.ts Wrong message model to parse",
|
||||
statusMessage: 'Fetch parse error',
|
||||
error: 'rest-tools.ts Wrong message model to parse',
|
||||
} as RestErrorResponse);
|
||||
});
|
||||
} else {
|
||||
@ -349,22 +367,22 @@ export function RESTRequest({
|
||||
.text()
|
||||
.then((dataError: string) => {
|
||||
reject({
|
||||
name: "API serialization error",
|
||||
name: 'API serialization error',
|
||||
time: Date().toString(),
|
||||
status: 903,
|
||||
message: `REST parse error json with wrong type fail. ${dataError}`,
|
||||
statusMessage: "Fetch parse error",
|
||||
error: "rest-tools.ts Wrong message model to parse",
|
||||
statusMessage: 'Fetch parse error',
|
||||
error: 'rest-tools.ts Wrong message model to parse',
|
||||
} as RestErrorResponse);
|
||||
})
|
||||
.catch((reason: any) => {
|
||||
reject({
|
||||
name: "API serialization error",
|
||||
name: 'API serialization error',
|
||||
time: Date().toString(),
|
||||
status: response.status,
|
||||
message: `unmanaged error model: ??? with error: ${reason}`,
|
||||
statusMessage: "Fetch ERROR parse error",
|
||||
error: "rest-tools.ts Wrong message model to parse",
|
||||
statusMessage: 'Fetch ERROR parse error',
|
||||
error: 'rest-tools.ts Wrong message model to parse',
|
||||
} as RestErrorResponse);
|
||||
});
|
||||
}
|
||||
@ -374,22 +392,22 @@ export function RESTRequest({
|
||||
.text()
|
||||
.then((dataError: string) => {
|
||||
reject({
|
||||
name: "API serialization error",
|
||||
name: 'API serialization error',
|
||||
time: Date().toString(),
|
||||
status: response.status,
|
||||
message: `unmanaged error model: ${dataError} with error: ${reason}`,
|
||||
statusMessage: "Fetch ERROR TEXT parse error",
|
||||
error: "rest-tools.ts Wrong message model to parse",
|
||||
statusMessage: 'Fetch ERROR TEXT parse error',
|
||||
error: 'rest-tools.ts Wrong message model to parse',
|
||||
} as RestErrorResponse);
|
||||
})
|
||||
.catch((reason: any) => {
|
||||
reject({
|
||||
name: "API serialization error",
|
||||
name: 'API serialization error',
|
||||
time: Date().toString(),
|
||||
status: response.status,
|
||||
message: `unmanaged error model: ??? with error: ${reason}`,
|
||||
statusMessage: "Fetch ERROR TEXT FAIL",
|
||||
error: "rest-tools.ts Wrong message model to parse",
|
||||
statusMessage: 'Fetch ERROR TEXT FAIL',
|
||||
error: 'rest-tools.ts Wrong message model to parse',
|
||||
} as RestErrorResponse);
|
||||
});
|
||||
});
|
||||
@ -400,12 +418,12 @@ export function RESTRequest({
|
||||
reject(error);
|
||||
} else {
|
||||
reject({
|
||||
name: "Request fail",
|
||||
name: 'Request fail',
|
||||
time: Date(),
|
||||
status: 999,
|
||||
message: error,
|
||||
statusMessage: "Fetch catch error",
|
||||
error: "rest-tools.ts detect an error in the fetch request",
|
||||
statusMessage: 'Fetch catch error',
|
||||
error: 'rest-tools.ts detect an error in the fetch request',
|
||||
});
|
||||
}
|
||||
});
|
||||
@ -426,12 +444,12 @@ export function RESTRequestJson<TYPE>(
|
||||
resolve(value.data);
|
||||
} else {
|
||||
reject({
|
||||
name: "Model check fail",
|
||||
name: 'Model check fail',
|
||||
time: Date().toString(),
|
||||
status: 950,
|
||||
error: "REST Fail to verify the data",
|
||||
statusMessage: "API cast ERROR",
|
||||
message: "api.ts Check type as fail",
|
||||
error: 'REST Fail to verify the data',
|
||||
statusMessage: 'API cast ERROR',
|
||||
message: 'api.ts Check type as fail',
|
||||
} as RestErrorResponse);
|
||||
}
|
||||
})
|
||||
|
@ -30,8 +30,6 @@ public class TestTime {
|
||||
static WebLauncherTest webInterface = null;
|
||||
static RESTApi api = null;
|
||||
|
||||
private static Long idTest = 0L;
|
||||
|
||||
@BeforeAll
|
||||
public static void configureWebServer() throws Exception {
|
||||
ConfigureDb.configure();
|
||||
|
@ -4,7 +4,7 @@ import java.util.ArrayList;
|
||||
import java.util.Date;
|
||||
import java.util.List;
|
||||
|
||||
import org.kar.archidata.annotation.AsyncType;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiAsyncType;
|
||||
import org.kar.archidata.annotation.method.ARCHIVE;
|
||||
import org.kar.archidata.annotation.method.RESTORE;
|
||||
import org.kar.archidata.exception.NotFoundException;
|
||||
@ -100,7 +100,7 @@ public class TestResource {
|
||||
@Consumes(MediaType.APPLICATION_JSON)
|
||||
public SimpleArchiveTable patch(
|
||||
@PathParam("id") final Long id,
|
||||
@AsyncType(SimpleArchiveTable.class) final String jsonRequest) throws Exception {
|
||||
@ApiAsyncType(SimpleArchiveTable.class) final String jsonRequest) throws Exception {
|
||||
LOGGER.info("patch({})", id);
|
||||
throw new NotFoundException("element does not exist: " + id);
|
||||
}
|
||||
|
@ -2,7 +2,7 @@ package test.kar.archidata.apiExtern.resource;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import org.kar.archidata.annotation.AsyncType;
|
||||
import org.kar.archidata.annotation.apiGenerator.ApiAsyncType;
|
||||
import org.kar.archidata.annotation.method.ARCHIVE;
|
||||
import org.kar.archidata.annotation.method.RESTORE;
|
||||
import org.kar.archidata.dataAccess.DataAccess;
|
||||
@ -66,7 +66,7 @@ public class TestResourceSample {
|
||||
@Path("{id}")
|
||||
@PermitAll
|
||||
@Consumes(MediaType.APPLICATION_JSON)
|
||||
public SimpleTable patch(@PathParam("id") final Long id, @AsyncType(SimpleTable.class) final String jsonRequest)
|
||||
public SimpleTable patch(@PathParam("id") final Long id, @ApiAsyncType(SimpleTable.class) final String jsonRequest)
|
||||
throws Exception {
|
||||
DataAccess.updateWithJson(SimpleTable.class, id, jsonRequest);
|
||||
return DataAccess.get(SimpleTable.class, id);
|
||||
|
@ -0,0 +1,95 @@
|
||||
package test.kar.archidata.hybernateValidator;
|
||||
|
||||
import java.util.ArrayList;
|
||||
|
||||
import org.junit.jupiter.api.AfterAll;
|
||||
import org.junit.jupiter.api.Assertions;
|
||||
import org.junit.jupiter.api.BeforeAll;
|
||||
import org.junit.jupiter.api.MethodOrderer;
|
||||
import org.junit.jupiter.api.Order;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.api.TestMethodOrder;
|
||||
import org.junit.jupiter.api.extension.ExtendWith;
|
||||
import org.kar.archidata.exception.RESTErrorResponseException;
|
||||
import org.kar.archidata.tools.ConfigBaseVariable;
|
||||
import org.kar.archidata.tools.RESTApi;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import test.kar.archidata.ConfigureDb;
|
||||
import test.kar.archidata.StepwiseExtension;
|
||||
import test.kar.archidata.apiExtern.Common;
|
||||
import test.kar.archidata.hybernateValidator.model.ValidatorModel;
|
||||
import test.kar.archidata.hybernateValidator.model.ValidatorSubModel;
|
||||
|
||||
@ExtendWith(StepwiseExtension.class)
|
||||
@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
|
||||
public class TestValidator {
|
||||
private final static Logger LOGGER = LoggerFactory.getLogger(TestValidator.class);
|
||||
public final static String ENDPOINT_NAME = "TestResourceValidator";
|
||||
|
||||
static WebLauncherTest webInterface = null;
|
||||
static RESTApi api = null;
|
||||
|
||||
@BeforeAll
|
||||
public static void configureWebServer() throws Exception {
|
||||
ConfigureDb.configure();
|
||||
LOGGER.info("configure server ...");
|
||||
webInterface = new WebLauncherTest();
|
||||
LOGGER.info("Clean previous table");
|
||||
|
||||
LOGGER.info("Start REST (BEGIN)");
|
||||
webInterface.process();
|
||||
LOGGER.info("Start REST (DONE)");
|
||||
api = new RESTApi(ConfigBaseVariable.apiAdress);
|
||||
api.setToken(Common.ADMIN_TOKEN);
|
||||
}
|
||||
|
||||
@AfterAll
|
||||
public static void stopWebServer() throws Exception {
|
||||
LOGGER.info("Kill the web server");
|
||||
webInterface.stop();
|
||||
webInterface = null;
|
||||
ConfigureDb.clear();
|
||||
|
||||
}
|
||||
|
||||
@Order(2)
|
||||
@Test
|
||||
public void DetectGenericError() throws Exception {
|
||||
final ValidatorModel data = new ValidatorModel();
|
||||
data.value = "plop";
|
||||
data.data = "klsdfsdfsdfsdfj";
|
||||
data.multipleElement = new ArrayList<>();
|
||||
ValidatorSubModel tmp = new ValidatorSubModel();
|
||||
tmp.data = "lkmkmlkmlklm";
|
||||
data.multipleElement.add(tmp);
|
||||
tmp = new ValidatorSubModel();
|
||||
tmp.data = "1";
|
||||
data.multipleElement.add(tmp);
|
||||
data.subElement = new ValidatorSubModel();
|
||||
data.subElement.data = "k";
|
||||
final RESTErrorResponseException exception = Assertions.assertThrows(RESTErrorResponseException.class,
|
||||
() -> api.post(void.class, TestValidator.ENDPOINT_NAME + "?queryParametersName=2", data));
|
||||
Assertions.assertNotNull(exception);
|
||||
LOGGER.debug("error on input:{}", exception);
|
||||
Assertions.assertNull(exception.getMessage());
|
||||
Assertions.assertNotNull(exception.inputError);
|
||||
Assertions.assertEquals(5, exception.inputError.size());
|
||||
Assertions.assertEquals("arg0", exception.inputError.get(0).argument);
|
||||
Assertions.assertEquals(null, exception.inputError.get(0).path);
|
||||
Assertions.assertEquals("must be greater than or equal to 5", exception.inputError.get(0).message);
|
||||
Assertions.assertEquals("arg1", exception.inputError.get(1).argument);
|
||||
Assertions.assertEquals("data", exception.inputError.get(1).path);
|
||||
Assertions.assertEquals("size must be between 0 and 5", exception.inputError.get(1).message);
|
||||
Assertions.assertEquals("arg1", exception.inputError.get(2).argument);
|
||||
Assertions.assertEquals("multipleElement[1].data", exception.inputError.get(2).path);
|
||||
Assertions.assertEquals("size must be between 2 and 2147483647", exception.inputError.get(2).message);
|
||||
Assertions.assertEquals("arg1", exception.inputError.get(3).argument);
|
||||
Assertions.assertEquals("subElement.data", exception.inputError.get(3).path);
|
||||
Assertions.assertEquals("size must be between 2 and 2147483647", exception.inputError.get(3).message);
|
||||
Assertions.assertEquals("arg1", exception.inputError.get(4).argument);
|
||||
Assertions.assertEquals("value", exception.inputError.get(4).path);
|
||||
Assertions.assertEquals("Field can not be set, it is a read-only field.", exception.inputError.get(4).message);
|
||||
}
|
||||
}
|
163
test/src/test/kar/archidata/hybernateValidator/WebLauncher.java
Executable file
163
test/src/test/kar/archidata/hybernateValidator/WebLauncher.java
Executable file
@ -0,0 +1,163 @@
|
||||
package test.kar.archidata.hybernateValidator;
|
||||
|
||||
import java.net.URI;
|
||||
import java.util.Iterator;
|
||||
|
||||
import javax.imageio.ImageIO;
|
||||
import javax.imageio.ImageReader;
|
||||
import javax.imageio.ImageWriter;
|
||||
|
||||
import org.glassfish.grizzly.http.server.HttpServer;
|
||||
import org.glassfish.jersey.grizzly2.httpserver.GrizzlyHttpServerFactory;
|
||||
import org.glassfish.jersey.jackson.JacksonFeature;
|
||||
import org.glassfish.jersey.media.multipart.MultiPartFeature;
|
||||
import org.glassfish.jersey.server.ResourceConfig;
|
||||
import org.glassfish.jersey.server.validation.ValidationFeature;
|
||||
import org.kar.archidata.UpdateJwtPublicKey;
|
||||
import org.kar.archidata.catcher.GenericCatcher;
|
||||
import org.kar.archidata.db.DbConfig;
|
||||
import org.kar.archidata.exception.DataAccessException;
|
||||
import org.kar.archidata.filter.CORSFilter;
|
||||
import org.kar.archidata.filter.OptionFilter;
|
||||
import org.kar.archidata.migration.MigrationEngine;
|
||||
import org.kar.archidata.tools.ConfigBaseVariable;
|
||||
import org.kar.archidata.tools.ContextGenericTools;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import jakarta.ws.rs.core.UriBuilder;
|
||||
import test.kar.archidata.hybernateValidator.resource.TestResourceValidator;
|
||||
|
||||
public class WebLauncher {
|
||||
final static Logger LOGGER = LoggerFactory.getLogger(WebLauncher.class);
|
||||
protected UpdateJwtPublicKey keyUpdater = null;
|
||||
protected HttpServer server = null;
|
||||
|
||||
public WebLauncher() {}
|
||||
|
||||
private static URI getBaseURI() {
|
||||
return UriBuilder.fromUri(ConfigBaseVariable.getlocalAddress()).build();
|
||||
}
|
||||
|
||||
public void migrateDB() throws Exception {
|
||||
WebLauncher.LOGGER.info("Create migration engine");
|
||||
final MigrationEngine migrationEngine = new MigrationEngine();
|
||||
WebLauncher.LOGGER.info("Add initialization");
|
||||
//migrationEngine.setInit(new Initialization());
|
||||
WebLauncher.LOGGER.info("Add migration since last version");
|
||||
//migrationEngine.add(new Migration20231126());
|
||||
WebLauncher.LOGGER.info("Migrate the DB [START]");
|
||||
migrationEngine.migrateWaitAdmin(new DbConfig());
|
||||
WebLauncher.LOGGER.info("Migrate the DB [STOP]");
|
||||
}
|
||||
|
||||
public static void main(final String[] args) throws Exception {
|
||||
WebLauncher.LOGGER.info("[START] application wake UP");
|
||||
final WebLauncher launcher = new WebLauncher();
|
||||
launcher.migrateDB();
|
||||
|
||||
launcher.process();
|
||||
WebLauncher.LOGGER.info("end-configure the server & wait finish process:");
|
||||
Thread.currentThread().join();
|
||||
WebLauncher.LOGGER.info("STOP Key updater");
|
||||
launcher.stopOther();
|
||||
WebLauncher.LOGGER.info("STOP the REST server:");
|
||||
}
|
||||
|
||||
public void plop(final String aaa) {
|
||||
// List available Image Readers
|
||||
WebLauncher.LOGGER.trace("Available Image Readers:");
|
||||
final Iterator<ImageReader> readers = ImageIO.getImageReadersByFormatName(aaa);
|
||||
while (readers.hasNext()) {
|
||||
final ImageReader reader = readers.next();
|
||||
WebLauncher.LOGGER.trace("Reader: " + reader.getOriginatingProvider().getDescription(null));
|
||||
WebLauncher.LOGGER.trace("Reader CN: " + reader.getOriginatingProvider().getPluginClassName());
|
||||
// ImageIO.deregisterServiceProvider(reader.getOriginatingProvider());
|
||||
}
|
||||
|
||||
// List available Image Writers
|
||||
WebLauncher.LOGGER.trace("\nAvailable Image Writers:");
|
||||
final Iterator<ImageWriter> writers = ImageIO.getImageWritersByFormatName(aaa);
|
||||
while (writers.hasNext()) {
|
||||
final ImageWriter writer = writers.next();
|
||||
WebLauncher.LOGGER.trace("Writer: " + writer.getOriginatingProvider().getDescription(null));
|
||||
WebLauncher.LOGGER.trace("Writer CN: " + writer.getOriginatingProvider().getPluginClassName());
|
||||
}
|
||||
}
|
||||
|
||||
public void process() throws InterruptedException, DataAccessException {
|
||||
|
||||
ImageIO.scanForPlugins();
|
||||
plop("jpeg");
|
||||
plop("png");
|
||||
plop("webmp");
|
||||
plop("webp");
|
||||
// ===================================================================
|
||||
// Configure resources
|
||||
// ===================================================================
|
||||
final ResourceConfig rc = new ResourceConfig();
|
||||
|
||||
// add multipart models ..
|
||||
rc.register(MultiPartFeature.class);
|
||||
// global authentication system
|
||||
rc.register(OptionFilter.class);
|
||||
// remove cors ==> all time called by an other system...
|
||||
rc.register(CORSFilter.class);
|
||||
// register exception catcher
|
||||
GenericCatcher.addAll(rc);
|
||||
// add default resource:
|
||||
rc.register(TestResourceValidator.class);
|
||||
// enable jersey specific validations (@Valid
|
||||
rc.register(ValidationFeature.class);
|
||||
|
||||
ContextGenericTools.addJsr310(rc);
|
||||
|
||||
// add jackson to be discover when we are ins standalone server
|
||||
rc.register(JacksonFeature.class);
|
||||
|
||||
LOGGER.info(" ==> {}", new DbConfig());
|
||||
LOGGER.info("OAuth service {}", getBaseURI());
|
||||
this.server = GrizzlyHttpServerFactory.createHttpServer(getBaseURI(), rc);
|
||||
final HttpServer serverLink = this.server;
|
||||
Runtime.getRuntime().addShutdownHook(new Thread(new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
LOGGER.warn("Stopping server..");
|
||||
serverLink.shutdownNow();
|
||||
}
|
||||
}, "shutdownHook"));
|
||||
|
||||
// ===================================================================
|
||||
// start periodic update of the token ...
|
||||
// ===================================================================
|
||||
this.keyUpdater = new UpdateJwtPublicKey();
|
||||
this.keyUpdater.start();
|
||||
|
||||
// ===================================================================
|
||||
// run JERSEY
|
||||
// ===================================================================
|
||||
try {
|
||||
this.server.start();
|
||||
LOGGER.info("Jersey app started at {}", getBaseURI());
|
||||
} catch (final Exception e) {
|
||||
LOGGER.error("There was an error while starting Grizzly HTTP server.");
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
|
||||
public void stop() {
|
||||
if (this.server != null) {
|
||||
this.server.shutdownNow();
|
||||
this.server = null;
|
||||
}
|
||||
}
|
||||
|
||||
public void stopOther() {
|
||||
this.keyUpdater.kill();
|
||||
try {
|
||||
this.keyUpdater.join(4000, 0);
|
||||
} catch (final InterruptedException e) {
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
}
|
19
test/src/test/kar/archidata/hybernateValidator/WebLauncherTest.java
Executable file
19
test/src/test/kar/archidata/hybernateValidator/WebLauncherTest.java
Executable file
@ -0,0 +1,19 @@
|
||||
|
||||
package test.kar.archidata.hybernateValidator;
|
||||
|
||||
import org.kar.archidata.tools.ConfigBaseVariable;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
public class WebLauncherTest extends WebLauncher {
|
||||
final private static Logger LOGGER = LoggerFactory.getLogger(WebLauncherTest.class);
|
||||
|
||||
public WebLauncherTest() {
|
||||
LOGGER.debug("Configure REST system");
|
||||
// for local test:
|
||||
ConfigBaseVariable.apiAdress = "http://127.0.0.1:12345/test/api/";
|
||||
// Enable the test mode permit to access to the test token (never use it in production).
|
||||
ConfigBaseVariable.testMode = "true";
|
||||
// ConfigBaseVariable.dbPort = "3306";
|
||||
}
|
||||
}
|
@ -0,0 +1,21 @@
|
||||
package test.kar.archidata.hybernateValidator.model;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import org.kar.archidata.annotation.checker.ReadOnlyField;
|
||||
|
||||
import jakarta.validation.Valid;
|
||||
import jakarta.validation.constraints.Size;
|
||||
|
||||
public class ValidatorModel {
|
||||
@ReadOnlyField
|
||||
public String value;
|
||||
@Size(max = 5)
|
||||
public String data;
|
||||
|
||||
@Valid
|
||||
public List<ValidatorSubModel> multipleElement;
|
||||
|
||||
@Valid
|
||||
public ValidatorSubModel subElement;
|
||||
}
|
@ -0,0 +1,8 @@
|
||||
package test.kar.archidata.hybernateValidator.model;
|
||||
|
||||
import jakarta.validation.constraints.Size;
|
||||
|
||||
public class ValidatorSubModel {
|
||||
@Size(min = 2)
|
||||
public String data;
|
||||
}
|
@ -0,0 +1,32 @@
|
||||
package test.kar.archidata.hybernateValidator.resource;
|
||||
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import jakarta.annotation.security.PermitAll;
|
||||
import jakarta.validation.Valid;
|
||||
import jakarta.validation.constraints.Min;
|
||||
import jakarta.ws.rs.Consumes;
|
||||
import jakarta.ws.rs.POST;
|
||||
import jakarta.ws.rs.Path;
|
||||
import jakarta.ws.rs.Produces;
|
||||
import jakarta.ws.rs.QueryParam;
|
||||
import jakarta.ws.rs.core.MediaType;
|
||||
import test.kar.archidata.apiExtern.resource.TestResource;
|
||||
import test.kar.archidata.hybernateValidator.model.ValidatorModel;
|
||||
|
||||
@Path("/TestResourceValidator")
|
||||
@Produces({ MediaType.APPLICATION_JSON })
|
||||
public class TestResourceValidator {
|
||||
|
||||
private static final Logger LOGGER = LoggerFactory.getLogger(TestResource.class);
|
||||
|
||||
@POST
|
||||
@PermitAll
|
||||
@Consumes(MediaType.APPLICATION_JSON)
|
||||
public void post(final @QueryParam("queryParametersName") @Min(5) Long value, final @Valid ValidatorModel data)
|
||||
throws Exception {
|
||||
return;
|
||||
}
|
||||
|
||||
}
|
@ -1 +1 @@
|
||||
0.24.0
|
||||
0.25.0
|
||||
|
Loading…
x
Reference in New Issue
Block a user