Merge pull request #36 from eclipse-basyx/release/1.0.2

Release/1.0.2

Author: FrankSchnicke

pom.xml

@@ -5,8 +5,33 @@
 
 	<groupId>org.eclipse.basyx</groupId>
 	<artifactId>basyx.sdk</artifactId>
-	<version>1.0.1</version>
+	<version>1.0.2</version>
 	<name>BaSyx SDK</name>
+	<description>BaSyx Software Development Kit</description>
+	<url>https://www.eclipse.org/basyx/</url>
+	
+	<licenses>
+		<license>
+			<name>Eclipse Public License 2.0</name>
+			<url>https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt</url>
+		</license>
+	</licenses>
+	
+	<developers>
+        <developer>
+            <organization>Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.</organization>
+            <id>fschnicke</id>
+			<name>Frank Schnicke</name>
+			<email>frank.schnicke@iese.fraunhofer.de</email>
+        </developer>
+    </developers>
+	
+	<scm>
+		<connection>scm:https://github.com/eclipse-basyx/basyx-java-sdk.git</connection>
+		<developerConnection>scm:https://github.com/eclipse-basyx/basyx-java-sdk.git</developerConnection>
+		<tag>HEAD</tag>
+		<url>https://github.com/eclipse-basyx/basyx-java-sdk</url>
+	</scm>
 
 	<packaging>jar</packaging>
 
@@ -113,6 +138,25 @@
 					</execution>
 				</executions>
 			</plugin>
+			
+			<!-- Generate javadoc -->
+			<plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.2.0</version>
+                <configuration>
+      				<source>8</source>
+    			</configuration>
+                <executions>
+	                <execution>
+	                	<goals>
+	                    	<goal>jar</goal>
+	                    </goals>
+	                    <id>generate-javadoc</id>
+	                    <phase>package</phase>
+	                </execution>
+				</executions>
+			</plugin>
 		</plugins>
 	</build>
 
@@ -121,7 +165,7 @@
 		<dependency>
 			<groupId>junit</groupId>
 			<artifactId>junit</artifactId>
-			<version>4.12</version>
+			<version>4.13.1</version>
 			<scope>test</scope>
 		</dependency>
 
@@ -143,14 +187,14 @@
 		<dependency>
 			<groupId>org.eclipse.milo</groupId>
 			<artifactId>sdk-client</artifactId>
-			<version>0.3.3</version>
+			<version>0.3.6</version>
 		</dependency>
 
 		<!-- Eclipse Milo (for OPC-UA server) -->
 		<dependency>
 			<groupId>org.eclipse.milo</groupId>
 			<artifactId>sdk-server</artifactId>
-			<version>0.3.3</version>
+			<version>0.3.6</version>
 		</dependency>
 
 		<!-- Java Servlet API (for HTTP provider) -->
@@ -197,9 +241,9 @@
 
 		<!-- Logger -->
 		<dependency>
-    		<groupId>ch.qos.logback</groupId>
-    		<artifactId>logback-classic</artifactId>
-    		<version>1.2.3</version>
+			<groupId>ch.qos.logback</groupId>
+			<artifactId>logback-classic</artifactId>
+			<version>1.2.3</version>
 		</dependency>
 
 		<!-- Used by Logback to compile filter expressions from logback.xml -->
@@ -224,5 +268,46 @@
 		</dependency>
 
 	</dependencies>
+	
+	<profiles>
+		<profile>
+			<id>MavenCentral</id>
+			<distributionManagement>
+				<snapshotRepository>
+					<id>ossrh</id>
+					<url>https://oss.sonatype.org/content/repositories/snapshots</url>
+				</snapshotRepository>
+				<repository>
+					<id>ossrh</id>
+					<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
+				</repository>
+			</distributionManagement>
+			<build>
+				<plugins>
+					<!-- Signing the artifacts -->
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-gpg-plugin</artifactId>
+						<version>1.6</version>
+						<executions>
+						  <execution>
+							<id>sign-artifacts</id>
+							<phase>verify</phase>
+							<goals>
+							  <goal>sign</goal>
+							</goals>
+							<configuration>
+							  <gpgArguments>
+								<arg>--pinentry-mode</arg>
+								<arg>loopback</arg>
+							  </gpgArguments>
+							</configuration>
+						  </execution>
+						</executions>
+					</plugin>
+				</plugins>
+			</build>
+		</profile>
+	</profiles>
 </project>
 

src/main/java/org/eclipse/basyx/aas/aggregator/api/IAASAggregator.java

@@ -19,7 +19,7 @@
 
 
 /**
- * Interface for the Asset Administration Shell Aggregator API <br />
+ * Interface for the Asset Administration Shell Aggregator API <br>
  * It is used to manage multiple AASs at the same endpoint
  * 
  * @author conradi

src/main/java/org/eclipse/basyx/aas/aggregator/restapi/AASAggregatorProvider.java

@@ -60,7 +60,7 @@ private String stripPrefix(String path) throws MalformedRequestException {
 	}
 
 	/**
-	 * Makes sure, that given Object is an AAS by checking its ModelType<br />
+	 * Makes sure, that given Object is an AAS by checking its ModelType<br>
 	 * Creates a new AAS with the content of the given Map
 	 * 
 	 * @param value

src/main/java/org/eclipse/basyx/aas/factory/aasx/AASXPackageExplorerConformantHelper.java

@@ -12,7 +12,6 @@
 import java.util.Collection;
 import java.util.List;
 import java.util.stream.Collectors;
-
 import org.eclipse.basyx.aas.metamodel.api.IAssetAdministrationShell;
 import org.eclipse.basyx.aas.metamodel.api.parts.asset.IAsset;
 import org.eclipse.basyx.aas.metamodel.map.AasEnv;
@@ -21,6 +20,7 @@
 import org.eclipse.basyx.submodel.metamodel.api.parts.IConceptDescription;
 import org.eclipse.basyx.submodel.metamodel.api.reference.IKey;
 import org.eclipse.basyx.submodel.metamodel.api.reference.IReference;
+import org.eclipse.basyx.submodel.metamodel.api.reference.enums.KeyElements;
 import org.eclipse.basyx.submodel.metamodel.map.reference.Reference;
 
 /**
@@ -31,9 +31,13 @@
  *
  */
 public class AASXPackageExplorerConformantHelper {
+	
+	static int counter = 0;
 	/**
 	 * Converts meta model elements so that the AASXPackageExplorer can load their
-	 * serialized AASX
+	 * serialized AASX. This method modifies the passed parameter Asset Administration Shell List.
+	 * As the passed Asset Administration Shell List contains objects as references thatswhy original 
+	 * List is modified.
 	 * 
 	 * @param aasList
 	 * @param assetList
@@ -42,11 +46,10 @@ public class AASXPackageExplorerConformantHelper {
 	 * @return
 	 */
 	public static AasEnv adapt(Collection<IAssetAdministrationShell> aasList, Collection<IAsset> assetList,
-			Collection<IConceptDescription> conceptDescriptionList, Collection<ISubmodel> submodelList) {
+		Collection<IConceptDescription> conceptDescriptionList, Collection<ISubmodel> submodelList) {
 
 		Collection<IAssetAdministrationShell> convertedAASs = aasList.stream()
-				.map(AASXPackageExplorerConformantHelper::removeFirstKeyFromSubmodelReferences)
-				.collect(Collectors.toList());
+				.map(AASXPackageExplorerConformantHelper::removeFirstKeyFromSubmodelReferences).collect(Collectors.toList());
 
 		return new AasEnv(convertedAASs, assetList, conceptDescriptionList, submodelList);
 	}
@@ -74,10 +77,13 @@ private static IAssetAdministrationShell removeFirstKeyFromSubmodelReferences(IA
 
 	private static IReference removeFirstKeyElement(IReference reference) {
 		List<IKey> keys = reference.getKeys();
-		keys.remove(0);
 
-		IReference ref = new Reference(keys);
-		return ref;
-	}
+		if(!keys.isEmpty() && keys.get(0).getType().equals(KeyElements.ASSETADMINISTRATIONSHELL)) {
+			keys.remove(0);
+			
+			return new Reference(keys);
+		}
 
+		return reference;
+	}
 }

src/main/java/org/eclipse/basyx/aas/factory/xml/XMLToMetamodelConverter.java

@@ -92,9 +92,6 @@ public List<IAsset> parseAssets() throws ParserConfigurationException, SAXExcept
 	 * Parses the Submodels form the XML
 	 * 
 	 * @return the Submodels parsed form the XML
-	 * @throws ParserConfigurationException
-	 * @throws SAXException
-	 * @throws IOException
 	 */
 	@SuppressWarnings("unchecked")
 	public List<ISubmodel> parseSubmodels() {
@@ -107,9 +104,6 @@ public List<ISubmodel> parseSubmodels() {
 	 * Parses the ConceptDescriptions form the XML
 	 * 
 	 * @return the ConceptDescriptions parsed form the XML
-	 * @throws ParserConfigurationException
-	 * @throws SAXException
-	 * @throws IOException
 	 */
 	@SuppressWarnings("unchecked")
 	public List<IConceptDescription> parseConceptDescriptions() {

src/main/java/org/eclipse/basyx/aas/manager/ConnectedAssetAdministrationShellManager.java

@@ -32,8 +32,8 @@
 import org.eclipse.basyx.vab.protocol.http.connector.HTTPConnectorFactory;
 
 /**
- * Implement a AAS manager backend that communicates via HTTP/REST<br />
- * <br />
+ * Implement a AAS manager backend that communicates via HTTP/REST<br>
+ * <br>
  * 
  * @author kuhn, schnicke
  * 
@@ -54,8 +54,8 @@ public ConnectedAssetAdministrationShellManager(IAASRegistry directory) {
 	}
 
 	/**
-	 * @param networkDirectoryService
-	 * @param providerProvider
+	 * @param directory
+	 * @param provider
 	 */
 	public ConnectedAssetAdministrationShellManager(IAASRegistry directory,
 			IConnectorFactory provider) {

src/main/java/org/eclipse/basyx/aas/manager/api/IAssetAdministrationShellManager.java

@@ -41,7 +41,6 @@ public interface IAssetAdministrationShellManager {
 	 * Creates an AAS on a remote server
 	 * 
 	 * @param aas
-	 * @param aasId
 	 * @param endpoint
 	 */
 	void createAAS(AssetAdministrationShell aas, String endpoint);

src/main/java/org/eclipse/basyx/aas/metamodel/api/IAssetAdministrationShell.java

@@ -35,7 +35,7 @@ public interface IAssetAdministrationShell extends IElement, IIdentifiable, IHas
 	/**
 	 * Return all registered submodels of this AAS
 	 * 
-	 * @return IdShort -> ISubmodel
+	 * @return {@literal IdShort -> ISubmodel}
 	 */
 	public Map<String, ISubmodel> getSubmodels();
 
@@ -98,7 +98,7 @@ public interface IAssetAdministrationShell extends IElement, IIdentifiable, IHas
 
 
 	/**
-	 * Gets the views associated with the AAS. <br/>
+	 * Gets the views associated with the AAS. <br>
 	 * If needed stakeholder specific views can be defined on the elements of the
 	 * AAS.
 	 * 
@@ -107,7 +107,7 @@ public interface IAssetAdministrationShell extends IElement, IIdentifiable, IHas
 	public Collection<IView> getViews();
 
 	/**
-	 * Gets the concept dictionaries associated with the AAS. <br/>
+	 * Gets the concept dictionaries associated with the AAS. <br>
 	 * An AAS may have one or more concept dictionaries assigned to it. The concept
 	 * dictionaries typically contain only descriptions for elements that are also
 	 * used within the AAS (via HasSemantics).

src/main/java/org/eclipse/basyx/aas/metamodel/api/parts/IConceptDictionary.java

@@ -16,10 +16,10 @@
 import org.eclipse.basyx.submodel.metamodel.api.reference.IReference;
 
 /**
- * A dictionary contains elements that can be reused. <br />
- * <br />
- * The concept dictionary contains concept descriptions. <br />
- * <br />
+ * A dictionary contains elements that can be reused. <br>
+ * <br>
+ * The concept dictionary contains concept descriptions. <br>
+ * <br>
  * Typically a concept description dictionary of an AAS contains only concept
  * descriptions of elements used within submodels of the AAS.
  * 

src/main/java/org/eclipse/basyx/aas/metamodel/api/parts/asset/AssetKind.java

@@ -13,7 +13,7 @@
 import org.eclipse.basyx.submodel.metamodel.enumhelper.StandardizedLiteralEnumHelper;
 
 /**
- * AssetKind enum as defined by DAAS document<br />
+ * AssetKind enum as defined by DAAS document<br>
  * Enumeration for denoting whether an element is a type or an instance.
  * 
  * @author schnicke