org.pentaho.platform.engine.security.userroledao.ws
Interface IUserRoleWebService

All Known Implementing Classes:

AuthorizationPolicyBasedUserRoleWebService, UserRoleWebService

public interface IUserRoleWebService

This webservice interface may be used in the platform to expose the management of users and roles, it is a webservices compatible concrete form of IUserRoleDao.

Author:

Will Gorman (wgorman@pentaho.com)

Method Summary

boolean	createRole(ProxyPentahoRole proxyRole) creates a new role.
boolean	createUser(ProxyPentahoUser proxyUser) creates a new user.
boolean	deleteRoles(ProxyPentahoRole[] roles) deletes a set of roles.
boolean	deleteUsers(ProxyPentahoUser[] users) deletes a set of users.
ProxyPentahoRole[]	getRoles() returns the list of roles defined in the system
ProxyPentahoRole[]	getRolesForUser(ProxyPentahoUser proxyUser) returns a set of roles for a user
ProxyPentahoUser	getUser(String pUserName) returns the user object based on the username.
UserRoleSecurityInfo	getUserRoleSecurityInfo() This method returns the entire set of users and roles in the system
ProxyPentahoUser[]	getUsers() returns the list of users.
ProxyPentahoUser[]	getUsersForRole(ProxyPentahoRole proxyRole) returns the list of users that have a specific role.
void	setRoles(ProxyPentahoUser proxyUser, ProxyPentahoRole[] assignedRoles) sets the roles for a user.
void	setUsers(ProxyPentahoRole proxyRole, ProxyPentahoUser[] assignedUsers) sets the users for a role.
void	updateRole(String roleName, String description, List<String> usernames) Updates a role object with a new description and set of usernames.
boolean	updateRoleObject(ProxyPentahoRole proxyPentahoRole) This updates the named role's attributes.
boolean	updateUser(ProxyPentahoUser proxyUser) This updates the named user's attributes

Method Detail

createRole

boolean createRole(ProxyPentahoRole proxyRole)
                   throws UserRoleException

creates a new role.

Parameters:

proxyRole -

Returns:

Throws:

UserRoleException

createUser

boolean createUser(ProxyPentahoUser proxyUser)
                   throws UserRoleException

creates a new user.

Parameters:

proxyUser -

Returns:

Throws:

UserRoleException

deleteRoles

boolean deleteRoles(ProxyPentahoRole[] roles)
                    throws UserRoleException

deletes a set of roles.

Parameters:

roles -

Returns:

Throws:

UserRoleException

deleteUsers

boolean deleteUsers(ProxyPentahoUser[] users)
                    throws UserRoleException

deletes a set of users.

Parameters:

users -

Returns:

Throws:

UserRoleException

getRoles

ProxyPentahoRole[] getRoles()
                            throws UserRoleException

returns the list of roles defined in the system

Returns:

Throws:

UserRoleException

getRolesForUser

ProxyPentahoRole[] getRolesForUser(ProxyPentahoUser proxyUser)
                                   throws UserRoleException

returns a set of roles for a user

Parameters:

proxyUser -

Returns:

Throws:

UserRoleException

getUser

ProxyPentahoUser getUser(String pUserName)
                         throws UserRoleException

returns the user object based on the username.

Parameters:

pUserName -

Returns:

Throws:

UserRoleException

getUserRoleSecurityInfo

UserRoleSecurityInfo getUserRoleSecurityInfo()
                                             throws UserRoleException

This method returns the entire set of users and roles in the system

Returns:

an info object

Throws:

UserRoleException

getUsers

ProxyPentahoUser[] getUsers()
                            throws UserRoleException

returns the list of users.

Returns:

Throws:

UserRoleException

getUsersForRole

ProxyPentahoUser[] getUsersForRole(ProxyPentahoRole proxyRole)
                                   throws UserRoleException

returns the list of users that have a specific role.

Parameters:

proxyRole -

Returns:

Throws:

UserRoleException

updateUser

boolean updateUser(ProxyPentahoUser proxyUser)
                   throws UserRoleException

This updates the named user's attributes

Parameters:

proxyUser -

Returns:

Throws:

UserRoleException

setRoles

void setRoles(ProxyPentahoUser proxyUser,
              ProxyPentahoRole[] assignedRoles)
              throws UserRoleException

sets the roles for a user.

Parameters:

proxyUser -

assignedRoles -

Throws:

UserRoleException

setUsers

void setUsers(ProxyPentahoRole proxyRole,
              ProxyPentahoUser[] assignedUsers)
              throws UserRoleException

sets the users for a role.

Parameters:

proxyRole -

assignedUsers -

Throws:

UserRoleException

updateRoleObject

boolean updateRoleObject(ProxyPentahoRole proxyPentahoRole)
                         throws UserRoleException

This updates the named role's attributes. It is named differently than the IUserRoleDao because of issues with webservice method overloading.

Parameters:

proxyPentahoRole -

Returns:

Throws:

UserRoleException

updateRole

void updateRole(String roleName,
                String description,
                List<String> usernames)
                throws UserRoleException

Updates a role object with a new description and set of usernames.

Parameters:

roleName -

description -

usernames -

Throws:

UserRoleException