JSDK-280

Java SDK uses the Duty Cycle thread to periodically check the ThingWorx Server certificate for validity and expiration. When the ThingWorx Server Certificate has expired, the connection with the ThingWorx platform is terminated to improve security between the platform and the Java SDK-based edge agent.

JSDK-623

Logback configuration files that reside in the same directory as the example JAR files are now supported.

JSDK-756

Logback has been upgraded to 1.2.9 to fix vulnerability in CVE-2021-4104.

JSDK-673

The Netty library used by the Edge Java SDK has been upgraded to v.4.1.68 to fix vulnerabilities in CVE-2021-37136, CVE-2021-37137.

JSDK-363

The gradle wrapper and configuration file are included in the distribution bundle and can be used on all Java SDK projects. Use the gradle wrapper to run the SDK build.

JSDK-403

Due to security concerns over the storage of secrets in memory, how you supply application keys and username/password combinations to a Java SDK application has changed in this release. With a username/password, this is effectively storing two secrets in memory, compared to one with an application key.

Refer to Password Callbacks for details.

JSDK-408

Removed unused/dead code from Java SDK.

JSDK-425

The StringUtilities functions have been deprecated.

JSDK-433

The Java SDK Android examples demonstrate proxy support. Refer to Proxy Server Support for Android to learn about proxy support and to Setting Up to Run Sample Android Applications for information about running the examples.

JSDK-429

Binary messages are now logged at the TRACE level. Text versions of the messages are also logged.

JSDK-433

Added proxy support to all Java SDK examples, including the Android examples. Refer to Proxy Server Support for Android for details about proxy support for Android applications.

JSDK-491

Code that was not used by the SDK is deprecated in this release. In addition, code coverage has been improved for this release.

JSDK-508 (14140454)

Added custom client key support for Android. Keystore and truststore paths have been added to the Java SDK's ClientConfigurator class to support custom client keys. Client key configuration has also been added to the Android examples provided in the distribution bundle. Refer to Custom Client Key Support for Android for details.

JSDK-576

The following example functionality has been added to the Edge Java SDK SteamSensor example:

JSDK-233

The SteamThing example now uses only one call to initializeFromAnnotations.

JSDK-440 (15095431)

The TimeoutException and ConnectionException logic for updateSubscribedProperties has been improved and added back in the Edge Java SDK v.7.0.0.

Several tests were created to ensure that the exceptions are thrown correctly and at correct times.

JSDK-461

Two infoTable methods in the ValueCollection class have been deprecated: toInfoTable() and toInfoTable(String).

JSDK-469 (15073319) and JSDK-470

An issue with file transfers with compression was caused by an issue in the Netty library. Netty has fixed the issue and this release of the Edge Java SDK includes the fixed Netty library, v.4.1.48.

JSDK-470 (15073319)

The Netty library used by the Edge Java SDK has been upgraded to v.4.1.48.

JSDK-584 (15078713)

Multiple threads adding subscribed property updates simultaneously can no longer overwrite each other.

JSDK-283 (14199727)

Add named exception when authentication fails due to bad security claim.

To provide a way to easily identify when a security claim has failed, this release adds a named exception that will be thrown when any issue around the connection occurs, including failed authentication.

JSDK-297 (14675441) and JSDK-374

The addPendingPropertyUpdates in Java SDK 6.1.0.679

In releases 6.0.3, 6.0.4 and 6.1.0.679, the method, addPendingPropertyUpdates, added in v.6.0.2, was omitted. In v.6.2.0, this method has been restored, in the VirtualThing class for queueing unsent property values. In addition, replacePropertyUpdates has been removed.

JSDK-226

Enable WebSocket Compression in the JSDK

WebSocket compression has been added to the Edge Java SDK in this release. Compression is supported between the edge and ThingWorx Platform for WebSocket communications, including file transfers and tunneling. Refer too the ThingWorx Edge Java SDK Developer’s Guide, v.6.1.0. The zlib compression utility, version 1.2.11, is used to compress and extract files from a ZIP archive. By default compression is enabled because the client must request compression from ThingWorx Platform (or the ThingWorx Connection Server). The version of netty-all has been updated to 4.1.14 Final to support compression from the Java SDK to a ThingWorx endpoint (the platform or a ThingWorx Connection Server).

JSDK-256

File transfers failing with v.6.0.4

The FileTransferVirtualThing.getVirtualPath(String path) method was taking the virtual directory in such a way that the first character of the path was missed, resulting in the wrong directory and failure of the file transfer.

This issue is fixed in this release.

JSDK-248

Old Java SDK does not work with ThingWorx 8.x+.

As part of JSDK-90, the maxFileSize parameter for file system services changed to use doubles instead of ints/longs. If a user attempts to transfer a file from the 6.0.2 build of the Java SDK to a ThingWorx Platform running 8.x, a casting issue will cause the transfer to be cancelled immediately. The older builds of the Java SDK can transfer files only with ThingWorx 7.x and earlier.

RESOLUTION: This issue is fixed in this release. The file transfer operation with the Java SDK now will work with ThingWorx 8.x and earlier (e.g., 7.2 and 7.3).

JSDK-253

Copy Failed with the message, java.lang.Long cannot be cast to java.lang.Double, when attempting to copy a file.

This issue occurred when connecting to ThingWorx Platform 7.3 or 7.4 for a copy operation (file transfer). It worked fine when connecting to ThingWorx Platform 8.0.

CAUSE: A change in ThingWorx Platform 8.0 caused the copy operation to succeed in 8.0 but fail in earlier versions.

RESOLUTION: This issue is fixed in this release. The copy operation now will work with ThingWorx Platform 7.2 and 7.3.

JSDK-75

File transfers that use identifiers

With this release, file transfers to a VirtualThing that uses an identifier (instead of a Thing name) have been thoroughly tested against the ThingWorx Platform and shown to work as expected.

JSDK-76

Move binary message hex dumps from the Android SDK to the Java SDK

The ability to print hex dumps of sent and received binary messages when the log level is set to TRACE has been moved from the Android SDK into the main Java SDK. This capability is available in both SDKs.

JSDK-90

Java SDK limits file transfers to 2GB.

With this release, the Java SDK can support the transfer of a file that is greater than MAX_INT in size.

JSDK-97

Java SDK ClientConfigurator should accept file transfer options.

With this release, you can set the block size and maximum file size for file transfers. Refer too the topic, “Configuring File Transfers” in the ThingWorx Edge SDKs and WebSocket-based Edge MicroServer Help Center or in the chapter on file transfers in the Java SDK developer’s guide, to read about the set and get methods for specifying and retrieving this information for a file transfer.

JSDK-101

Java SDK sample code for property listener features

Property listeners have been added to the Java SDK as part of the Android SDK project. With this release, sample code is provided in the Java SDK examples that show how to use property listeners.

JSDK-102

Enable persisting InfoTable configurations that contain nested InfoTables

To support complex extension configurations, the ThingWorx Edge Java SDK supports persisting and consuming of configuration files that contain nested InfoTables. Refer too the topic, Persisting Nested InfoTable Configurations, in the documentation for more information.

JSDK-112 (12873723)

Implement a Max Message Size variable in the Java/Android SDK

The ClientConfigurator now accepts a maxMessageSize option. Note that this setting refers to the maximum ThingWorx message size and not the size of an individual WebSocket message. For more details, refer to the section, ClientConfigurator Component of the documentation.

JSDK-26 (13530483)

ThingWorx client cannot reconnect to the server after network connectivity loss and subsequent change in IP address.

Issue: A PCM device can provide data connection using GSM/CDMA technology and is assigned a dynamic IP address by the customer’s TELCO provider when the modem is attached to the network. If the modem interface went down and a new IP address was assigned when it restarted, the ThingWorx client could not reconnect.

Cause: The WebSocket close frame never reached ThingWorx Platform after the WebSocket pong timeout, and the client application never closed the socket locally.

Resolution: Forcibly closing the socket allows the client application to re-establish connectivity. After the client misses a pong from ThingWorx Platform, the client’s WebSocket now times out locally after sending the close frame to ThingWorx Platform. It is important to note that it is still the responsibility of the customer to invoke BaseClient.connect to reconnect to ThingWorx Platform after a network interruption.

JSDK-40 (13508403)

ConnectivityMonitorTask thread is not stopped and fills the entire log.

Issue: The AlwaysOn connection that is created by the Java SDK is not stopped, even after the ThingWorx client is shut down. The ConnectivityMonitorTask thread reports errors in the logs, eventually filling the entire log.

Resolutiuon: The call made by this_endpointMonitorService.shutdownNow() now stops all the threads.

JSDK-42

Loopback connections with Java SDK

Issue: 16 Loopback Ports from the java.exe process were being opened when running a Java SDK, in Windows. 16 Loopback Ports from the Tomcat.exe process were being opened when running the Java SDK, in Windows.

This issue is fixed in this release.

JSDK-44 (12983882)

Java Developer documentation gives wrong location of ExampleExport.xml.

This issue was fixed in the April 11, 2017, release of the ThingWorx Edge SDKs and WebSocket-based Edge MicroServer Help Center. It is also fixed in the PDF for the Java SDK developer’s guide for version 6.0.3.

JSDK-46 (13088081)

Java SDK setReconnectInterval is ignored upon initial connection failing.

Issue: A reconnect was attempted approximately every 10 seconds instead of at the interval passed into the setReconnectInterval method (which was 500).

Cause: Seconds were being passed in as the value for the interval instead of milliseconds.

This issue is fixed in this release.

JSDK-48

The unbindThing method of the ConnectedThingClient throws a NullPointerException.

Cause: The unbindThing method in the ConnectedThingClient removed the Thingfrom the internal _virtualThings map and then called the overridden unbind(String) method through a series of calls that attempted to access the Thingthrouggh the map from which it was just deleted. The code then called setBound on the null object reference, triggering the NullPointerException.

Resolution: The removal from the map now occurs AFTER the unbind call.

JSDK-52 (12947285)

Java SDK 6.0 does not use an explicit Proxy Server

Issue: Although proxy server settings were configured for the SteamSensorClient, the request from the client went directly to ThingWorx Platform, bypassing the proxy server.

This issue is fixed in this release.

JSDK-54

Client connection remains active after Shutdown() is called.

Issue: Although the client connection was destroyed, it kept generating log data as it attempted to reconnect.

Cause: The Connection Monitor on ThingWorx Platform was not shut down properly when the subsystem shut down, affeccting all clients that depend on the shutdown() method of the BaseClient.

Resolution: The issue on ThingWorx Platform has been fixed, which also resolves this issue.

JSDK-55

DefaultValue aspect validation fails silently

Issue: If an annotation was created with a default value that failed to parse into the appropriate primitive type, an exception was generated and then silently disposed of without ever telling the user. This exception caused all remaining @ThingworxPropertyDefinition annotations to be ignored and resulted in a VirtualThing with no properties at runtime, without warning. This issue also occurred with LOCATION if it was not except 2 or 3 numbers separated by commas (e.g., 0,0,0) took down all of the other annotations.

Resolution: VirtualThing will now log the exception from AspectCollection and throw its own exception.

JSDK-56

BaseClient.waitForConnection() appears to always wait for full timeout even if thread is interrupted.

This issue is fixed in this release.

JSDK-220 (13729338)

Java SDK disconnects and then cannot reconnect to the platform.

The Java SDK now reconnects when a number of consecutive timeouts occur. You can call ClientConfigurator.setTimeoutCountReconnectionThreshold to configure the number of timeouts. Refer too the ThingWorx Edge Java SDK Developer’s Guide, the chapter on Troubleshooting, for information about configuring the consecutive timeouts.

JSDK-18

The method, VirtualThing.updateSubscribedProperties, does not throw the exception, java.util.conccurrent.TimeoutException, when a timeout occurs.

This issue is fixed in this release.

Provided in the VirtualThing.java file are the two methods that were modified to resolve this issue — updateSubscribedProperties(int) and updateSubscribedEvents(int). More specifically:

EDGE-2078

Java-based edge client ignores proxy settings. This issue is fixed in this release.