From v1.16.x to 2.0.0-M1

Meta annotations

Most of the Apache Isis annotations can now be associated with meta-annotations. Coupled with the fact that DataNucleus 5.x also supports meta annotations, this therefore allows a degree of reuse.

For example, instead of:

@Column(length=30)
@Property(regex=...)
@Getter @Setter
private String name;

public Customer updateName(
    @Parameter(maxLength=30, regex=...)
    String name ) {
    setName(name);
}

we can instead define a @Name annotation:

@Column(length=30)
@Property(regex=...)
@Parameter(maxLength=30, regex=...)
public @interface @Name {}

and then use this annotation:

@Name
@Getter @Setter
private String name;

public Customer updateName(
    @Name
    String name ) {
    setName(name);
}

The full list of Apache Isis annotations that can be used in meta-annotations is shown in the table below.

Table 1. Apache Isis annotations that can be used in meta-annotations
	Domain layer	UI layer
domain service	@DomainService	@DomainServiceLayout
domain object	@DomainObject @ViewModel @MemberGroupLayout	@DomainObjectLayout @ViewModelLayout
Action	@Action	@ActionLayout
action parameter	@Parameter	@ParameterLayout
property	@Property	@PropertyLayout
collection	@Collection	@CollectionLayout

Updated annotations

Prior to v2.0.0, several annotation attributes were defined as booleans. In order to support meta annotations, these have been replaced by enums which also include a NOT_SPECIFIED value. Other enums have been extended (where necessary) to also have a NOT_SPECIFIED value. In all cases NOT_SPECIFIED is the new default.

Table 2. Updated annotations
Annotation	Updated attribute	Nature of change
@Action	command	Default changed from `AS_CONFIGURED` to `NOT_SPECIFIED`.
	hidden	Default changed from `NOWHERE` to `NOT_SPECIFIED`.
	invokeOn	Default changed from `OBJECT_ONLY` to `NOT_SPECIFIED`.
	publishing	Default changed from `AS_CONFIGURED` to `NOT_SPECIFIED`.
	publishing	Default changed from `AS_CONFIGURED` to `NOT_SPECIFIED`.
	restrictTo	Default changed from `NO_RESTRICTIONS` to `NOT_SPECIFIED`.
	semantics	Default changed from `NON_IDEMPOTENT` to `NOT_SPECIFIED`.
@ActionLayout	bookmarking	Default changed from `NEVER` to `NOT_SPECIFIED`.
	contributed	Default changed from `AS_BOTH` to `NOT_SPECIFIED`.
	position	Default changed from `BELOW` to `NOT_SPECIFIED`.
@Collection	hidden	Default changed from `NOWHERE` to `NOT_SPECIFIED`.
@Collection	editing	Default changed from `AS_CONFIGURED` to `NOT_SPECIFIED`.
@DomainObject	auditing	Default changed from `AS_CONFIGURED` to `NOT_SPECIFIED`.
	bounding	Replaces `bounded`, taking values of `BOUNDED`, `UNBOUNDED` and `NOT_SPECIFIED`. Defaults to `NOT_SPECIFIED`.
	editing	Default changed from `AS_CONFIGURED` to `NOT_SPECIFIED`.
	publishing	Default changed from `AS_CONFIGURED` to `NOT_SPECIFIED`.
@DomainObjectLayout	bookmarking	Default changed from `NEVER` to `NOT_SPECIFIED`.
@Parameter	optionality	Default changed from `DEFAULT` to `NOT_SPECIFIED`.
@ParameterLayout	labelPosition	Default changed from `DEFAULT` to `NOT_SPECIFIED`.
@ParameterLayout	renderDay	Replaces `renderedAsDayBefore`, taking values of `AS_DAY`, `AS_DAY_BEFORE` or `NOT_SPECIFIED`. Defaults to `NOT_SPECIFIED`.
@Property	commandReification	Default changed from `AS_CONFIGURED` to `NOT_SPECIFIED`.
	editing	Default changed from `AS_CONFIGURED` to `NOT_SPECIFIED`.
	hidden	Default changed from `NOWHERE` to `NOT_SPECIFIED`.
	snapshot	Replaces `notPersisted`, taking values of `INCLUDED`, `EXCLUDED` or `NOT_SPECIFIED`. Defaults to `NOT_SPECIFIED`.
	optionality	Default changed from `DEFAULT` to `NOT_SPECIFIED`.
	publishing	Default changed from `AS_CONFIGURED` to `NOT_SPECIFIED`.
@PropertyLayout	labelPosition	Default changed from `DEFAULT` to `NOT_SPECIFIED`.
	promptStyle	Default changed from `DEFAULT` to `NOT_SPECIFIED`.
	renderDay	Replaces `notPersisted`, taking values of `AS_DAY`, `AS_DAY_BEFORE` or `NOT_SPECIFIED`. Defaults to `NOT_SPECIFIED`.
	repainting	Replaces `unchanging`, taking values of `REPAINT`, `NO_REPAINT` or `NOT_SPECIFIED`. Defaults to `NOT_SPECIFIED`.
	@ViewModelLayout	bookmarking

Removed annotations/attributes

The following annotations, or attributes of annotations, have been removed

Table 3. Removed annotations/attributes
Annotation	Attribute	Use instead
`@Action`	`publishingPayloadFactory()`	Removed, use the simpler PublisherService SPI instead.
`@ActionInteraction`		@Action#domainEvent()
`@ActionOrder`		@MemberOrder()
`@Aggregated`		Never implemented internally in Isis 1.x so no replacement.
`@Auditable` (JDO applib)		@DomainObject#auditing()
`@Audited`		@DomainObject#auditing()
`@AutoComplete`		@DomainObject#autoComplete()
`@ActionSemantics`		@Action#semantics()
`@Bookmarkable`		@DomainObject#bookmarking()
`@Bounded`		@DomainObject#bounding()
`@Bulk`		@Action#invokeOn() Similarly, the `Bulk.InteractionContext` domain service is replaced with the ActionInvocationContext domain service.
`@Collection`	`notPersisted`	Removed, no replacement.
`@CollectionInteraction`		`@Collection #domainEvent()`
`@CollectionLayout`	`render`	@CollectionLayout#defaultView()
`@Command`		@Action#command()
`@CssClass`		Either @ActionLayout#cssClass(), @PropertyLayout#cssClass(), @CollectionLayout#cssClass(), @ParameterLayout#cssClass(), @DomainObjectLayout#cssClass() or @ViewModelLayout#cssClass().
`@CssClassFa`		Either @ActionLayout#cssClassFa(), @DomainObjectLayout#cssClassFa() or @ViewModelLayout#cssClassFa().
`@Debug`		@Action#restrictTo()
`@DescribedAs`		Either @ActionLayout#describedAs(), @PropertyLayout#describedAs(), @CollectionLayout#describedAs(), @ParameterLayout#describedAs(), @DomainObjectLayout#describedAs() or @ViewModelLayout#describedAs().
`@Disabled`		@Property#editingDisabledReason()
`@DomainObject`	`bounded`	Deleted (was a boolean attribute), replaced by @Property#bounding
`@DomainObject`	`publishingPayloadFactory`	Removed, use the simpler PublisherService SPI instead.
`@Exploration`		@Action#restrictTo()
`@FieldOrder`		@MemberOrder()
`@Hidden`		For actions by either @Action#hidden() or @ActionLayout#hidden(), for properties by either @Property#hidden() or @PropertyLayout#hidden(), for collections by either @Collection#hidden() or @CollectionLayout#hidden().
`@Idempotent`		@Action#semantics()
`@Ignore`		@Programmatic
`@Immutable`		@DomainObject#editing()
`@Mandatory`		Either @Property#optionality() or @Parameter#optionality(). For properties, can also use @Column#allowsNull() Can also use @Nullable for either properties or parameters.
`@Mask`		Removed, never implemented internally in Isis 1.x so no replacement.
`@MaxLength`		Either @Property#maxLength() or @Parameter#maxLength(). For properties, can also use @Column#length()
`@MemberGroups`		.layout.xml file instead.
`@MultiLine`		Either @PropertyLayout#multiLine() or @ParameterLayout#multiLine().
`@MustSatisfy`		Either @Property#mustSatisfy() or @Parameter#mustSatisfy().
`@NotPersisted`		@Property#notPersisted().
`@Optional`		Either @Property#optionality() or @Parameter#optionality(). For properties, can also use @Column#allowsNull() Can also use @Nullable for either properties or parameters.
`@Named`		Either @ActionLayout#named(), @PropertyLayout#named(), @CollectionLayout#named(), @ParameterLayout#named(), @DomainObjectLayout#named() or @ViewModelLayout#named().
`@NotInServiceMenu`		@DomainService#nature() Specify nature of `VIEW_CONTRIBUTIONS_ONLY`. Alternatively, use a mixin.
`@NotContributed`		@DomainService#nature() Specify nature of `VIEW_MENU_ONLY`.
`@NotPersistable`		Never implemented internally in Isis 1.x so no replacement.
`@ObjectType`		Removed, @DomainObject#objectType() or @DomainService#objectType() Alternatively, for domain entities either: the @Discriminator annotation can be specified; the value is used as the object type, or the @PersistenceCapable#schema() can be specified; the value is used as the concatenated with the class name to create a two part object type.
`@Parameter`	`minLength`	Never implemented internally in Isis 1.x so no replacement. Note that the @MinLength annotation is for use with autocomplete supporting methods (specifying the minimum number of characters to enter before an auto-complete search is performed).
`@Paged`		Either @CollectionLayout#paged() (for parented collections), or @DomainObject#paged() (for standalone collections)
`@ParameterLayout`	renderedAsDayBefore	Deleted (was a boolean attribute), replaced by @ParameterLayout#renderDay.
`@Plural`		@DomainObjectLayout#plural()
`@PostsAction InvokedEvent`		@Action#domainEvent()
`@PostsCollection AddedToEvent`		@Collection#domainEvent()
`@PostsCollection RemovedFromEvent`		@Collection#domainEvent()
`@PostsProperty ChangedEvent`		@Property#domainEvent()
`@Property`	`notPersisted`	Removed, replaced with @Property#snapshot()
`@PropertyInteraction`		@Property#domainEvent()
`@PropertyLayout`	`renderedAsDayBefore`	Deleted (was a boolean attribute), replaced by @PropertyLayout#renderDay.
`@PropertyLayout`	`unchanging`	Deleted (was a boolean attribute), replaced by @PropertyLayout#repainting.
`@Prototype`		@Action#restrictTo()
`@PublishedAction`		Removed, use @Action#publishing()
`@PublishedObject`		Removed, use @DomainObject#publishing()
`@PublishingPayload FactoryForAction`		Removed, use the simpler PublisherService SPI instead.
`PublishingPayload FactoryForObject`		Removed, use the simpler PublisherService SPI instead.
`@QueryOnly`		@Action#semantics()
`@Regex`		Either @Property#regexPattern() or @Parameter#regexPattern().
`@Render`		@CollectionLayout#defaultView() Supporting `RenderType` enum also removed.
`@RenderedAs DayBefore`		Either @Property#renderDay() or @Parameter#renderDay().
`@Resolve`		@CollectionLayout#defaultView()
`@SortedBy`		@CollectionLayout#sortedBy()
`@TypeOf`		Either @CollectionLayout#typeOf() (for parented collections), or @ActionLayout#typeOf() (for actions returning a standalone collection).
`@TypicalLength`		@PropertyLayout#typicalLength().

Moved types

The following applib types have been moved.

Table 4. Moved types
Description	Type(s)	From	To
Events emitted by `WrapperFactory` when interactions occur.	`ActionUsabilityEvent`, `PropertyVisibilityEvent`, `CollectionAccessEvent` etc.	`o.a.i.applib.` `events`	`o.a.i.applib.` `services.wrapper.events`
Interface types for mixins	`Timestampable` `HoldsUpdatedAt` `HoldsUpdatedBy`	`o.a.i.applib.` `services.timestamp`	`o.a.i.applib.` `mixins.timestamp`
Interface types for mixins	`Dto`	`o.a.i.applib.` `services.dto`	`o.a.i.applib.` `mixins.dto`
Lifecycle events, domain events & UI events	`AbstractDomainEvent` domain events/subtypes `ObjectXxxEvent` lifecycle events `XxxUiEvent` UI events	o.a.i.applib.services.eventbus	`o.a.i.applib.` `events.domain` `o.a.i.applib.` `events.lifecycle` `o.a.i.applib.` `events.ui`

Removed configuration properties

The following configuration properties are no longer recognised.

Table 5. Removed configuration properties
Configuration property	Description
`isis.persistor. datanucleus. PublishingService. serializedForm`	`PublishingService` has been removed. Use PublisherService instead.

Updated classes

The following classes have been updated.

Table 6. Updated classes
Updated class	Method	Nature of change
`IsisAppModule. ActionDomainEvent`	N-arg constructor	removed; just use the 0-arg ones
`IsisAppModule. CollectionDomainEvent`	N-arg constructor	removed; just use the 0-arg ones
`IsisAppModule. PropertyDomainEvent`	N-arg constructor	removed; just use the 0-arg ones
`FixtureScript`	`asKeyValueMap(String)`	Removed; this shouldn’t have had public visibility.
`FixtureScript`	`execute(…)` `executeChild(…)` `executeIfNotAlready(…)` `run(…)`	All removed or no longer public; use `FixtureScript.ExecutionContext`'s `#executeChild(…)` instead.
`FixtureScript`	`lookup(…)`	Removed; use `FixtureScript.ExecutionContext#lookup(…)` instead.
`FixtureScript. ExecutionContext`	`add(…)`	Removed; use `addResult(…)` instead.
`FixtureScripts`	deprecated constructors	Removed
`FixtureScripts. MultipleExecutionStrategy`	`IGNORE`	Removed, use `EXECUTE_ONCE_PER_CLASS` instead

Removed types

Adapter classes

The following adapter classes have been removed.

Table 7. Removed adapter classes
Removed class	Replaced with
`AbstractContainedObject`	No replacement.
`AbstractDomainObject`	No replacement.
`AbstractFactoryAndRepository`	No replacement.
`AbstractHomePageDashboardService`	No replacement.

Filter classes/interfaces

Also, all classes and interfaces in org.apache.isis.applib.filter have been removed. Instead, the java.util.Predicate<T> interface is used.

For example, RepositoryService#allMatches(…) method, which allows client-side filtering of results (typically during prototyping), now has the signature:

public interface RepositoryService {
    ...
    <T> List<T> allMatches(
                    final Class<T> ofType,
                    final Predicate<? super T> predicate,
                    long... range);

}

Removed interfaces

The following interfaces have been removed.

Table 8. Removed interfaces
Removed interface	Replaced with
`Auditable` (JDO applib)	@DomainObject#auditing()
`Bounded` (JDO applib)	@DomainObject#bounding()
`NotPersistable` (JDO applib)	Never implemented internally in Isis 1.x so no replacement.
`ProgramPersistable` (JDO applib)	Never implemented fully in Isis 1.x so no replacement.
`AlwaysImmutable` (JDO applib)	Never implemented fully in Isis 1.x so no replacement.
`ImmutableOncePersisted` (JDO applib)	Never implemented fully in Isis 1.x so no replacement.
`ImmutableUntilPersisted` (JDO applib)	Never implemented fully in Isis 1.x so no replacement.
`NeverImmutable` (JDO applib)	Never implemented fully in Isis 1.x so no replacement.

Other Changes

View model URLs

The default implementation of UrlEncodingService provided by the framework has changed:

in 1.16.x the implementation is o.a.i.applib.services.urlencoding.UrlEncodingServiceUsingBaseEncoding
in 2.0.0-M1 this is changed to o.a.i.applib.services.urlencoding.UrlEncodingServiceWithCompression

This new implementation increases the state that can be encoded within the URL (approx 8000 characters) by first gzipping the state prior to base64 encoding the characters.

However, this does mean that any persisted URLs for view models will be invalid.

Applib types fully generic

All types in the applib have now been made fully generic

Updated dependencies

Wicket has been upgraded from Wicket 7.9 to Wicket 8.0.

Removed dependencies

The Apache Isis applib (o.a.i.core:isis-core-applib) no longer depends on the google guava library.

Likewise the Apache Isis Unit Test Support module (o.a.i.core:isis-core-unittestsupport) no longer depends on guava either.

Do note however that the core framework does still depend on guava (though the intention is to remove this over time).

New isis-core-commons module

The new org.apache.isis.core:isis-core-commons module provides a set of utility classes that are not API but that are depended upon by the applib.

Because these are not API, they should not be used by application code, even though they will be on the applications classpath.

To help prevent accidental usage:

the package is org.apache.isis.core.commons.internal
all of the types in this module are prefixed "_".

For example, o.a.i.commons.internal.resources._Resource provides utilities for loading static resources from the classpath.

This module performs many of the responsibilities that were previously provided by the dependency on guava.

This module also defines a number of plugin interface types, discussed in the section below.

Plugins

The framework introduces a plugin architecture whereby variations on the configuration are automatically enabled just by the presence of the Maven module on the classpath.

For example, the framework can be run using either DataNucleus 4 or DataNucleus 5. Including the relevant module will configure the rest of the framework accordingly.

The plugin architecture uses the JDK ServiceLoader API, whereby a Maven module can optionally provide an implementation of a well-known plugin interface type.

The plugin interface types themselves are defined in various of the Maven modules, broadly depending on what consumes them.

Table 9. Plugin types
Defined in	Plugin type	Used for	Implementations
`isis-core-commons`	`o.a.i.core.plugins. classdiscovery. ClassDiscoveryPlugin`	Obtain a plugin to finding types on the classpath with certain characteristics, eg annotated with certain annotations Include only one implementation on classpath.	`ClassDiscoveryPluginUsingReflections` uses the `org.reflections` open source library (which depends in turn on guava).
	`o.a.i.core.plugins. codegen. ProxyFactoryPlugin`	Obtain a plugin acting as a factory to proxy types (as used by the `WrapperFactory` domain service). Include only one implementation on classpath,	`o.a.i.core.plugins.codegen. ProxyFactoryPluginUsingByteBuddy` (using ByteBuddy) `o.a.i.core.plugins.codegen. ProxyFactoryPluginUsingJavassist` (using Javassist).
	`o.a.i.core.plugins. eventbus. EventBusPlugin`	Obtain a plugin for finding event bus implementations. This removes the need to explicitly specify the implementation using the `isis.services.eventbus.implementation` config property; it can be left as simply "auto".	`o.a.i.core.plugins.eventbus. EventBusPluginForAxon` (using Axon Framework) `org.apache.isis.core.plugins.eventbus. EventBusPluginForGuava` (using Guava)
`isis-core-metamodel`	`org.apache.isis.core. metamodel.progmodel. ProgrammingModelPlugin`	Obtain plugins that can provide implementations of Isis' own `FacetFactory` SPI (which is used to build up the metamodel). There can be multiple implementations on the classpath.	`org.apache.isis.progmodels. plugins.ProgrammingModelIsisTimePlugin` (in `metamodel-legacy`) contributes facet factories for the applib value types that have been moved to applib-legacy.
	`org.apache.isis.core. metamodel.services. swagger.internal. ValuePropertyPlugin`	Obtain plugins that can provide implementations of Isis' own `ValuePropertyFactory` SPI (which is used to build up Swagger representations). There can be multiple implementations on the classpath.	`o.a.i.core.metamodel. services.swagger.plugins. IsisTimeValuePropertyPlugin` (in `metamodel-legacy`) contributes factories for the applib value types that have been moved to applib-legacy.
	`o.a.i.core. metamodel. IsisJdoMetamodelPlugin`	Decouples the metamodel module from a particular implementation of DataNucleus. Include only one implementation on classpath,	`o.a.i.plugins.jdo.dn4.IsisJdoSupportPlugin4` `o.a.i.plugins.jdo.dn5.IsisJdoSupportPlugin5`
`isis-core-runtime`	`o.a.i.core. metamodel. IsisJdoRuntimePlugin`	Decouples the runtime module from a particular implementation of DataNucleus. Include only one implementation on classpath,	`o.a.i.plugins.jdo.dn4.IsisJdoSupportPlugin4` `o.a.i.plugins.jdo.dn5.IsisJdoSupportPlugin5`
`isis-core-viewer-restfulobjects-applib`	`o.a.i.viewer. restfulobjects. applib.client. UriBuilderPlugin`	Plugin to obtain a `UriBuilder` to create uri templates. Include only one implementation on classpath,	`o.a.i.plugins. jaxrs.resteasy.IsisResteasy3Plugin` or `o.a.i.plugins. jaxrs.resteasy.IsisResteasy4Plugin`
`isis-core-viewer-restfulobjects-server`	`o.a.i.viewer. restfulobjects. server. IsisJaxrsServerPlugin`	Plugin to configure the JAX-RS runtime. Include only one implementation on classpath.	`o.a.i.plugins. jaxrs.resteasy.IsisResteasy3Plugin` or `o.a.i.plugins. jaxrs.resteasy.IsisResteasy4Plugin`

The two JDO/DataNucleus plugins are not independent of each other, because (as the table above shows) the same class implements both plugin interface types. These plugins allow the framework to run either using DataNucleus 4 (JDO 3.1 API) or using DataNucleus 5 (JDO 3.2 API).

Similarly, the two RestfulObjects plugins are also not independent of each other; again the pattern is for a single class implements both plugin interface types. These plugins support alternate implementations of JAX-RS API. JAX-RS 2.0 (one of the JavaEE 7.0 specifications) is implemented by RestEasy 3 whereas JAX-RS 2.1 is implemented by RestEasy 4 (part of JavaEE 8).

IsisJdoSupport domain service

In 1.16.x the IsisJdoSupport domain service exposed the DataNucleus 4 org.datanucleus.query.typesafe.TypesafeQuery type in one of its signatures. However, in DataNucleus 5 this type was removed and replaced by javax.jdo.JDOQLTypedQuery, reflecting the fact that type-safe queries are now part of JDO 3.2.

Consequently in 2.0.0-M1 this API has been split into three:

IsisJdoSupport (defined in isis-core-applib) is independent of JDO APIs
IsisJdoSupport_v3_1 (defined in isis-core-plugins-jdo-datanucleus-4) extends IsisJdoSupport with DataNucleus 4/JDO 3.1-specific APIs
IsisJdoSupport_v3_2 (defined in isis-core-plugins-jdo-datanucleus-5) extends IsisJdoSupport with JDO 3.2-specific APIs

Swagger UI

Swagger UI is now reinstated as a webjar, so there is no need to have any swagger UI files in the webapp (ISIS-1908).