Hitachi Vantara Pentaho Community Wiki
Child pages
  • How to register a new action based security (ABS) permission from a plugin
Skip to end of metadata
Go to start of metadata

To add a new action based security permission, 

Create an implementation of IAuthorizationAction

package org.pentaho.platform.api.engine;

 * Represents a Logical Role name used by some IAuthorizationPolicy implementations. Also known as Action-Based
 * Security
 * User: nbaker Date: 3/19/13
public interface IAuthorizationAction {
   * Get the name of the action
   * @return action name
  String getName();

   * Get the localized display name of action for a specific locale. If null is passed then default locale will be used
   * @param locale
   * @return localized name
  String getLocalizedDisplayName(String locale);

This is an example of a EXECUTE permission implementation. The interface allows a localized name which the implementation fetches in a local


import java.util.ResourceBundle;

import org.pentaho.platform.plugin.kettle.messages.Messages;

public class RepositoryExecuteAction extends AbstractAuthorizationAction {
  public static final String NAME = "org.pentaho.repository.execute";
  ResourceBundle resourceBundle;

  public String getName() {
    return NAME;

  public String getLocalizedDisplayName(String localeString) {
    return Messages.getInstance().getString(NAME);


The last step is to add this new permission in the plugin.spring.xml. In order for the register to work properly,  make sure the ApplicationContextPentahoSystemRegisterer bean class is present in the plugin.spring.xml

  <bean class="org.pentaho.platform.engine.core.system.objfac.spring.ApplicationContextPentahoSystemRegisterer" scope="singleton"/>

  <bean class="">
    <pen:publish as-type="INTERFACES">
        <pen:attr key="priority" value="70"/>

The new permission is now available in the platform. 

The new permission is now available in the platform.

To enforce this newly registered permission you will just need to invoke the isAllowed method on IAuthorizationPolicy

Enforcing new permission
IAuthorizationPolicy authorizationPolicy = PentahoSystem.get(IAuthorizationPolicy.class, PentahoSessionHolder.getSession());

if(!authorizationPolicy.isAllowed(RepositoryExecuteAction.NAME)) {
  throw new IllegalStateException(org.pentaho.platform.plugin.kettle.messages.Messages.getInstance().getErrorString(
      "PdiAction.ERROR_0010_NO_PERMISSION_TO_EXECUTE")); //$NON-NLS-1$
  • No labels