On this page we want to show you what a modern Apache Isis application looks like.
The screenshots below are taken from the Isis Addons' todoapp example (non ASF), which you are free to fork and use as you will. The corresponding domain classes from which this UI was built can be found here.
The todoapp also integrates with a number of other Isis Addons modules. Because we expect that most apps will end up using one or more of these addons, we’ve chosen to include screenshots of those too.
These screenshots based on Apache Isis 1.13.x.
Let’s start with the basics…
Apache Isis integrates with Apache Shiro. The core framework supports file-based realms, while the Isis Addons security module (non ASF) provides a well-features subdomain of users, roles and permissions against features derived from the Apache Isis metamodel. The example todoapp integrates with the security module.
Apache Isis has lots of features to help you prototype and then fully test your application. One such are fixture scripts, which allow pre-canned data to be installed in the running application. This is great to act as the starting point for identifying new stories; later on when the feature is being implemented, the same fixture script can be re-used within that feature’s integration tests. (More on tests later).
Most of the time the end-user interacts with representations of persistent domain entities, but Apache Isis also supports view models which can aggregate data from multiple sources. The todoapp example uses a "dashboard" view model to list todo items not yet done vs those completed.
In general we recommend to initially focus only on domain entities; this will help drive out a good domain model. Later on view models can be introduced in support of specific use cases.
The screenshot below is of the todoapp’s
ToDoItem domain entity. Like all web pages, this UI is generated at runtime, directly from the domain object itself. There are no controllers or HTML to write.
In addition to the domain entity, Apache Isis allows layout metadata hints to be provided, for example to specify the grouping of properties, the positioning of those groups into columns, the association of actions (the buttons) with properties or collections, the icons on the buttons, and so on. This metadata can be specified either as annotations or in XML form. The benefit of the latter is that it can be updated (and the UI redrawn) without restarting the app.
Any production-ready app will require this metadata but (like the view models discussed above) this metadata can be added gradually on top of the core domain model.
By default properties on domain entities are editable, meaning they can be changed directly. In the todoapp example, the `ToDoItem’s description is one such editable property:
Note that some of the properties are read-only even in edit mode; individual properties can be made non-editable. It is also possible to make all properties disabled and thus enforce changes only through actions (below).
The other way to modify an entity is to an invoke an action. In the screenshot below the
ToDoItem's category and subcategory can be updated together using an action:
There are no limitations on what an action can do; it might just update a single object, it could update multiple objects. Or, it might not update any objects at all, but could instead perform some other activity, such as sending out email or printing a document.
In general though, all actions are associated with some object, and are (at least initially) also implemented by that object: good old-fashioned encapsulation. We sometimes use the term "behaviourally complete" for such domain objects.
As an alternative to placing actions (business logic) on a domain object, it can instead be placed inside a mixin object. When an object is rendered by Apache Isis, the mixin "contributes" its behaviour to the domain object (similar to aspect-oriented traits).
In the screenshot below the highlighted "export as xml" action, the "relative priority" property (and "previous" and "next" actions) the "similar to" collection and the two "as DTO" actions are all contributed by mixins:
The remaining screenshots on this page are for v1.10.0 of the framework, which precedes the support for tabbed views introduced in v1.12.0.
The Apache Isis viewer is implemented using Apache Wicket, and has been designed to be extensible. For example, when a collection of objects is rendered, this is just one of several views, as shown in the selector drop-down:
Similarly the Isis Addons' fullcalendar2 component (non ASF) will render any domain entity (such as
ToDoItem) that implements its
Yet another "view" (though this one is rather simpler) is that provided by the Isis Addons excel component (non ASF). This provides a download button to the table as a spreadsheet:
The screenshot above also shows an "export to Word" action. This is not a view but instead is a (contributed) action that uses the Isis Addons docx module (non ASF) to perform a "mail-merge":
Please note that the Isis Addons are not part of ASF, but they are all licensed under Apache License 2.0 and are maintained by the Apache Isis committers.
As well as providing extensions to the UI, the (non ASF) Isis Addons provide a rich set of modules to support various cross-cutting concerns.
In the security menu is access to the rich set of functionality provided by the Isis Addons security module:
In the prototyping menu is the ability to download a GNU gettext
.po file for translation. This file can then be translated into multiple languages so that your app can support different locales. Note that this feature is part of Apache Isis core (it is not in Isis Addons):
The Isis Addons also provides a module for managing application and user settings. Most apps (the todoapp example included) won’t expose these services directly, but will usually wrap them in their own app-specific settings service that trivially delegates to the settings module’s services:
Of the various Isis Addons, the security module has the most features. One significant feature is the ability to associate users and objects with a "tenancy". The todoapp uses this feature so that different users' list of todo items are kept separate from one another. A user with administrator is able to switch their own "tenancy" to the tenancy of some other user, in order to access the objects in that tenancy:
For more details, see the security module README.
Most of the security module's services are on the security module, which would normally be provided only to administrators. Kept separate is the "me" action:
Assuming they have been granted permissions, this allows a user to access an entity representing their own user account:
If not all of these properties are required, then they can be hidden either using security or though Apache Isis' internal event bus (described below). Conversely, additional properties can be "grafted onto" the user using the contributed properties/collections discussed previously.
Apache Isis' Wicket viewer uses Twitter Bootstrap, which means that it can be themed. If more than one theme has been configured for the app, then the viewer allows the end-user to switch their theme:
The screenshot below shows accessing the Restful Objects representation API accessed through a Chrome plugin:
The framework also automatically integrates with Swagger, generating a Swagger spec from the underlying domain object model. From this spec REST clients can be code-generated; it also allows developers to play with the REST API through the Swagger UI:
Earlier on we noted that Apache Isis allows fixtures to be installed through the UI. These same fixture scripts can be reused within integration tests. For example, the code snippet below shows how the
FixtureScripts service injected into an integration test can then be used to set up data:
The tests themselves are run in junit. While these are integration tests (so talking to a real database), they are no more complex than a regular unit test:
To simulate the business rules enforced by Apache Isis, the domain object can be "wrapped" in a proxy. For example, if using the Wicket viewer then Apache Isis will enforce the rule (implemented in the
ToDoItem class itself) that a completed item cannot have the "completed" action invoked upon it. The wrapper simulates this by throwing an appropriate exception:
Contributions, discussed earlier, are an important tool in ensuring that the packages within your Apache Isis application are decoupled; by extracting out actions the order of dependency between packages can effectively be reversed.
Another important tool to ensure your codebase remains maintainable is Apache Isis' internal event bus. It is probably best explained by example; the code below says that the "complete" action should emit a
Domain service (application-scoped, stateless) can then subscribe to this event:
And this test verifies that completing an action causes the subscriber to be called:
In fact, the domain event is fired not once, but (up to) 5 times. It is called 3 times prior to execution, to check that the action is visible, enabled and that arguments are valid. It is then additionally called prior to execution, and also called after execution. What this means is that a subscriber can in either veto access to an action of some publishing object, and/or it can perform cascading updates if the action is allowed to proceed.
Moreover, domain events are fired for all properties and collections, not just actions. Thus, subscribers can therefore switch on or switch off different parts of an application. Indeed, the example todoapp demonstrates this.