One of the changes in Pentaho Data Integration 4.0 is the introduction of services for repositories. To support this new concept, the repository API associated with Pentaho Data Integration has changed.
This document describes how you can create these repository services and register them to the repository. In addition, this document also explains how you can dynamically change the UI based on the repository to which the user is connected.
Changes to Repository API
To enable the registering of these repository services, some new methods have been added to the repository API. Details related to these method are described below:
Registering services to repository
To add a new service to repository, create an interface for the service and provide an implementation. The new service must extend the IRepositoryService. This is a marker interface that identifies the new service as a repository service. Once the service is defined, it must register itself in the repository's implementation. In the future, registration will be performed using Spring making configuration easier.
Adding service in detail
An example of a repository service that provides user management features for the repository is shown below. An interface for this service is described as follows:
In a repository's implementation the service implementation was instantiated and and the service was registered with repository.
RegisiterRepositoryService is a convenience method. All it does is adding the service interface and its implementation in a map. Once the services are registered you can the retrieve the service by calling the getService method in the Repository API
Associating UISupport to a repository service
The RepositorySecurityManager service has a UI component associated with it. So it is required to create a UISupport class and register it in the UISupportRegistry class.
A UISupport class was created for RepositorySecurityManager service that extends the AbstractRepositoryExplorerUISupport class and implements the setup method.
In the setup method all overlays or/and event handlers that this service provides were added. Finally, the UI Support class must be registered.
The UISupport class must register with its corresponding service interface to get consumed correctly.
Consuming UISupport classes
The UISupport classes give you an opportunity to enable, disable, add, or remove section(s) of UI based on the services offered by a given repository. For example, if a repository does not support user managements feature then the UI will never expose these features. Currently, the UI Support objects are being consumed by the Repository Explorer.
Finally, you must extend the UISupport object to be applicable to the whole Spoon UI. This gives you complete flexibility for adding or removing the UI portions from Spoon.