Doc fixes and updates for eclipse-plugin packaging

Ranjan-Dasgupta · Ranjan-Dasgupta · commit 5f6f085b6efd · 2020-07-10T12:51:32.000-05:00
Signed-off-by: Ranjan-Dasgupta &lt;Ranjan.Dasgupta@us.ibm.com&gt;
diff --git a/org.eclipse.paho.mqttv5.client.repository/category.xml b/org.eclipse.paho.mqttv5.client.repository/category.xml
diff --git a/org.eclipse.paho.mqttv5.client/META-INF/MANIFEST.MF b/org.eclipse.paho.mqttv5.client/META-INF/MANIFEST.MF
@@ -1,15 +1,13 @@
 Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
-Bundle-Name: %bundle.name
+Bundle-Name: Paho Mqtt Client
 Bundle-SymbolicName: org.eclipse.paho.mqttv5.client
 Bundle-Version: 1.2.5
 Bundle-Localization: bundle
-Export-Package: org.eclipse.paho.mqttv5.client;version="1.2.5",
- org.eclipse.paho.mqttv3.client.logging;version="1.2.5",
- org.eclipse.paho.mqttv3.client.persist;version="1.2.5",
- org.eclipse.paho.mqttv3.client.util;version="1.2.5"
-Bundle-Vendor: %bundle.provider
-Bundle-ActivationPolicy: lazy
 Bundle-RequiredExecutionEnvironment: JavaSE-1.8
+Require-Bundle: org.eclipse.paho.mqttv5.common;bundle-version="1.2.5"
+Export-Package: org.eclipse.paho.mqttv5.client;version="1.2.5"
+Bundle-Vendor: Paho
+Bundle-ActivationPolicy: lazy
 Import-Package: javax.net;resolution:=optional,
  javax.net.ssl;resolution:=optional
diff --git a/org.eclipse.paho.mqttv5.client/pom.xml b/org.eclipse.paho.mqttv5.client/pom.xml
@@ -12,19 +12,7 @@
 
     <artifactId>org.eclipse.paho.mqttv5.client</artifactId>
     <name>org.eclipse.paho.mqttv5.client</name>
-
-    <dependencies>
-        <dependency>
-            <groupId>org.eclipse.paho</groupId>
-            <artifactId>org.eclipse.paho.mqttv5.common</artifactId>
-            <version>1.2.5</version>
-        </dependency>
-        <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
-            <version>${junit.version}</version>
-        </dependency>
-    </dependencies>
+    <packaging>eclipse-plugin</packaging>
 
     <build>
         <plugins>
@@ -67,29 +55,23 @@
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.7.0</version>
                 <configuration>
-                    <source>1.8</source>
-                    <target>1.8</target>
+                    <source>${java.version}</source>
+                    <target>${java.version}</target>
                 </configuration>
+                <dependencies>
+                    <dependency>
+                        <groupId>org.eclipse.paho</groupId>
+                        <artifactId>org.eclipse.paho.mqttv5.common</artifactId>
+                        <version>1.2.5</version>
+                    </dependency>
+                </dependencies>
             </plugin>
 
             <plugin>
                 <groupId>org.eclipse.tycho</groupId>
                 <artifactId>tycho-maven-plugin</artifactId>
             </plugin>
 
-            <plugin>
-                <groupId>org.codehaus.mojo</groupId>
-                <artifactId>templating-maven-plugin</artifactId>
-                <version>1.0.0</version>
-                <executions>
-                    <execution>
-                        <id>filter-src</id>
-                        <goals>
-                            <goal>filter-sources</goal>
-                        </goals>
-                    </execution>
-                </executions>
-            </plugin>
 
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
@@ -124,8 +106,8 @@
                 <artifactId>tycho-compiler-plugin</artifactId>
                 <version>${tycho.version}</version>
                 <configuration>
-                    <source>1.8</source>
-                    <target>1.8</target>
+                    <source>${java.version}</source>
+                    <target>${java.version}</target>
                 </configuration>
             </plugin>
 
diff --git a/org.eclipse.paho.mqttv5.common.repository/category.xml b/org.eclipse.paho.mqttv5.common.repository/category.xml
diff --git a/org.eclipse.paho.mqttv5.common.repository/pom.xml b/org.eclipse.paho.mqttv5.common.repository/pom.xml
diff --git a/org.eclipse.paho.mqttv5.common/META-INF/MANIFEST.MF b/org.eclipse.paho.mqttv5.common/META-INF/MANIFEST.MF
@@ -1,12 +1,12 @@
 Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
-Bundle-Name: %bundle.name
+Bundle-Name: Paho Mqtt Client
 Bundle-SymbolicName: org.eclipse.paho.mqttv5.common
 Bundle-Version: 1.2.5
 Bundle-Localization: bundle
+Bundle-RequiredExecutionEnvironment: JavaSE-1.8
 Export-Package: org.eclipse.paho.mqttv5.common;version="1.2.5"
-Bundle-Vendor: %bundle.provider
+Bundle-Vendor: Paho
 Bundle-ActivationPolicy: lazy
-Bundle-RequiredExecutionEnvironment: JavaSE-1.8
 Import-Package: javax.net;resolution:=optional,
  javax.net.ssl;resolution:=optional
diff --git a/org.eclipse.paho.mqttv5.common/pom.xml b/org.eclipse.paho.mqttv5.common/pom.xml
@@ -12,6 +12,7 @@
 
     <artifactId>org.eclipse.paho.mqttv5.common</artifactId>
     <name>org.eclipse.paho.mqttv5.common</name>
+    <packaging>eclipse-plugin</packaging>
 
     <dependencies>
         <dependency>
@@ -41,8 +42,8 @@
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.7.0</version>
                 <configuration>
-                    <source>1.8</source>
-                    <target>1.8</target>
+                    <source>${java.version}</source>
+                    <target>${java.version}</target>
                 </configuration>
             </plugin>
 
@@ -98,8 +99,8 @@
                 <artifactId>tycho-compiler-plugin</artifactId>
                 <version>${tycho.version}</version>
                 <configuration>
-                    <source>1.8</source>
-                    <target>1.8</target>
+                    <source>${java.version}</source>
+                    <target>${java.version}</target>
                 </configuration>
             </plugin>
 
diff --git a/org.eclipse.paho.mqttv5.common/src/main/java/org/eclipse/paho/mqttv5/common/MqttException.java b/org.eclipse.paho.mqttv5.common/src/main/java/org/eclipse/paho/mqttv5/common/MqttException.java
@@ -18,11 +18,8 @@ public class MqttException extends Exception {
 	// New MQTTv5 Packet Errors
 	public static final int REASON_CODE_INVALID_IDENTIFIER = 50000; // Invalid Identifier in the IV fields
 	public static final int REASON_CODE_INVALID_RETURN_CODE = 50001; // Invalid Return code
-	public static final int REASON_CODE_MALFORMED_PACKET = 50002; // Packet was somehow malformed and did not comply to
-																	// the MQTTv5 specification
-	public static final int REASON_CODE_UNSUPPORTED_PROTOCOL_VERSION = 50003; // The CONNECT packet did not contain the
-																				// correct protocol name or version
-	
+	public static final int REASON_CODE_MALFORMED_PACKET = 50002; // Packet was somehow malformed and did not comply to the MQTTv5 specification
+	public static final int REASON_CODE_UNSUPPORTED_PROTOCOL_VERSION = 50003; // The CONNECT packet did not contain the correct protocol name or version
 
 	/**
 	 * The Server sent a publish message with an invalid topic alias.
@@ -57,6 +54,11 @@ public MqttException(int reasonCode) {
 	 * meant as a hint for the developer, as the
 	 * <code>MqttCallback.disconnected</code> callback is the intended disconnect
 	 * notification mechanism.
+         *
+	 * @param reasonCode
+	 *            the reason code associated with the exception
+	 * @param disconnect 
+	 *            the disconnect data
 	 */
 	public MqttException(int reasonCode, MqttDisconnect disconnect) {
 		super();
diff --git a/org.eclipse.paho.mqttv5.common/src/main/java/org/eclipse/paho/mqttv5/common/packet/MqttProperties.java b/org.eclipse.paho.mqttv5.common/src/main/java/org/eclipse/paho/mqttv5/common/packet/MqttProperties.java
@@ -1157,6 +1157,7 @@ public boolean getPayloadFormat() {
 	 * Payload Format. See {@link MqttProperties#getPayloadFormat()}
 	 * 
 	 * @param payloadFormat
+         *        true if payload format is set, otherwise false
 	 */
 	public void setPayloadFormat(boolean payloadFormat) {
 		this.payloadFormat = payloadFormat;
diff --git a/org.eclipse.paho.mqttv5.common/src/main/java/org/eclipse/paho/mqttv5/common/util/MqttTopicValidator.java b/org.eclipse.paho.mqttv5.common/src/main/java/org/eclipse/paho/mqttv5/common/util/MqttTopicValidator.java
@@ -46,6 +46,8 @@ public class MqttTopicValidator {
 	 *            topic name or filter
 	 * @param wildcardAllowed
 	 *            true if validate topic filter, false otherwise
+	 * @param sharedSubAllowed
+	 *            true if shared subscription is allowed, false otherwise
 	 * @throws IllegalArgumentException
 	 *             if the topic is invalid
 	 */
diff --git a/org.eclipse.paho.repository/category.xml b/org.eclipse.paho.repository/category.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<site>
+    <bundle id="org.eclipse.paho.client.mqttv3" version="1.2.5" />
+    <bundle id="org.eclipse.paho.mqttv5.common" version="1.2.5" />
+    <bundle id="org.eclipse.paho.mqttv5.client" version="1.2.5" />
+    <category-def name="Paho MQTT Java" label="Paho MQTT Java">
+	<description>
+The Eclipse Paho project provides open-source client implementations of MQTT and MQTT-SN messaging protocols aimed at new, existing, and emerging applications for the Internet of Things (IoT).
+	</description>
+    </category-def>
+</site>
diff --git a/org.eclipse.paho.repository/pom.xml b/org.eclipse.paho.repository/pom.xml
@@ -1,16 +1,15 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <parent>
-        <groupId>org.eclipse.paho</groupId>
-        <artifactId>java-parent</artifactId>
-        <version>1.2.5</version>
+    <groupId>org.eclipse.paho</groupId>
+    <artifactId>java-parent</artifactId>
+    <version>1.2.5</version>
     </parent>
 
-    <artifactId>org.eclipse.paho.mqttv5.client.repository</artifactId>
+    <artifactId>org.eclipse.paho.repository</artifactId>
     <version>1.2.5</version>
     <packaging>eclipse-repository</packaging>
-
-    <name>Paho P2 Repository for mqttv5 client</name>
+    <name>Paho P2 Repository</name>
 
     <build>
         <plugins>
@@ -44,25 +43,6 @@
                     </execution>
                 </executions>
             </plugin>
-            <!-- <plugin>
-                <groupId>org.eclipse.tycho.extras</groupId>
-                <artifactId>tycho-p2-extras-plugin</artifactId>
-                <executions>
-                    <execution>
-                        <id>update-main-p2-repo</id>
-                        <phase>package</phase>
-                        <goals>
-                            <goal>publish-features-and-bundles</goal>
-                        </goals>
-                        <configuration>
-                            <append>true</append>
-                            <artifactRepositoryLocation>/shared/technology/paho/Java</artifactRepositoryLocation>
-                            <metadataRepositoryLocation>/shared/technology/paho/Java</metadataRepositoryLocation>
-                            <sourceLocation>${project.build.directory}/repository</sourceLocation>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin> -->
         </plugins>
     </build>
 </project>
diff --git a/org.eclipse.paho.sample.utility/pom.xml b/org.eclipse.paho.sample.utility/pom.xml
@@ -29,7 +29,7 @@
                             <mainClass>org.eclipse.paho.sample.utility.MQTTFrame</mainClass>
                         </manifest>
                     </archive>
-                    <appendAssemblyId>false</appendAssemblyId>
+                    <appendAssemblyId>true</appendAssemblyId>
                 </configuration>
                 <executions>
                     <execution>
diff --git a/org.eclipse.paho.sample.utility/src/main/java/org/eclipse/paho/sample/utility/PubPanel.java b/org.eclipse.paho.sample.utility/src/main/java/org/eclipse/paho/sample/utility/PubPanel.java
@@ -164,7 +164,7 @@ public void init() {
         pubPanel.add( buttonLayout, BorderLayout.EAST );
 	}	
 
-    /**
+    /*
      * For any requests to add a topic to the subscribe drop down box
      * use the updateComboBoxList method in class MQTTFrame to do the job.
      */
diff --git a/org.eclipse.paho.sample.utility/src/main/java/org/eclipse/paho/sample/utility/SubPanel.java b/org.eclipse.paho.sample.utility/src/main/java/org/eclipse/paho/sample/utility/SubPanel.java
@@ -207,7 +207,7 @@ public void init() {
 
    	}	
 		
-    /**
+    /*
      * For any requests to add a topic to the publish drop down box
      * use the updateComboBoxList method in class MQIsdpFrame to do the job.
      */
@@ -274,7 +274,7 @@ public void actionPerformed( ActionEvent e ) {
     	}	
     }    
     
-    /**
+    /*
      * This method is passed a received publication. It then:
      * <UL><LI>Switches the display to text if was in hex display mode
      * <LI>Updates the display with the new data
diff --git a/pom.xml b/pom.xml
@@ -8,12 +8,12 @@
 
     <properties>
         <!-- source & target java version for MQTT Client -->
-        <mqttclient.java.version>1.7</mqttclient.java.version>
+        <mqttclient.java.version>1.8</mqttclient.java.version>
         <!-- source & target java version for others modules -->
         <java.version>1.8</java.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <build.level>${maven.build.timestamp}</build.level>
-        <tycho.version>1.5.1</tycho.version>
+        <tycho.version>1.7.0</tycho.version>
         <junit.version>4.12</junit.version>
         <javadoc.version>3.2.0</javadoc.version>
         <mvnsource.version>3.2.0</mvnsource.version>
@@ -357,6 +357,7 @@
         <module>org.eclipse.paho.mqttv5.common</module>
         <module>org.eclipse.paho.mqttv5.client</module>
         <module>org.eclipse.paho.mqttv5.client.test</module>
+        <module>org.eclipse.paho.repository</module>
     </modules>
 </project>
 

Original file line number	Diff line number	Diff line change
`@@ -1157,6 +1157,7 @@ public boolean getPayloadFormat() {`
`1157`	`1157`	`* Payload Format. See {@link MqttProperties#getPayloadFormat()}`
`1158`	`1158`	`*`
`1159`	`1159`	`* @param payloadFormat`
	`1160`	`+ * true if payload format is set, otherwise false`
`1160`	`1161`	`*/`
`1161`	`1162`	`public void setPayloadFormat(boolean payloadFormat) {`
`1162`	`1163`	`this.payloadFormat = payloadFormat;`