8.3. Release notes

8.3.1. 1.3.3 Release goal

Maintenance release. Upgrade notes

All APIs have been upgraded and do not contain any breaking change. 1.2.x and 1.3.x APIs will work with 1.3.3 engines. However, everyone is strongly encouraged to upgrade.

No database modification in this release - upgrade can be done by simply replacing engine files. Major

  • Admin UI: the history page was enhanced with more filters including date filters.
  • Engine: the Unix/Linux startup script was modified so as to kill automatically the engine when an OutOfMemoryError occurs. This can be overridden with environment variables. Minor

  • CLI: XML schema of deployment descriptors is now validated on installations (was disabled previously due to issues on IBM J9 JVM).
  • Client API: files downloaded are now briefly stored in the system temp directory instead of a subdirectory. This makes it easier to have multiple JQM engines running with different accounts on the same server.
  • Client API: can now filter by node name.
  • Engine: highlander status is now correctly archived in the history table (used to be always false).

8.3.2. 1.3.2 Release goal

Maintenance release. Upgrade notes

All APIs have been upgraded and do not contain any breaking change. 1.2.1 & 1.2.2 and 1.3.1 apis will work with 1.3.2 engines. However, as 1.2.2 contains fixes and 1.3.1 new functionalities, everyone is strongly encouraged to upgrade.

No database modification in this release - upgrade can be done by simply replacing engine files. Major

Nothing. Minor

  • Engine: added a JDBC connection leak hunter to prevent some leak cases
  • CLI: added a CLI option to modify an administration JQM user
  • GUI: fixed randomly hidden JNDI resource parameters
  • Client API: fixed hedge case in which a job instance may not be found by getJob()
  • Providers: fixed print job name and added option to specify requesting user name

8.3.3. 1.3.1 Release goal

This release had one goal: reducing the need for engine restart. Other administration usability tweaks are also included. Upgrade notes

All APIs have been upgraded and do not contain any breaking change. 1.2.1 & 1.2.2 apis will work with 1.3.1 engines. However, as 1.2.2 contains fixes and 1.3.1 new functionalities, everyone is strongly encouraged to upgrade.

Database must be rebuilt for version 1.3.1, this means History purge. Major

  • Engine: will automatically reload some parameters when they change, reducing the need for engine restarts
  • Engine: now resists better database failures
  • Engine API: shouldKill method is now throttled, reducing the database hammering (as this method is called by all other methods)
  • Admin API: added a method to retrieve the engine logs
  • Client API & GUI: can now download files created by a job instance even if it has not finished yet Minor

  • Engine: added sample purge job
  • GUI: added an online log viewer for job instance logs (no need to download log files anymore)
  • GUI: added an online log viewer for engine logs (which were not retrievable through the GUI before)
  • GUI: allowed column resize on History panel
  • GUI: added an option to view only KO job instances
  • Engine: small code refactor

8.3.4. 1.2.2 Release goal

This is a maintenance release, containing mostly bugfixes and very few new features that could not be included in the previous version (mostly administration GUI tweaks). Upgrade notes

All APIs have been upgraded and do not contain any breaking change. 1.2.1 apis will work with 1.2.2 engines. However, as 1.2.2 contains fixes, everyone is strongly encouraged to upgrade.

Database must be rebuilt for version 1.2.2, this means History purge. Major

  • Engine: can now resist a temporary database failure Minor

  • Engine: access log now logs failed authentications
  • Engine: various minor bugfix in extreme performance scenarios
  • Engine: there is now one log file per node
  • Client API: various fixes
  • Client API: now support retrieval of running job instance logs
  • GUI: various minor improvements
  • CLI: jobdef reimport fixes
  • Tests: major refactoring with 3x less Maven artifacts

8.3.5. 1.2.1 Release goal

The main goal of this release was to simplify the use of JQM. First for people who dislike command line interfaces, by adding a graphical user interface both for administration and for daily use (enqueue, check job status, etc). Second, for payload developers by adding a few improvements concerning testing and reporting. Upgrade notes

All APIs have been upgraded and do not contain any breaking change. Please note that the only version that will work with engine and database in version 1.2.1 is API version 1.2.1: upgrade is compulsory.

Database must be rebuilt for version 1.2.1, this means History purge. Major

  • Client API: Added a fluid version of the JobRequest API
  • GUI: Added an administration web console (present in the standard package but disabled by default)
  • All APIs: Added an authentication system for all web services, with an RBAC back-end and compatible with HTTP authentication as well as SSL certificate authentication
  • Tests: Added a payload unit tester
  • General: Added mail session JNDI resource type Minor

  • Client API: Client APIs file retrieval will now set a file name hint inside an attachment header
  • Client API: Added an IN option for applicationName in Query API
  • Client API: Query API optimization
  • Engine: Unix/Linux launch script is now more complete and robust (restart works!)
  • Engine: JAVA_OPTS environment variable is now used by the engine launch script
  • Engine: Added special “serverName” JNDI String resource
  • Engine: All automatic messages (was enqueued, has begun...) were removed as they provided no information that wasn’t already available
  • Engine: In case of crash, a job instance now creates a message containing “Status changed: CRASHED due to ” + first characters of the stacktrace
  • Engine: Log levels and content were slightly reviewed (e.g.: stacktrace of a failing payload is now INFO instead of DEBUG)
  • Engine API: Added more methods to the engine API (JobManager)
  • Tests: Refactored all engine tests
  • Documentation: clarified class loading structure
  • Documentation: general update. Please read the doc. Thanks!
  • General: Jobs can now easily be disabled

8.3.6. 1.1.6 Release goal

This release was aimed at making JQM easier to integrate in production environments, with new features like JMX monitoring, better log file handling, JDBC connection pooling, etc.

A very few developer features slipped inside the release. Upgrade notes

No breaking changes.

Compatibility matrix:

Version 1.1.6 / Other version Engine Client API Engine API
Engine   >= 1.1.4 >= 1.1.4
Client API == 1.1.6    
Engine API >= 1.1.5    

How to read the compatibility matrix: each line corresponds to one JQM element in version 1.1.6. The different versions given correspond to the minimal version of other components for version 1.1.6 to work. A void cell means there is no constraint between these components.

For exemple : a payload using engine API 1.1.6 requires at least an engine 1.1.5 to work. Major

  • Documentation: now in human readable form and on https://jqm.readthedocs.org
  • Distribution: releases now published on Maven Central, snapshots on Sonatype OSSRH.
  • Engine: added JDBC connection pooling
  • Engine: added JMX monitoring (local & remote on fixed ports). See http://jqm.readthedocs.org/en/latest/admin/jmx.html for details
  • Engine: each job instance now has its own logfile
  • Engine: it is now impossible to launch two engines with the same node name (prevent startup cleanup issues creating data loss)
  • Engine: failed job requests due to engine kill are now reported as crashed jobs on next engine startup
  • Engine: added UrlFactory to create URL JNDI resources
  • Engine: dependencies/libs are now reloaded when the payload jar file is modified or lib folder is modified. No JQM restart needed anymore. Minor

  • Engine API: legacy JobBase class can now be inherited through multiple levels
  • Engine: incomplete payload classes (missing parent class or lib) are now correctly reported instead of failing silently
  • Engine: refactor of main engine classes
  • Engine: races condition fixes in stop sequence (issue happening only in JUnit tests)
  • Engine: no longer any permanent database connection
  • Engine: Oracle db connections now report V$SESSION program, module and user info
  • Engine: logs are less verbose, default log level is now INFO, log line formatting is now cleaner and more readable
  • General: Hibernate minor version upgrade due to major Hibernate bugfixes
  • General: cleaned test build order and artifact names

8.3.7. 1.1.5 Release goal

Bugfix release. Upgrade notes

No breaking changes. Major

Nothing Minor

  • Engine API: engine API enqueue works again
  • Engine API: added get ID method
  • Db: index name shortened to please Oracle

8.3.8. 1.1.4 Release goal

This release aimed at fulfilling all the accepted enhancement requests that involved breaking changes, so as to clear up the path for future evolutions. Upgrade notes

Many breaking changes in this release in all components. Upgrade of engine, upgrade of all libraries are required plus rebuild of database. There is no compatibiliy whatsoever between version 1.1.4 of the libraries and previous versions of the engine and database.

Please read the rest of the release notes and check the updated documentation at https://github.com/enioka/jqm/blob/master/doc/index.md Major

  • Documentation: now fully on Github

  • Client API: - breaking - is no longer static. This allows:
    • to pass it parameters at runtime
    • to use it on Tomcat as well as full EE6 containers without configuration changes
    • to program against an interface instead of a fully implemented class and therefore to have multiple implementations and less breaking changes in the times to come
  • Client API: - breaking - job instance status is now an enum instead of a String

  • Client API: added a generic query method

  • Client API: added a web service implementation in addition to the Hibernate implementation

  • Client API: no longer uses log4j. Choice of logger is given to the user through the slf4j API (and still works without any logger).

  • Client API: in scenarios where the client API is the sole Hibernate user, configuration was greatly simplified without any need for a custom persistence.xml

  • Engine: can now run as a service in Windows.

  • Engine: - breaking - the engine command line, which was purely a debug feature up to now, is officialized and was made usable and documented.

  • Engine API: now offers a File resource through the JNDI API

  • Engine API: payloads no longer need to use the client or engine API. A simple static main is enough, or implementing Runnable. Access to the API is done through injection with a provided interface.

  • Engine API: added a method to provide a temporary work directory Minor

  • Engine: various code refactoring, including cleanup according to Sonar rules.
  • Engine: performance enhancements (History is now insert only, classpaths are truly cached, no more unzipping at every launch)
  • Engine: can now display engine version (CLI option or at startup time)
  • Engine: web service now uses a random free port at node creation (or during tests)
  • Engine: node name and web service listeing DNS name are now separate notions
  • Engine: fixed race condition in a rare high frequency scenario
  • Engine: engine will now properly crash when Jetty fails to start
  • Engine: clarified CLI error messages when objects do not exist or when database connection cannot be established
  • Engine: - breaking - when resolving the dependencies of a jar, a lib directory (if present) now has priority over pom.xml
  • Engine tests: test fixes on non-Windows platforms
  • Engine tests: test optimization with tests no longer waiting an arbitrary amount of time
  • Client API: full javadoc added
  • Engine API: calling System.exit() inside payloads will now throw a security ecveption (not marked as breaking as it was already forbidden)
  • General: - breaking - tags fields (other1, other2, ...) were renamed “keyword” to make their purpose clearer
  • General: packaging now done with Maven

8.3.9. 1.1.3 Release goal

Fix release for the client API. Major

  • No more System.exit() inside the client API. Minor