Merge pull request #231 from deftdevs/model-classes

Rename model classes from *Bean to *Model

Author: pathob

.doc/CODE_CONVENTIONS.adoc

@@ -8,7 +8,7 @@ The code conventions are valid for all BootstrAPI modules.
 
 === Quick Reference
 
-* Model Class: `EntityBean`
+* Model Class: `EntityModel`
 * Model JSON Name: `entity` (`@XmlRootElement(name = BootstrAPI.ENTITY)`)
 * REST Endpoint Class: `EntitiesResource`
 * REST Endpoint Name: `entities` (`@Path(BootstrAPI.ENTITIES)`)
@@ -33,7 +33,7 @@ Example:
 @Data
 @NoArgsConstructor
 @XmlRootElement(name = BootstrAPI.ENTITY)
-public class EntityBean {
+public class EntityModel {
 
     @XmlElement
     @NotNull
@@ -117,7 +117,7 @@ public interface EntitiesResource {
             summary = "Get the list of entities",
             responses = {
                     @ApiResponse(
-                            responseCode = "200", content = @Content(array = @ArraySchema(schema = @Schema(implementation = EntitiyBean.class))),
+                            responseCode = "200", content = @Content(array = @ArraySchema(schema = @Schema(implementation = EntitiyModel.class))),
                             description = ""
                     ),
                     @ApiResponse(responseCode = "400", content = @Content(schema = @Schema(implementation = ErrorCollection.class)))
@@ -134,15 +134,15 @@ public interface EntitiesResource {
             description = "A new entity can be added here if no other entity with the same name already exists",
             responses = {
                     @ApiResponse(
-                            responseCode = "200", content = @Content(schema = @Schema(implementation = EntityBean.class)),
+                            responseCode = "200", content = @Content(schema = @Schema(implementation = EntityModel.class)),
                             description = ""
                     ),
                     @ApiResponse(responseCode = "400", content = @Content(schema = @Schema(implementation = ErrorCollection.class)))
             }
     )
     Response addEntity(
             @QueryParam("doSomethingAfterAdding") @DefaultValue("false") final boolean doSomethingAfterAdding,
-            @NotNull final EntityBean entity);
+            @NotNull final EntityModel entity);
 
 }
 ----
@@ -173,8 +173,8 @@ public class EntitiesResourceImpl implements EntitiesResource {
     public Response getEntities() {
         final ErrorCollection errorCollection = new ErrorCollection();
         try {
-            final List<EntitiesBean> entitieBeans = entitiesService.getEntities();
-            return Response.ok(entitiesBeanBeans).build();
+            final List<EntitiesModel> entitieModels = entitiesService.getEntities();
+            return Response.ok(entitiesModelModels).build();
         } catch (Exception e) {
             log.error(e.getMessage(), e);
             errorCollection.addErrorMessage(e.getMessage());
@@ -185,11 +185,11 @@ public class EntitiesResourceImpl implements EntitiesResource {
     @Override
     public Response addEntity(
             final boolean doSomethingAfterAdding,
-            @NotNull final EntityBean entity) {
+            @NotNull final EntityModel entity) {
 
         final ErrorCollection errorCollection = new ErrorCollection();
         try {
-            EntityBean addedEntity = entitiesService.addEntity(entity, doSomethingAfterAdding);
+            EntityModel addedEntity = entitiesService.addEntity(entity, doSomethingAfterAdding);
             return Response.ok(addedEntity).build();
         } catch (Exception e) {
             log.error(e.getMessage(), e);

commons/src/main/java/com/deftdevs/bootstrapi/commons/exception/DirectoryNotFoundException.java

@@ -1,7 +1,7 @@
 package com.deftdevs.bootstrapi.commons.exception;
 
 import com.deftdevs.bootstrapi.commons.exception.web.NotFoundException;
-import com.deftdevs.bootstrapi.commons.model.AbstractDirectoryBean;
+import com.deftdevs.bootstrapi.commons.model.AbstractDirectoryModel;
 
 @SuppressWarnings("java:S110")
 public class DirectoryNotFoundException extends NotFoundException {
@@ -21,9 +21,9 @@ public DirectoryNotFoundException(
     }
 
     public DirectoryNotFoundException(
-            final AbstractDirectoryBean directoryBean) {
+            final AbstractDirectoryModel directoryModel) {
 
-        this(directoryBean.getName());
+        this(directoryModel.getName());
     }
 
 }

commons/src/main/java/com/deftdevs/bootstrapi/commons/exception/GroupNotFoundException.java

@@ -1,7 +1,7 @@
 package com.deftdevs.bootstrapi.commons.exception;
 
 import com.deftdevs.bootstrapi.commons.exception.web.NotFoundException;
-import com.deftdevs.bootstrapi.commons.model.GroupBean;
+import com.deftdevs.bootstrapi.commons.model.GroupModel;
 
 @SuppressWarnings("java:S110")
 public class GroupNotFoundException extends NotFoundException {
@@ -21,9 +21,9 @@ public GroupNotFoundException(
     }
 
     public GroupNotFoundException(
-            final GroupBean groupBean) {
+            final GroupModel groupModel) {
 
-        this(groupBean.getName());
+        this(groupModel.getName());
     }
 
 }

commons/src/main/java/com/deftdevs/bootstrapi/commons/exception/UserNotFoundException.java

@@ -1,7 +1,7 @@
 package com.deftdevs.bootstrapi.commons.exception;
 
 import com.deftdevs.bootstrapi.commons.exception.web.NotFoundException;
-import com.deftdevs.bootstrapi.commons.model.UserBean;
+import com.deftdevs.bootstrapi.commons.model.UserModel;
 
 @SuppressWarnings("java:S110")
 public class UserNotFoundException extends NotFoundException {
@@ -21,9 +21,9 @@ public UserNotFoundException(
     }
 
     public UserNotFoundException(
-            final UserBean userBean) {
+            final UserModel userModel) {
 
-        this(userBean.getUsername());
+        this(userModel.getUsername());
     }
 
 }

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/AbstractAuthenticationIdpBean.java renamed to commons/src/main/java/com/deftdevs/bootstrapi/commons/model/AbstractAuthenticationIdpModel.java

@@ -22,15 +22,15 @@
         property = "type"
 )
 @JsonSubTypes({
-        @JsonSubTypes.Type(value = AuthenticationIdpOidcBean.class, name = BootstrAPI.AUTHENTICATION_IDP_OIDC),
-        @JsonSubTypes.Type(value = AuthenticationIdpSamlBean.class, name = BootstrAPI.AUTHENTICATION_IDP_SAML),
+        @JsonSubTypes.Type(value = AuthenticationIdpOidcModel.class, name = BootstrAPI.AUTHENTICATION_IDP_OIDC),
+        @JsonSubTypes.Type(value = AuthenticationIdpSamlModel.class, name = BootstrAPI.AUTHENTICATION_IDP_SAML),
 })
 // Note: The subtypes must also be registered for swagger to be considered in the REST API documentation
 @Schema(anyOf = {
-        AuthenticationIdpOidcBean.class,
-        AuthenticationIdpSamlBean.class,
+        AuthenticationIdpOidcModel.class,
+        AuthenticationIdpSamlModel.class,
 })
-public abstract class AbstractAuthenticationIdpBean {
+public abstract class AbstractAuthenticationIdpModel {
 
     @XmlElement
     private Long id;

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/AbstractDirectoryBean.java renamed to commons/src/main/java/com/deftdevs/bootstrapi/commons/model/AbstractDirectoryModel.java

@@ -13,7 +13,7 @@
 import java.util.Date;
 
 /**
- * Bean for user directory settings in REST requests.
+ * Model for user directory settings in REST requests.
  */
 @Data
 @NoArgsConstructor
@@ -24,21 +24,21 @@
         property = "type"
 )
 @JsonSubTypes({
-        @JsonSubTypes.Type(value = DirectoryCrowdBean.class, name = BootstrAPI.DIRECTORY_CROWD),
-        @JsonSubTypes.Type(value = DirectoryDelegatingBean.class, name = BootstrAPI.DIRECTORY_DELEGATING),
-        @JsonSubTypes.Type(value = DirectoryGenericBean.class, name = BootstrAPI.DIRECTORY_GENERIC),
-        @JsonSubTypes.Type(value = DirectoryInternalBean.class, name = BootstrAPI.DIRECTORY_INTERNAL),
-        @JsonSubTypes.Type(value = DirectoryLdapBean.class, name = BootstrAPI.DIRECTORY_LDAP),
+        @JsonSubTypes.Type(value = DirectoryCrowdModel.class, name = BootstrAPI.DIRECTORY_CROWD),
+        @JsonSubTypes.Type(value = DirectoryDelegatingModel.class, name = BootstrAPI.DIRECTORY_DELEGATING),
+        @JsonSubTypes.Type(value = DirectoryGenericModel.class, name = BootstrAPI.DIRECTORY_GENERIC),
+        @JsonSubTypes.Type(value = DirectoryInternalModel.class, name = BootstrAPI.DIRECTORY_INTERNAL),
+        @JsonSubTypes.Type(value = DirectoryLdapModel.class, name = BootstrAPI.DIRECTORY_LDAP),
 })
 // Note: The subtypes must also be registered for swagger to be considered in the REST API documentation
 @Schema(anyOf = {
-        DirectoryCrowdBean.class,
-        DirectoryDelegatingBean.class,
-        DirectoryGenericBean.class,
-        DirectoryInternalBean.class,
-        DirectoryLdapBean.class,
+        DirectoryCrowdModel.class,
+        DirectoryDelegatingModel.class,
+        DirectoryGenericModel.class,
+        DirectoryInternalModel.class,
+        DirectoryLdapModel.class,
 })
-public abstract class AbstractDirectoryBean {
+public abstract class AbstractDirectoryModel {
 
     @XmlElement
     private Long id;

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/AbstractMailServerProtocolBean.java renamed to commons/src/main/java/com/deftdevs/bootstrapi/commons/model/AbstractMailServerProtocolModel.java

@@ -11,7 +11,7 @@
 
 @Data
 @NoArgsConstructor
-public abstract class AbstractMailServerProtocolBean {
+public abstract class AbstractMailServerProtocolModel {
 
     public static final Long DEFAULT_TIMEOUT = 10000L;
 

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/ApplicationLinkBean.java renamed to commons/src/main/java/com/deftdevs/bootstrapi/commons/model/ApplicationLinkModel.java

@@ -11,12 +11,12 @@
 import java.util.UUID;
 
 /**
- * Bean for an application link in REST requests.
+ * Model for an application link in REST requests.
  */
 @Data
 @NoArgsConstructor
 @XmlRootElement(name = BootstrAPI.APPLICATION_LINK)
-public class ApplicationLinkBean {
+public class ApplicationLinkModel {
 
     public enum ApplicationLinkType {
         BAMBOO,
@@ -72,10 +72,10 @@ public enum ApplicationLinkStatus {
 
     // Example instances for documentation and tests
 
-    public static final ApplicationLinkBean EXAMPLE_1;
+    public static final ApplicationLinkModel EXAMPLE_1;
 
     static {
-        EXAMPLE_1 = new ApplicationLinkBean();
+        EXAMPLE_1 = new ApplicationLinkModel();
         EXAMPLE_1.setUuid(UUID.randomUUID());
         EXAMPLE_1.setName("Example");
         EXAMPLE_1.setDisplayUrl(URI.create("http://example.com"));

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/AuthenticationIdpOidcBean.java renamed to commons/src/main/java/com/deftdevs/bootstrapi/commons/model/AuthenticationIdpOidcModel.java

@@ -14,7 +14,7 @@
 @NoArgsConstructor
 @EqualsAndHashCode(callSuper = true)
 @XmlRootElement(name = BootstrAPI.AUTHENTICATION + "-" + BootstrAPI.AUTHENTICATION_IDP + "-" + BootstrAPI.AUTHENTICATION_IDP_OIDC)
-public class AuthenticationIdpOidcBean extends AbstractAuthenticationIdpBean {
+public class AuthenticationIdpOidcModel extends AbstractAuthenticationIdpModel {
 
     @XmlElement
     private String clientId;
@@ -44,10 +44,10 @@ public class AuthenticationIdpOidcBean extends AbstractAuthenticationIdpBean {
 
     // Example instances for documentation and tests
 
-    public static final AuthenticationIdpOidcBean EXAMPLE_1;
+    public static final AuthenticationIdpOidcModel EXAMPLE_1;
 
     static {
-        EXAMPLE_1 = new AuthenticationIdpOidcBean();
+        EXAMPLE_1 = new AuthenticationIdpOidcModel();
         EXAMPLE_1.setId(1L);
         EXAMPLE_1.setName("OIDC");
         EXAMPLE_1.setEnabled(true);

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/AuthenticationIdpSamlBean.java renamed to commons/src/main/java/com/deftdevs/bootstrapi/commons/model/AuthenticationIdpSamlModel.java

@@ -12,7 +12,7 @@
 @NoArgsConstructor
 @EqualsAndHashCode(callSuper = true)
 @XmlRootElement(name = BootstrAPI.AUTHENTICATION + "-" + BootstrAPI.AUTHENTICATION_IDP + "-" + BootstrAPI.AUTHENTICATION_IDP_SAML)
-public class AuthenticationIdpSamlBean extends AbstractAuthenticationIdpBean {
+public class AuthenticationIdpSamlModel extends AbstractAuthenticationIdpModel {
 
     @XmlElement
     private String certificate;
@@ -24,10 +24,10 @@ public class AuthenticationIdpSamlBean extends AbstractAuthenticationIdpBean {
 
     // Example instances for documentation and tests
 
-    public static final AuthenticationIdpSamlBean EXAMPLE_1;
+    public static final AuthenticationIdpSamlModel EXAMPLE_1;
 
     static {
-        EXAMPLE_1 = new AuthenticationIdpSamlBean();
+        EXAMPLE_1 = new AuthenticationIdpSamlModel();
         EXAMPLE_1.setId(1L);
         EXAMPLE_1.setName("SAML");
         EXAMPLE_1.setEnabled(true);