Uses of Interface
org.pentaho.platform.api.mt.ITenant

Packages that use ITenant

Package	Description
org.pentaho.platform.api.engine
org.pentaho.platform.api.engine.security.userroledao
org.pentaho.platform.api.mt
org.pentaho.platform.api.repository2.unified

Uses of ITenant in org.pentaho.platform.api.engine

Methods in org.pentaho.platform.api.engine with parameters of type ITenant

Modifier and Type	Method and Description
List<String>	IUserRoleListService.getAllRoles(ITenant tenant) Returns all authorities known to the provider for a given tenant.
List<String>	IUserRoleListService.getAllUsers(ITenant tenant) Returns all user names known to the provider for a given tenant.
List<String>	IUserRoleListService.getRolesForUser(ITenant tenant, String username) Returns all authorities granted for a specified user.
List<String>	IUserRoleListService.getUsersInRole(ITenant tenant, String role) Returns all known users in the specified role.

Uses of ITenant in org.pentaho.platform.api.engine.security.userroledao

Methods in org.pentaho.platform.api.engine.security.userroledao that return ITenant

Modifier and Type	Method and Description
ITenant	IPentahoRole.getTenant()
ITenant	IPentahoUser.getTenant()

Methods in org.pentaho.platform.api.engine.security.userroledao with parameters of type ITenant

Modifier and Type	Method and Description
IPentahoRole	IUserRoleDao.createRole(ITenant tenant, String roleName, String description, String[] memberUserNames) Create a role under a specified tenant.
IPentahoUser	IUserRoleDao.createUser(ITenant tenant, String username, String password, String description, String[] roles) Creates user under a specified tenant.
IPentahoRole	IUserRoleDao.getRole(ITenant tenant, String name) Retrieves the role with a given name from the specified tenant.
List<IPentahoUser>	IUserRoleDao.getRoleMembers(ITenant tenant, String roleName) Retrieves the list of users associated to a particular role in a given tenant.
List<IPentahoRole>	IUserRoleDao.getRoles(ITenant tenant) Retrieve all the role from the specified tenant.
List<IPentahoRole>	IUserRoleDao.getRoles(ITenant tenant, boolean includeSubtenants) Retrieve all the roles from the specified tenant.
IPentahoUser	IUserRoleDao.getUser(ITenant tenant, String name) Retrieve the user from a specified tenant of the repository.
List<IPentahoRole>	IUserRoleDao.getUserRoles(ITenant tenant, String userName) Retrieves the list of roles associated to a particular user in a given tenant.
List<IPentahoUser>	IUserRoleDao.getUsers(ITenant tenant) Retrieve all the users from the specified tenant of a repository.
List<IPentahoUser>	IUserRoleDao.getUsers(ITenant tenant, boolean includeSubtenants) Retrieve all the users from the specified tenant of a repository .
void	IUserRoleDao.setPassword(ITenant tenant, String userName, String password) Update the password of an existing user under a specified tenant.
void	IUserRoleDao.setRoleDescription(ITenant tenant, String roleName, String description) Update the role description of a given role under a specific tenant.
void	IUserRoleDao.setRoleMembers(ITenant tenant, String roleName, String[] memberUserNames) Assign list of user names to a particular role in a specified tenant.
void	IUserRoleDao.setUserDescription(ITenant tenant, String userName, String description) Update the user description of an existing user under a speficied tenant.
void	IUserRoleDao.setUserRoles(ITenant tenant, String userName, String[] roles) Assign a list of roles to a particular user in a specified tenant.

Uses of ITenant in org.pentaho.platform.api.mt

Methods in org.pentaho.platform.api.mt that return ITenant

Modifier and Type	Method and Description
ITenant	ITenantManager.createTenant(ITenant parentTenant, String tenantName, String tenantAdminRoleName, String authenticatedRoleName, String anonymousRoleName)
ITenant	ITenantedPrincipleNameResolver.getTenant(String principleId) Extracts the tenant from the principleId.
ITenant	ITenantManager.getTenant(String tenantId)
ITenant	ITenantManager.getTenantByRootFolderPath(String tenantRootFolderPath)

Methods in org.pentaho.platform.api.mt that return types with arguments of type ITenant

Modifier and Type	Method and Description
List<ITenant>	ITenantManager.getChildTenants(ITenant parentTenant) Gets children tenants of the "parent" tenant.
List<ITenant>	ITenantManager.getChildTenants(ITenant parentTenant, boolean includeDisabledTenants) Gets children tenants of the "parent" tenant.

Methods in org.pentaho.platform.api.mt with parameters of type ITenant

Modifier and Type	Method and Description
ITenant	ITenantManager.createTenant(ITenant parentTenant, String tenantName, String tenantAdminRoleName, String authenticatedRoleName, String anonymousRoleName)
RepositoryFile	ITenantManager.createUserHomeFolder(ITenant tenant, String username) Creates users home folder.
void	ITenantManager.deleteTenant(ITenant tenant) Deletes the tenant
void	ITenantManager.enableTenant(ITenant tenant, boolean enable) Enables/disables the tenant with the paths of tenantPath
List<ITenant>	ITenantManager.getChildTenants(ITenant parentTenant) Gets children tenants of the "parent" tenant.
List<ITenant>	ITenantManager.getChildTenants(ITenant parentTenant, boolean includeDisabledTenants) Gets children tenants of the "parent" tenant.
String	ITenantedPrincipleNameResolver.getPrincipleId(ITenant tenant, String principalName) Constructs a principle ID from tenant and principle name.
RepositoryFile	ITenantManager.getTenantRootFolder(ITenant tenant)
RepositoryFile	ITenantManager.getUserHomeFolder(ITenant tenant, String username) Retrieves users home folder.
boolean	ITenantManager.isSubTenant(ITenant parentTenant, ITenant descendantTenant)

Method parameters in org.pentaho.platform.api.mt with type arguments of type ITenant

Modifier and Type	Method and Description
void	ITenantManager.deleteTenants(List<ITenant> tenantPaths) Deletes a list of tenants
void	ITenantManager.enableTenants(List<ITenant> tenantPaths, boolean enable) Enables/disables the tenants with paths in the tenantPaths list

Uses of ITenant in org.pentaho.platform.api.repository2.unified

Methods in org.pentaho.platform.api.repository2.unified with parameters of type ITenant

Modifier and Type	Method and Description
void	IBackingRepositoryLifecycleManager.newTenant(ITenant tenant) To be called before any users belonging to a particular tenant interact with the backing repository.
void	IBackingRepositoryLifecycleManager.newUser(ITenant tenant, String username) To be called before user indicated by username interacts with the backing repository.