Package org.pentaho.platform.security.policy.rolebased

Interface IRoleAuthorizationPolicyRoleBindingDao

All Known Implementing Classes:

AbstractJcrBackedRoleBindingDao, JcrRoleAuthorizationPolicyRoleBindingDao

public interface IRoleAuthorizationPolicyRoleBindingDao

Associates (binds) logical roles with runtime roles.

Author:

mlowery

Method Summary

Modifier and Type	Method	Description
List<String>	getBoundLogicalRoleNames(List<String> runtimeRoleNames)	Gets the logical roles bound to the given runtime roles.
List<String>	getBoundLogicalRoleNames(javax.jcr.Session session, List<String> runtimeRoleNames)	This was added to decouple PentahoEntryCollector Gets the logical roles bound to the given runtime roles.
List<String>	getBoundLogicalRoleNames(javax.jcr.Session session, org.pentaho.platform.api.mt.ITenant tenant, List<String> runtimeRoleNames)	This was added to decouple PentahoEntryCollector Gets the logical roles bound to the given runtime roles in a particular tenant.
List<String>	getBoundLogicalRoleNames(org.pentaho.platform.api.mt.ITenant tenant, List<String> runtimeRoleNames)	Gets the logical roles bound to the given runtime roles in a particular tenant.
RoleBindingStruct	getRoleBindingStruct(String locale)	Gets a struct-like object that contains everything known by this DAO.
RoleBindingStruct	getRoleBindingStruct(org.pentaho.platform.api.mt.ITenant tenant, String locale)	Gets a struct-like object that contains everything known by this DAO for a given tenant.
void	setRoleBindings(String runtimeRoleName, List<String> logicalRolesNames)	Sets the bindings for the given runtime role.
void	setRoleBindings(org.pentaho.platform.api.mt.ITenant tenant, String runtimeRoleName, List<String> logicalRolesNames)	Sets the bindings for the given runtime role in a particular tenant.

Method Detail

getRoleBindingStruct

RoleBindingStruct getRoleBindingStruct(String locale)

Gets a struct-like object that contains everything known by this DAO. This is a batch operation provided for UIs.

Parameters:

locale - locale, possibly null

Returns:

role binding struct

getRoleBindingStruct

RoleBindingStruct getRoleBindingStruct(org.pentaho.platform.api.mt.ITenant tenant,
                                       String locale)

Gets a struct-like object that contains everything known by this DAO for a given tenant. This is a batch operation provided for UIs.

Parameters:

tenant -

locale -

Returns:

role binding struct

setRoleBindings

void setRoleBindings(String runtimeRoleName,
                     List<String> logicalRolesNames)

Sets the bindings for the given runtime role. All other bindings for this runtime role are removed.

Parameters:

runtimeRoleName - runtime role name

logicalRoleNames - list of logical role names

setRoleBindings

void setRoleBindings(org.pentaho.platform.api.mt.ITenant tenant,
                     String runtimeRoleName,
                     List<String> logicalRolesNames)

Sets the bindings for the given runtime role in a particular tenant. All other bindings for this runtime role are removed.

Parameters:

tenant -

runtimeRoleName -

logicalRolesNames -

getBoundLogicalRoleNames

List<String> getBoundLogicalRoleNames(List<String> runtimeRoleNames)

Gets the logical roles bound to the given runtime roles. Note that the size of the incoming list might not match the size of the returned list. This is a convenience method. The same result could be obtained from #getRoleBindingStruct().

Parameters:

runtimeRoleNames - list of runtime role names

Returns:

list of logical role names, never null

getBoundLogicalRoleNames

List<String> getBoundLogicalRoleNames(org.pentaho.platform.api.mt.ITenant tenant,
                                      List<String> runtimeRoleNames)

Gets the logical roles bound to the given runtime roles in a particular tenant. Note that the size of the incoming list might not match the size of the returned list. This is a convenience method. The same result could be obtained from #getRoleBindingStruct().

Parameters:

tenant -

runtimeRoleNames - list of runtime role names

Returns:

list of logical role names, never null

getBoundLogicalRoleNames

List<String> getBoundLogicalRoleNames(javax.jcr.Session session,
                                      List<String> runtimeRoleNames)
                               throws javax.jcr.RepositoryException

This was added to decouple PentahoEntryCollector Gets the logical roles bound to the given runtime roles. Note that the size of the incoming list might not match the size of the returned list. This is a convenience method. The same result could be obtained from #getRoleBindingStruct().

Parameters:

runtimeRoleNames - list of runtime role names

Returns:

list of logical role names, never null

Throws:

javax.jcr.RepositoryException

getBoundLogicalRoleNames

List<String> getBoundLogicalRoleNames(javax.jcr.Session session,
                                      org.pentaho.platform.api.mt.ITenant tenant,
                                      List<String> runtimeRoleNames)
                               throws javax.jcr.RepositoryException

This was added to decouple PentahoEntryCollector Gets the logical roles bound to the given runtime roles in a particular tenant. Note that the size of the incoming list might not match the size of the returned list. This is a convenience method. The same result could be obtained from #getRoleBindingStruct().

Parameters:

tenant -

runtimeRoleNames - list of runtime role names

Returns:

list of logical role names, never null

Throws:

javax.jcr.RepositoryException