org.pentaho.platform.engine.security.acls.voter
Class AbstractPentahoAclVoter

java.lang.Object
  extended by org.pentaho.platform.engine.security.acls.voter.AbstractPentahoAclVoter
All Implemented Interfaces:
IAclVoter, IPentahoInitializer
Direct Known Subclasses:
PentahoAllowAllAclVoter, PentahoBasicAclVoter

public abstract class AbstractPentahoAclVoter
extends Object
implements IAclVoter, IPentahoInitializer


Constructor Summary
AbstractPentahoAclVoter()
           
 
Method Summary
 GrantedAuthority getAdminRole()
          Gets the role used to determine whether someone is the system-manager.
abstract  Authentication getAuthentication(IPentahoSession session)
           
 void init(IPentahoSession session)
          Simplifier for initialization of objects from the PentahoSystem object
 boolean isGranted(IPentahoSession session, GrantedAuthority role)
          Returns true if the user is a member of the specified role
 boolean isPentahoAdministrator(IPentahoSession session)
          Determines whether the user is a super-manager of Pentaho.
 void setAdminRole(GrantedAuthority value)
          Sets the role used to determine whether someone is the system-manager.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.pentaho.platform.api.engine.IAclVoter
getEffectiveAcl, getEffectiveAcls, hasAccess
 

Constructor Detail

AbstractPentahoAclVoter

public AbstractPentahoAclVoter()
Method Detail

getAuthentication

public abstract Authentication getAuthentication(IPentahoSession session)

getAdminRole

public GrantedAuthority getAdminRole()
Description copied from interface: IAclVoter
Gets the role used to determine whether someone is the system-manager.

Specified by:
getAdminRole in interface IAclVoter
Returns:
GrantedAuthority of the role someone must be in to be the system manager.

setAdminRole

public void setAdminRole(GrantedAuthority value)
Description copied from interface: IAclVoter
Sets the role used to determine whether someone is the system-manager.

Specified by:
setAdminRole in interface IAclVoter
Parameters:
value - The GrantedAuthority which someone must be a considered a system manager

init

public void init(IPentahoSession session)
Description copied from interface: IPentahoInitializer
Simplifier for initialization of objects from the PentahoSystem object

Specified by:
init in interface IPentahoInitializer

isPentahoAdministrator

public boolean isPentahoAdministrator(IPentahoSession session)
Description copied from interface: IAclVoter
Determines whether the user is a super-manager of Pentaho. Uses the Manager Role.

Specified by:
isPentahoAdministrator in interface IAclVoter
Returns:
true if the user is a super-manager

isGranted

public boolean isGranted(IPentahoSession session,
                         GrantedAuthority role)
Description copied from interface: IAclVoter
Returns true if the user is a member of the specified role

Specified by:
isGranted in interface IAclVoter
Returns:
true if the user is a member of the specified role