Implement "all" endpoints supporting to configure whole instances

commons/src/main/java/com/deftdevs/bootstrapi/commons/constants/BootstrAPI.java

@@ -2,7 +2,9 @@
 
 public class BootstrAPI {
 
-    public static final String ALL                          = "all";
+    public static final String _ALL                         = "_all";
+    public static final String _ROOT                        = "/";
+
     public static final String APPLICATION                  = "application";
     public static final String APPLICATIONS                 = "applications";
     public static final String APPLICATION_LINK             = "application-link";
@@ -49,6 +51,7 @@
     public static final String SETTINGS_BRANDING_LOGIN_PAGE = "login-page";
     public static final String SETTINGS_BRANDING_LOGO       = "logo";
     public static final String SETTINGS_CUSTOM_HTML         = "custom-html";
+    public static final String SETTINGS_GENERAL             = "general";
     public static final String SETTINGS_SECURITY            = "security";
     public static final String USER                         = "user";
     public static final String USERS                        = "users";
@@ -57,10 +60,20 @@
     public static final String MEDIA_TYPE_IMAGE             = "image/*";
 
     public static final String ERROR_COLLECTION_RESPONSE_DESCRIPTION      = "Returns a list of error messages.";
+    public static final String _ALL_PUT_SUMMARY                           = "Apply a complete configuration";
+    public static final String _ALL_PUT_RESPONSE_DESCRIPTION              = "Returns the updated configuration. The per-sub-field outcome is reported in the"
+            + " 'status' map, keyed by the request's field paths (e.g. 'settings/general', 'mailServer/smtp';"
+            + " 2xx for success, 4xx/5xx for failure with a human-readable 'message' and optional 'details')."
+            + " License keys in the response are redacted (e.g. 'AAAB...wxyz#a1b2')."
+            + " If any sub-field fails, the highest sub-field status code is returned with the same response body.";
+    public static final String _ALL_PUT_FAILURE_RESPONSE_DESCRIPTION      = "One or more sub-fields failed to apply. The response code is the highest"
+            + " sub-field status code; inspect the per-sub-field 'status' map in the response body to see which"
+            + " fields succeeded and which failed. Request-level errors (e.g. a missing request body) return an"
+            + " error message list instead.";
     public static final String SETTINGS_GENERAL_GET_SUMMARY               = "Get the general settings";
     public static final String SETTINGS_GENERAL_GET_RESPONSE_DESCRIPTION  = "Returns the general settings";
     public static final String SETTINGS_GENERAL_PUT_SUMMARY               = "Set the general settings";
-    public static final String SETTINGS_GENERAL_PUT_RESPONSE_DESCRIPTION  = "Returns the general security settings";
+    public static final String SETTINGS_GENERAL_PUT_RESPONSE_DESCRIPTION  = "Returns the updated general settings";
     public static final String SETTINGS_SECURITY_GET_SUMMARY              = "Get the security settings";
     public static final String SETTINGS_SECURITY_GET_RESPONSE_DESCRIPTION = "Returns the security settings";
     public static final String SETTINGS_SECURITY_PUT_SUMMARY              = "Set the security settings";

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/AbstractAuthenticationIdpModel.java

@@ -10,13 +10,15 @@
 import lombok.experimental.SuperBuilder;
 
 import javax.xml.bind.annotation.XmlElement;
+import com.deftdevs.bootstrapi.commons.model.type.SubEntityOf;
 import javax.xml.bind.annotation.XmlRootElement;
 
 
 @Data
 @SuperBuilder
 @NoArgsConstructor
 @AllArgsConstructor
+@SubEntityOf(AuthenticationModel.class)
 @XmlRootElement
 @JsonTypeInfo(
         use = JsonTypeInfo.Id.NAME,

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/AbstractSettingsBrandingModel.java

@@ -0,0 +1,24 @@
+package com.deftdevs.bootstrapi.commons.model;
+
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import lombok.experimental.SuperBuilder;
+
+import javax.xml.bind.annotation.XmlElement;
+
+/**
+ * Settings group schema for products that support color-scheme branding
+ * (only Confluence; Crowd brands its login page with a product-specific
+ * model instead).
+ */
+@Data
+@SuperBuilder
+@NoArgsConstructor
+@EqualsAndHashCode(callSuper = true)
+public abstract class AbstractSettingsBrandingModel extends AbstractSettingsSecurityModel {
+
+    @XmlElement
+    private SettingsBrandingColorSchemeModel branding;
+
+}

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/AbstractSettingsModel.java

@@ -0,0 +1,24 @@
+package com.deftdevs.bootstrapi.commons.model;
+
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.experimental.SuperBuilder;
+
+import javax.xml.bind.annotation.XmlElement;
+
+/**
+ * Canonical settings group schema shared by all products. Extended by
+ * {@link AbstractSettingsSecurityModel} and {@link AbstractSettingsBrandingModel}
+ * for the sub-fields only some products support, so that every product's
+ * concrete settings model inherits its fields from the class its sub-models
+ * name via {@code @SubEntityOf} — field names then match by construction.
+ */
+@Data
+@SuperBuilder
+@NoArgsConstructor
+public abstract class AbstractSettingsModel {
+
+    @XmlElement
+    private SettingsGeneralModel general;
+
+}

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/AbstractSettingsSecurityModel.java

@@ -0,0 +1,23 @@
+package com.deftdevs.bootstrapi.commons.model;
+
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import lombok.experimental.SuperBuilder;
+
+import javax.xml.bind.annotation.XmlElement;
+
+/**
+ * Settings group schema for products that support security settings
+ * (Confluence and Jira; Crowd does not).
+ */
+@Data
+@SuperBuilder
+@NoArgsConstructor
+@EqualsAndHashCode(callSuper = true)
+public abstract class AbstractSettingsSecurityModel extends AbstractSettingsModel {
+
+    @XmlElement
+    private SettingsSecurityModel security;
+
+}

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/AuthenticationModel.java

@@ -0,0 +1,25 @@
+package com.deftdevs.bootstrapi.commons.model;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+import java.util.Map;
+
+import static com.deftdevs.bootstrapi.commons.constants.BootstrAPI.AUTHENTICATION;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+@XmlRootElement(name = AUTHENTICATION)
+public class AuthenticationModel {
+
+    @XmlElement
+    private Map<String, AbstractAuthenticationIdpModel> idps;
+
+    @XmlElement
+    private AuthenticationSsoModel sso;
+
+}

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/AuthenticationSsoModel.java

@@ -7,12 +7,14 @@
 import lombok.NoArgsConstructor;
 
 import javax.xml.bind.annotation.XmlElement;
+import com.deftdevs.bootstrapi.commons.model.type.SubEntityOf;
 import javax.xml.bind.annotation.XmlRootElement;
 
 @Data
 @Builder
 @NoArgsConstructor
 @AllArgsConstructor
+@SubEntityOf(AuthenticationModel.class)
 @XmlRootElement(name = BootstrAPI.AUTHENTICATION + "-" + BootstrAPI.AUTHENTICATION_SSO)
 public class AuthenticationSsoModel {
 

crowd/src/main/java/com/deftdevs/bootstrapi/crowd/model/AllModel.java → commons/src/main/java/com/deftdevs/bootstrapi/commons/model/MailServerModel.java

@@ -1,26 +1,26 @@
-package com.deftdevs.bootstrapi.crowd.model;
+package com.deftdevs.bootstrapi.commons.model;
 
-import com.deftdevs.bootstrapi.commons.model.SettingsModel;
 import lombok.AllArgsConstructor;
-import lombok.Data;
 import lombok.Builder;
+import lombok.Data;
 import lombok.NoArgsConstructor;
 
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
-import java.util.List;
+
+import static com.deftdevs.bootstrapi.commons.constants.BootstrAPI.MAIL_SERVER;
 
 @Data
 @Builder
 @NoArgsConstructor
 @AllArgsConstructor
-@XmlRootElement(name = "all")
-public class AllModel {
+@XmlRootElement(name = MAIL_SERVER)
+public class MailServerModel {
 
     @XmlElement
-    private SettingsModel settings;
+    private MailServerSmtpModel smtp;
 
     @XmlElement
-    private List<ApplicationModel> applications;
+    private MailServerPopModel pop;
 
 }

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/MailServerPopModel.java

@@ -6,12 +6,14 @@
 import lombok.NoArgsConstructor;
 import lombok.experimental.SuperBuilder;
 
+import com.deftdevs.bootstrapi.commons.model.type.SubEntityOf;
 import javax.xml.bind.annotation.XmlRootElement;
 
 @Data
 @SuperBuilder
 @NoArgsConstructor
 @EqualsAndHashCode(callSuper = true)
+@SubEntityOf(MailServerModel.class)
 @XmlRootElement(name = BootstrAPI.MAIL_SERVER + "-" + BootstrAPI.MAIL_SERVER_POP)
 public class MailServerPopModel extends AbstractMailServerProtocolModel {
 

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/MailServerSmtpModel.java

@@ -8,13 +8,15 @@
 import lombok.experimental.SuperBuilder;
 
 import javax.xml.bind.annotation.XmlElement;
+import com.deftdevs.bootstrapi.commons.model.type.SubEntityOf;
 import javax.xml.bind.annotation.XmlRootElement;
 
 @Data
 @SuperBuilder
 @NoArgsConstructor
 @AllArgsConstructor
 @EqualsAndHashCode(callSuper = true)
+@SubEntityOf(MailServerModel.class)
 @XmlRootElement(name = BootstrAPI.MAIL_SERVER + "-" + BootstrAPI.MAIL_SERVER_SMTP)
 public class MailServerSmtpModel extends AbstractMailServerProtocolModel {
 
@@ -57,4 +59,14 @@ public boolean getUseTls() {
         .timeout(5000L)
         .build();
 
+    // restricted to the fields supported by all products (e.g. Crowd does not echo name and protocol)
+    public static final MailServerSmtpModel EXAMPLE_2_MINIMAL = MailServerSmtpModel.builder()
+        .from(EXAMPLE_2.getFrom())
+        .prefix(EXAMPLE_2.getPrefix())
+        .host(EXAMPLE_2.getHost())
+        .port(EXAMPLE_2.getPort())
+        .useTls(EXAMPLE_2.getUseTls())
+        .timeout(EXAMPLE_2.getTimeout())
+        .build();
+
 }

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/SettingsBrandingColorSchemeModel.java

@@ -8,6 +8,7 @@
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlElement;
+import com.deftdevs.bootstrapi.commons.model.type.SubEntityOf;
 import javax.xml.bind.annotation.XmlRootElement;
 
 import static com.deftdevs.bootstrapi.commons.constants.BootstrAPI.*;
@@ -16,6 +17,7 @@
 @Builder
 @NoArgsConstructor
 @AllArgsConstructor
+@SubEntityOf(AbstractSettingsBrandingModel.class)
 @XmlRootElement(name = SETTINGS + "-" + SETTINGS_BRANDING + "-" + COLOR_SCHEME)
 @XmlAccessorType(XmlAccessType.FIELD)
 public class SettingsBrandingColorSchemeModel {

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/SettingsModel.java → commons/src/main/java/com/deftdevs/bootstrapi/commons/model/SettingsGeneralModel.java

@@ -1,6 +1,5 @@
 package com.deftdevs.bootstrapi.commons.model;
 
-import com.deftdevs.bootstrapi.commons.constants.BootstrAPI;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.Builder;
@@ -10,16 +9,21 @@
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlElement;
+import com.deftdevs.bootstrapi.commons.model.type.SubEntityOf;
 import javax.xml.bind.annotation.XmlRootElement;
 import java.net.URI;
 
+import static com.deftdevs.bootstrapi.commons.constants.BootstrAPI.SETTINGS;
+import static com.deftdevs.bootstrapi.commons.constants.BootstrAPI.SETTINGS_GENERAL;
+
 @Data
 @Builder
 @NoArgsConstructor
 @AllArgsConstructor
-@XmlRootElement(name = BootstrAPI.SETTINGS)
+@SubEntityOf(AbstractSettingsModel.class)
+@XmlRootElement(name = SETTINGS + "-" + SETTINGS_GENERAL)
 @XmlAccessorType(XmlAccessType.FIELD)
-public class SettingsModel {
+public class SettingsGeneralModel {
 
     @XmlElement
     private URI baseUrl;
@@ -46,20 +50,26 @@ public String getMode() {
 
     // Example instances for documentation and tests
 
-    public static final SettingsModel EXAMPLE_1 = SettingsModel.builder()
+    public static final SettingsGeneralModel EXAMPLE_1 = SettingsGeneralModel.builder()
         .title("Example")
         .baseUrl(URI.create("https://example.com"))
         .mode("private")
         .contactMessage("Test Message")
         .externalUserManagement(true)
         .build();
 
-    public static final SettingsModel EXAMPLE_1_NO_MODE = SettingsModel.builder()
+    public static final SettingsGeneralModel EXAMPLE_1_NO_MODE = SettingsGeneralModel.builder()
         .title("Example")
         .baseUrl(URI.create("https://example.com"))
         .mode(null)
         .contactMessage("Test Message")
         .externalUserManagement(true)
         .build();
 
+    // restricted to the fields supported by all products (e.g. Crowd)
+    public static final SettingsGeneralModel EXAMPLE_1_MINIMAL = SettingsGeneralModel.builder()
+        .title(EXAMPLE_1.getTitle())
+        .baseUrl(EXAMPLE_1.getBaseUrl())
+        .build();
+
 }

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/SettingsSecurityModel.java

@@ -8,6 +8,7 @@
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlElement;
+import com.deftdevs.bootstrapi.commons.model.type.SubEntityOf;
 import javax.xml.bind.annotation.XmlRootElement;
 
 import static com.deftdevs.bootstrapi.commons.constants.BootstrAPI.SETTINGS;
@@ -17,6 +18,7 @@
 @SuperBuilder
 @NoArgsConstructor
 @AllArgsConstructor
+@SubEntityOf(AbstractSettingsSecurityModel.class)
 @XmlRootElement(name = SETTINGS + "-" + SETTINGS_SECURITY)
 @XmlAccessorType(XmlAccessType.FIELD)
 public class SettingsSecurityModel {

commons/src/main/java/com/deftdevs/bootstrapi/commons/model/_AbstractAllModel.java

@@ -0,0 +1,42 @@
+package com.deftdevs.bootstrapi.commons.model;
+
+import com.deftdevs.bootstrapi.commons.model.type._AllModelAccessor;
+import com.deftdevs.bootstrapi.commons.model.type._AllModelStatus;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.experimental.SuperBuilder;
+
+import javax.xml.bind.annotation.XmlElement;
+import java.util.Map;
+
+/**
+ * Shared shape of the product _all models: the configuration fields every
+ * product supports plus the per-sub-field status map of the response.
+ * Products extend it with their product-specific fields.
+ *
+ * @param <S> the product's settings model type
+ */
+@Data
+@SuperBuilder
+@NoArgsConstructor
+public abstract class _AbstractAllModel<S> implements _AllModelAccessor {
+
+    @XmlElement
+    private S settings;
+
+    @XmlElement
+    private Map<String, AbstractDirectoryModel> directories;
+
+    @XmlElement
+    private Map<String, ApplicationLinkModel> applicationLinks;
+
+    @XmlElement
+    private Map<String, LicenseModel> licenses;
+
+    @XmlElement
+    private MailServerModel mailServer;
+
+    @XmlElement
+    private Map<String, _AllModelStatus> status;
+
+}