What's New in CUBA Platform 6.5?

DZone 's Guide to

What's New in CUBA Platform 6.5?

With the release of CUBA 6.5, load balancing with middleware tiers has been improved, entity listeners for Groovy can be scaffolded, and you can distribute via Uber JARs.

· Java Zone ·
Free Resource

As you already might have noticed we have published the new release of the CUBA platform and Studio. The new version mostly introduces enhancements of the existing functionality, however, there are a few useful features have been included in 6.5.

This article covers the major enhancements of Platform and Studio. The full list of changes is available in the corresponding release notes:

Uber JAR

Let me start with a long-awaited aspect, according to the inquiries we get from the community.

With v6.5, the distribution of your CUBA applications becomes trivial with support for the Uber JAR feature. Now, you can simply specify the configuration in CUBA Studio or your IDE and build JARs in a few clicks.

To start the application you only need to run two statements from the command line:

  • java -jar app-core.jar

  • java -jar app.jar

The Uber JAR encapsulates all required dependencies as well as a lightweight HTTP Server. More information can be found in this chapter of our documentation.

Predictive Search UI Component

The collection of visual components is replenished with SuggestionPickerField. The component is designed to perform searches in the background, popping up a list of suggested values during user input.

Detailed information about the use of SuggestionPickerField is available in the documentation as well as the link to a live demo in the Sampler application.

REST API Versioning

During the post-delivery support stage, due to simple refactoring of entities/attributes names, the generic REST API might no longer be compatible with old clients (e.g. mobile apps) or third-party integrations.

The new version has introduced the mechanism of REST request transformation. Now, transformation rules can be defined in a simple XML format, explaining what naming should be applied over the requests from the old clients.

So, if we rename the OldOrder entity to NewOrder as well as its date attribute to deliveryDate and delete the discount field, using the following transformation XML, we can keep compatibility with the clients that use the old API:

<?xml version="1.0"?> 
<transformations xmlns="http://schemas.haulmont.com/cuba/rest-json-transformations.xsd">
  <transformation modelVersion="1.0"
    <renameAttribute oldName="date" currentName="deliveryDate"/>
      <removeAttribute name="discount"/>

Learn more about this feature in the documentation.

Load Balancing in Clusters

Before 6.5, there was no proper balancing between web and middleware tiers. So, a web block was choosing a middleware server from the list specified in the cuba.connectionUrlList at startup and didn’t change it until it became unavailable.

Now the balancing applies on the level of a user session. A middleware server is being chosen randomly during the first remote connection. An established session is "sticky", so it keeps the same middleware server for its whole lifetime. If a request is sent from the anonymous session or without any session, the "sticky session" approach is not applied and the request goes a random server in the cluster.

In some certain cases, you might need to define your own balancing rules. That can be achieved by providing a custom implementation of the the cuba_ServerSorter bean, which, by default, uses the RandomServerSorter class.

ZooKeeper Application Component

With the help of this application component, cluster configuration management is hugely simplified. The component integrates your application with Apache ZooKeeper — a centralized service for maintaining configuration information. The only thing you need to do to manage the cluster topology is to specify the address of ZooKeeper. With that done, middleware servers will publish their addresses via the ZooKeeper directory, and the discovery mechanisms provided by the application component will request ZooKeeper for addresses of available servers. If a middleware server goes down, it will be automatically removed from the directory immediately or after a timeout.

The source code of the application component is available on GitHub along with documentation available in README. Its binary artifacts are published in the standard CUBA repositories.

Polymer UI

According to the activity on the support forum, more and more people have started using our integration with the Polymer framework. In this release, we have added a few features, intended to make development more straightforward.

First of all, now, when calling an entity instance for editing from a list, it will route you to an editing form, located at another URL. This approach enables the standard browser mechanism of history tracking, so you will be able to move between a list and an editor by clicking the go back and go forward buttons in your browser. Another use of this feature is that you can share a link for some certain entity editor with other users, so they can open this screen directly by calling the link.

The next feature is the cuba-lookup component. It allows users to specify an entity instance for a reference attribute — not from a dropdown list, but from a pop-up screen (lookup screen) with the list of entities. Find more information on this web component here.

Finally, there is a new element available in the library of visual components for the Polymer client. It provides the ability to upload files to the server. Since the file is uploaded, it will be shown as a clickable link, so users can download it. To learn more about this web component, follow this link.

Bean Validation in CUBA Studio

The bean validation mechanism is now supported by the Studio user interface. So, you can specify constraints over attributes as well as messages to be shown when a value doesn't comply with the constraints.

So, to be sure that a string is a valid email address, you just perform a few clicks in the Studio, as it is illustrated in the picture below:

Entity Listeners on Groovy

CUBA Studio now supports scaffolding Entity Listeners in Groovy. Make sure you turned on Groovy Support on the Project properties > Advanced tab. Since it is on, you will be able to choose what language you would prefer to code your Entity Listener with.


Let me thank all proactive members of our community who participated the platform development and helped with testing the release candidate version. We keep our eye on the forum to be in touch with most-requested features and benefits for our community. You are welcome to watch the recorded video here of the live webinar session about the release.

cuba platform, java, rest api, uber jar

Published at DZone with permission of Aleksey Stukalov , DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}