Page Comparison

Introduction

One of the changes in version 4 of Pentaho Data Integration 4.0 is the introduction of services for repositories. To support this new concept, the repository API of PDI associated with Pentaho Data Integration has changed a little bit.

This document describes how you can creates create these repository services and register them to the repository. In addition, this document also explains as to how you can dynamically change the UI based on the repository to which the user is connected to.

Changes to Repository API

To enable the registering of these repository services, we have added some new methods have been added to the repository API. Details on related to these method are described below:

/**
  * Retrieves the current list of of IRepository Services.
  *
  * @return List of repository services
  * @throws KettleException in case something goes horribly wrong.
  */
  public List<Class<? extends IRepositoryService>> getServiceInterfaces() throws KettleException;

  /**
  * Retrieves a given repository service
  * @param  service class name
  * @return repository service
  *
  * @throws KettleException in case something goes horribly wrong.
  */
  public IRepositoryService getService(Class<? extends IRepositoryService> clazz) throws KettleException;

  /**
   * Checks whether a given repository service is available or not
   *
   * @param repository service class that needs to be checked for support
   * @throws KettleException in case something goes horribly wrong.
   */
  public boolean hasService(Class<? extends IRepositoryService> clazz) throws KettleException;

...

To add a new service to repository, create an interface for the service and provide an implementation. This The new service needs to must extend the IRepositoryService. This is a marker interface which that identifies this the new service as a repository service. Once the service is defined, it needs to must register itself in the repository's implementation. In the future we can have this registration done using spring which will even more configurable, registration will be performed using Spring making configuration easier.

Adding service in detail

To explain this we will use an An example of a repository service that provided provides management of access control list for the repository objects . We created an is shown below. An interface for this service which is described below as follows:

public interface IAclManager extends IRepositoryService{
  /**
   * Get the Permissions of a repository object.
   *
   * @param Object Id of the repository object
   * @param forceParentInheriting retrieve the effective ACLs as if 'inherit from parent' were true
   *
   * @return The permissions.
   * @throws KettleException in case something goes horribly wrong
   */
  public ObjectAcl getAcl(ObjectId id, boolean forceParentInheriting) throws KettleException;

  /**
   * Set the Permissions of a repository element.
   *
   * @param Acl object that needs to be set.
   * @param Object Id of a file for which the acl are being set.
   *
   * @throws KettleException in case something goes horribly wrong
   */
  public  void setAcl(ObjectId id, ObjectAcl aclObject) throws KettleException;

}

In a repository's implementation we instantiated the service implementation was instantiated and and register this the service was registered with repository.

IAclManager aclImpl  = new AclManagerImpl();
registerRepositoryService(IAclManager.class, aclImpl);

RegisiterRepositoryService is a convenience method. All this is doing it does is adding the service interface and its implementation in a map. Once the services are registered you can the retrieve these the service by calling the getService method in the Repository API

Associating UISupport to a repository service

If this the new service has a UI component associated to with it, you will be required to create a UISupport class and register it in the UISupportRegistery UISupportRegistry class.

Creating UISupport

The IAclManager service has a UI component and for that we created a UISupport class extending was created that extends the AbstractRepositoryExplorerUISupport class and implemented implements the setup method.

@Override
  protected void setup() {
    overlays.add(new DefaultXulOverlay(
    "org/pentaho/di/ui/repository/repositoryexplorer/xul/acl-enabled-layout-overlay.xul")); //$NON-NLS-1$
    PermissionsController permissionsController = new PermissionsController();
    controllerNames.add(permissionsController.getName());
    handlers.add(permissionsController);
  }

In the setup method we added any all overlays or/and event handlers that this service will haveprovides were added. Finally we need register , the UI Support class must be registered.

Registering UISupport

The UISupport class needs to must register with its corresponding service interface in order to get consumed correctly.

...

Consuming UISupport classes

The UISupport classes gives us 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 access control on its objects then the UI will never expose these features. At present these Currently,  the UI Support objects are being consumed by the repository explorerRepository Explorer.

Finally we need to extend these , you must extend the UISupport object to be applicable to the whole spoon Spoon UI. This will give us a gives you  complete flexibility in add for adding or removing the UI portions from spoonSpoon.