[artifact-manager,plugins,installer] (#305) Restructure Aria Automation components

.github/linters/sun_checks.xml

@@ -188,13 +188,11 @@ https://www.oracle.com/java/technologies/javase/codeconventions-contents.html
 
 		<!-- Checks for class design                         -->
 		<!-- See https://checkstyle.org/config_design.html -->
-		<module name="DesignForExtension" />
+		<!-- Uncomment later -->
+		<!-- <module name="DesignForExtension" /> -->
 		<module name="FinalClass" />
 		<module name="HideUtilityClassConstructor" />
 		<module name="InterfaceIsType" />
-		<module name="VisibilityModifier">
-			<property name="protectedAllowed" value="true" />
-		</module>
 
 		<!-- Miscellaneous other checks.                   -->
 		<!-- See https://checkstyle.org/config_misc.html -->

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/AbxPackageStore.java

@@ -21,8 +21,8 @@
 import com.vmware.pscoe.iac.artifact.model.abx.AbxConstant;
 import com.vmware.pscoe.iac.artifact.model.abx.AbxPackageContent;
 import com.vmware.pscoe.iac.artifact.model.abx.AbxPackageDescriptor;
-import com.vmware.pscoe.iac.artifact.model.vrang.VraNgSecret;
-import com.vmware.pscoe.iac.artifact.rest.RestClientVraNg;
+import com.vmware.pscoe.iac.artifact.aria.models.VraNgSecret;
+import com.vmware.pscoe.iac.artifact.aria.rest.RestClientVraNg;
 import org.apache.commons.lang3.NotImplementedException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/AbxReleaseManager.java

@@ -31,7 +31,7 @@
 import com.vmware.pscoe.iac.artifact.model.abx.AbxAction;
 import com.vmware.pscoe.iac.artifact.model.abx.AbxActionVersion;
 import com.vmware.pscoe.iac.artifact.model.abx.AbxPackageDescriptor;
-import com.vmware.pscoe.iac.artifact.rest.RestClientVraNg;
+import com.vmware.pscoe.iac.artifact.aria.rest.RestClientVraNg;
 
 public class AbxReleaseManager {
 	private final Logger logger = LoggerFactory.getLogger(AbxReleaseManager.class);

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/IMPORTANT.md

@@ -0,0 +1,14 @@
+# What?
+
+The structure of this folder is being reworked. Classes are being moved based on solution.
+
+## Progres
+
+- [x] Aria Automation
+- [ ] Aria Orchestrator
+- [ ] Aria Logs
+- [ ] Aria Operations
+- [ ] SSH
+- [ ] vCD
+- [ ] CS
+- [ ] ABX

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/PackageStoreFactory.java

@@ -25,6 +25,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.vmware.pscoe.iac.artifact.aria.rest.RestClientVraNg;
+import com.vmware.pscoe.iac.artifact.aria.configuration.ConfigurationVraNg;
 import com.vmware.pscoe.iac.artifact.cli.CliManagerFactory;
 import com.vmware.pscoe.iac.artifact.cli.CliManagerVrops;
 import com.vmware.pscoe.iac.artifact.model.Version;

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/configuration/ConfigurationVraNg.java → common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/aria/configuration/ConfigurationVraNg.java

@@ -12,7 +12,7 @@
  * This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
  * #L%
  */
-package com.vmware.pscoe.iac.artifact.configuration;
+package com.vmware.pscoe.iac.artifact.aria.configuration;
 
 import java.net.URISyntaxException;
 import java.util.Properties;
@@ -22,6 +22,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.vmware.pscoe.iac.artifact.configuration.Configuration;
+import com.vmware.pscoe.iac.artifact.configuration.ConfigurationException;
 import com.vmware.pscoe.iac.artifact.model.PackageType;
 
 /**

common/artifact-manager/src/test/java/com/vmware/pscoe/iac/artifact/rest/vrang/package-info.java → common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/aria/configuration/package-info.java

@@ -1,8 +1,13 @@
+/**
+ * Configuration classes for ARIA.
+ */
+package com.vmware.pscoe.iac.artifact.aria.configuration;
+
 /*-
  * #%L
  * artifact-manager
  * %%
- * Copyright (C) 2023 VMware
+ * Copyright (C) 2023 - 2024 VMware
  * %%
  * Build Tools for VMware Aria
  * Copyright 2023 VMware, Inc.
@@ -12,9 +17,3 @@
  * This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
  * #L%
  */
-
-/**
- * Package that represents IAC Artifact.
- *
- */
-package com.vmware.pscoe.iac.artifact.rest.vrang;

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/model/vrang/Identifiable.java → common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/aria/models/Identifiable.java

@@ -12,7 +12,7 @@
  * This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
  * #L%
  */
-package com.vmware.pscoe.iac.artifact.model.vrang;
+package com.vmware.pscoe.iac.artifact.aria.models;
 
 /**
  * Interface that makes a Aria automation resource identifiable.

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/model/vrang/VraNgApprovalPolicy.java → common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/aria/models/VraNgApprovalPolicy.java

@@ -12,7 +12,7 @@
  * This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
  * #L%
  */
-package com.vmware.pscoe.iac.artifact.model.vrang;
+package com.vmware.pscoe.iac.artifact.aria.models;
 
 import com.google.gson.JsonObject;
 

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/model/vrang/VraNgBlueprint.java → common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/aria/models/VraNgBlueprint.java

@@ -12,7 +12,7 @@
  * This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
  * #L%
  */
-package com.vmware.pscoe.iac.artifact.model.vrang;
+package com.vmware.pscoe.iac.artifact.aria.models;
 
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/model/vrang/VraNgCatalogEntitlement.java → common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/aria/models/VraNgCatalogEntitlement.java

@@ -12,7 +12,7 @@
  * This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
  * #L%
  */
-package com.vmware.pscoe.iac.artifact.model.vrang;
+package com.vmware.pscoe.iac.artifact.aria.models;
 
 import java.util.ArrayList;
 import java.util.List;

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/model/vrang/VraNgCatalogEntitlementDto.java → common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/aria/models/VraNgCatalogEntitlementDto.java

@@ -12,39 +12,59 @@
  * This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
  * #L%
  */
-package com.vmware.pscoe.iac.artifact.model.vrang;
+package com.vmware.pscoe.iac.artifact.aria.models;
 
 import java.util.LinkedHashMap;
 import java.util.Map;
 
+/**
+ * VraNgCatalogEntitlementDto is used to store the entitlement details of the
+ * VraNgCatalog.
+ */
 public class VraNgCatalogEntitlementDto {
-
 	private String id;
 	private String projectId;
 	private Map<String, String> definition = new LinkedHashMap<String, String>();
 
+	/**
+	 * @return the id
+	 */
 	public String getId() {
 		return id;
 	}
 
+	/**
+	 * @param id the id to set
+	 */
 	public void setId(String id) {
 		this.id = id;
 	}
 
+	/**
+	 * @return the project id
+	 */
 	public String getProjectId() {
 		return projectId;
 	}
 
+	/**
+	 * @param projectId to set
+	 */
 	public void setProjectId(String projectId) {
 		this.projectId = projectId;
 	}
 
+	/**
+	 * @return the definition
+	 */
 	public Map<String, String> getDefinition() {
 		return definition;
 	}
 
+	/**
+	 * @param definition to set
+	 */
 	public void setDefinition(Map<String, String> definition) {
 		this.definition = definition;
 	}
-
 }

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/model/vrang/VraNgCatalogEntitlementType.java → common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/aria/models/VraNgCatalogEntitlementType.java

@@ -12,7 +12,7 @@
  * This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
  * #L%
  */
-package com.vmware.pscoe.iac.artifact.model.vrang;
+package com.vmware.pscoe.iac.artifact.aria.models;
 
 import com.google.gson.annotations.SerializedName;
 

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/model/vrang/VraNgCatalogItem.java → common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/aria/models/VraNgCatalogItem.java

@@ -12,7 +12,7 @@
  * This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
  * #L%
  */
-package com.vmware.pscoe.iac.artifact.model.vrang;
+package com.vmware.pscoe.iac.artifact.aria.models;
 
 /**
  * Service Broker catalog item.

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/model/vrang/VraNgCatalogItemType.java → common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/aria/models/VraNgCatalogItemType.java

@@ -12,7 +12,7 @@
  * This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
  * #L%
  */
-package com.vmware.pscoe.iac.artifact.model.vrang;
+package com.vmware.pscoe.iac.artifact.aria.models;
 
 public class VraNgCatalogItemType {
 	/**

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/model/vrang/VraNgCloudAccount.java → common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/aria/models/VraNgCloudAccount.java

@@ -12,19 +12,39 @@
  * This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
  * #L%
  */
-package com.vmware.pscoe.iac.artifact.model.vrang;
+package com.vmware.pscoe.iac.artifact.aria.models;
 
 import java.util.Collections;
 import java.util.List;
 
+import org.apache.commons.lang3.builder.HashCodeBuilder;
+
+/**
+ * VraNgCloudAccount is the Aria Automation > Infrastructire > Cloud Account
+ * representation.
+ */
 public class VraNgCloudAccount {
+	/**
+	 * @param Prime Number 17.
+	 */
+	private static final int PRIME_NUMBER_17 = 17;
 
+	/**
+	 * @param Prime Number 31.
+	 */
+	private static final int PRIME_NUMBER_31 = 31;
 	private final String id;
 	private final String name;
 	private final String type;
 	private final List<String> regionIds;
 	private final List<String> tags;
 
+	/**
+	 * @param id        - the id of the CA
+	 * @param name      - the name of the CA
+	 * @param type      - the type of the CA
+	 * @param regionIds - all the region IDs for the cloud account
+	 */
 	public VraNgCloudAccount(String id, String name, String type, List<String> regionIds, List<String> tags) {
 		this.id = id;
 		this.name = name;
@@ -33,26 +53,44 @@ public VraNgCloudAccount(String id, String name, String type, List<String> regio
 		this.tags = tags;
 	}
 
+	/**
+	 * @return the id of the cloud account
+	 */
 	public String getId() {
 		return this.id;
 	}
 
+	/**
+	 * @return the name of the CA
+	 */
 	public String getName() {
 		return this.name;
 	}
 
+	/**
+	 * @return the type of the CA
+	 */
 	public String getType() {
 		return this.type;
 	}
 
+	/**
+	 * @return the region ids associated with the CA
+	 */
 	public List<String> getRegionIds() {
 		return Collections.unmodifiableList(this.regionIds);
 	}
 
+	/**
+	 * @return the tags associated with the CA
+	 */
 	public List<String> getTags() {
 		return Collections.unmodifiableList(this.tags);
 	}
 
+	/**
+	 * @param obj - object to check if it equals to this one
+	 */
 	@Override
 	public boolean equals(Object obj) {
 		if (obj == null || !this.getClass().equals(obj.getClass())) {
@@ -63,4 +101,15 @@ public boolean equals(Object obj) {
 		return this.id.equals(other.getId());
 	}
 
+	/**
+	 * @return the hash code of the object
+	 */
+	@Override
+	public int hashCode() {
+		return new HashCodeBuilder(PRIME_NUMBER_17, PRIME_NUMBER_31)
+				.append(name)
+				.append(type)
+				.toHashCode();
+	}
+
 }

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/model/vrang/VraNgConfig.java → common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/aria/models/VraNgConfig.java

@@ -13,7 +13,7 @@
  * This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
  * #L%
  */
-package com.vmware.pscoe.iac.artifact.model.vrang;
+package com.vmware.pscoe.iac.artifact.aria.models;
 
 import java.io.Serializable;
 import java.util.ArrayList;
@@ -23,6 +23,9 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 
+/**
+ * Content Source Configuration.
+ */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonPropertyOrder({ "workflows" })
 public class VraNgConfig implements Serializable {
@@ -31,11 +34,17 @@ public class VraNgConfig implements Serializable {
 	@JsonProperty("workflows")
 	private List<VraNgWorkflow> workflows = new ArrayList<>();
 
+	/**
+	 * @return the workflows
+	 */
 	@JsonProperty("workflows")
 	public List<VraNgWorkflow> getWorkflows() {
 		return workflows;
 	}
 
+	/**
+	 * @param workflows - the workflows to set
+	 */
 	@JsonProperty("workflows")
 	public void setWorkflows(List<VraNgWorkflow> workflows) {
 		this.workflows = workflows;

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/model/vrang/VraNgContentSharingPolicy.java → common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/aria/models/VraNgContentSharingPolicy.java

@@ -12,7 +12,7 @@
  * This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
  * #L%
  */
-package com.vmware.pscoe.iac.artifact.model.vrang;
+package com.vmware.pscoe.iac.artifact.aria.models;
 
 /**
 

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/model/vrang/VraNgContentSource.java → common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/aria/models/VraNgContentSource.java

@@ -12,7 +12,7 @@
  * This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
  * #L%
  */
-package com.vmware.pscoe.iac.artifact.model.vrang;
+package com.vmware.pscoe.iac.artifact.aria.models;
 
 import java.util.List;
 import java.util.Map;

common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/model/vrang/VraNgContentSourceBase.java → common/artifact-manager/src/main/java/com/vmware/pscoe/iac/artifact/aria/models/VraNgContentSourceBase.java

@@ -12,7 +12,7 @@
  * This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
  * #L%
  */
-package com.vmware.pscoe.iac.artifact.model.vrang;
+package com.vmware.pscoe.iac.artifact.aria.models;
 
 import java.util.ArrayList;
 import java.util.List;