API Changes in Structure 4.6

1. Minor Java API Release

There are a few API additions coming with this release. The changes are backwards-compatible, so any code using API 16.x should work fine.

See Structure API Versions for full version information and downloads.

2. Compatible Changes in the Java API

2.1. Automation timeout

We have added two new methods to notify Structure API users that the generation of a structure was stopped due to a timeout:

• ForestSource.getHealth()
• VersionedForestUpdate.getHealth()

These methods return a ForestSourceHealthStatus object, and its isStopped() method returns true if generation was stopped.

StructureErrors.AUTOMATION_FAILED is a new error which may be thrown when automation is paused and there is no way to return a health status object.

We have also added a new method named isStopped() to the GenerationContext interface. If you implement your own generators, we advise you to check this method before potentially long-running operations and inside loops, and return control back to Structure if it returns true.

2.2. Convenience methods in StructurePropertyService

We have added two new methods to the StructurePropertyService interface:

• getLong(long, String) returns the property value as a long;
• setValue(long, String, long) sets the property to the given long value.

2.3. @Internal components and classes

Two interfaces have been moved from Structure core to a new API package, com.almworks.jira.structure.api.statistics, for consumption by other ALM Works products. They are not intended to be used by third-party developers at this point.