com.liferay.portal.service.impl

Class RoleServiceImpl

java.lang.Object

com.liferay.portal.kernel.service.BaseServiceImpl

com.liferay.portal.service.base.RoleServiceBaseImpl

com.liferay.portal.service.impl.RoleServiceImpl

All Implemented Interfaces:

com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService, com.liferay.portal.kernel.service.BaseService, com.liferay.portal.kernel.service.RoleService

public class RoleServiceImpl
extends RoleServiceBaseImpl

Provides the remote service for accessing, adding, unassigning, checking, deleting, and updating roles. Its methods include permission checks.

Author:

Brian Wing Shun Chan

Field Summary

Fields inherited from class com.liferay.portal.service.base.RoleServiceBaseImpl

counterLocalService, groupPersistence, roleFinder, roleLocalService, rolePersistence, roleService, userPersistence

Fields inherited from class com.liferay.portal.kernel.service.BaseServiceImpl

ANONYMOUS_NAMES, JRUN_ANONYMOUS, ORACLE_ANONYMOUS, SUN_ANONYMOUS, WEBLOGIC_ANONYMOUS

Constructor Summary

Constructors

Constructor and Description
RoleServiceImpl()

Method Summary

Modifier and Type	Method and Description
com.liferay.portal.kernel.model.Role	addRole(java.lang.String className, long classPK, java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int type, java.lang.String subtype, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a role.
void	addUserRoles(long userId, long[] roleIds) Adds the roles to the user.
protected void	checkUserRolesPermission(long userId, long[] roleIds)
void	deleteRole(long roleId) Deletes the role with the primary key and its associated permissions.
com.liferay.portal.kernel.model.Role	fetchRole(long roleId)
protected java.util.List<com.liferay.portal.kernel.model.Role>	filterRoles(java.util.List<com.liferay.portal.kernel.model.Role> roles)
java.util.List<com.liferay.portal.kernel.model.Role>	getGroupRoles(long groupId) Returns all the roles associated with the group.
java.util.List<com.liferay.portal.kernel.model.Role>	getGroupRolesAndTeamRoles(long companyId, java.lang.String keywords, java.util.List<java.lang.String> excludedNames, int[] types, long excludedTeamRoleId, long teamGroupId, int start, int end)
int	getGroupRolesAndTeamRolesCount(long companyId, java.lang.String keywords, java.util.List<java.lang.String> excludedNames, int[] types, long excludedTeamRoleId, long teamGroupId)
com.liferay.portal.kernel.model.Role	getRole(long roleId) Returns the role with the primary key.
com.liferay.portal.kernel.model.Role	getRole(long companyId, java.lang.String name) Returns the role with the name in the company.
java.util.List<com.liferay.portal.kernel.model.Role>	getRoles(int type, java.lang.String subtype)
java.util.List<com.liferay.portal.kernel.model.Role>	getRoles(long companyId, int[] types)
java.util.List<com.liferay.portal.kernel.model.Role>	getUserGroupGroupRoles(long userId, long groupId) Returns all the user's roles within the user group.
java.util.List<com.liferay.portal.kernel.model.Role>	getUserGroupRoles(long userId, long groupId) Returns all the user's roles within the user group.
java.util.List<com.liferay.portal.kernel.model.Role>	getUserRelatedRoles(long userId, java.util.List<com.liferay.portal.kernel.model.Group> groups) Returns the union of all the user's roles within the groups.
java.util.List<com.liferay.portal.kernel.model.Role>	getUserRoles(long userId) Returns all the roles associated with the user.
boolean	hasUserRole(long userId, long companyId, java.lang.String name, boolean inherited) Returns true if the user is associated with the named regular role.
boolean	hasUserRoles(long userId, long companyId, java.lang.String[] names, boolean inherited) Returns true if the user has any one of the named regular roles.
java.util.List<com.liferay.portal.kernel.model.Role>	search(long companyId, java.lang.String keywords, java.lang.Integer[] types, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Role> orderByComparator)
int	searchCount(long companyId, java.lang.String keywords, java.lang.Integer[] types, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
void	unsetUserRoles(long userId, long[] roleIds) Removes the matching roles associated with the user.
com.liferay.portal.kernel.model.Role	updateRole(long roleId, java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String subtype, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the role with the primary key.

Methods inherited from class com.liferay.portal.service.base.RoleServiceBaseImpl

afterPropertiesSet, destroy, getCounterLocalService, getModelClass, getModelClassName, getOSGiServiceIdentifier, getRoleFinder, getRoleLocalService, getRolePersistence, getRoleService, runSQL, setCounterLocalService, setRoleFinder, setRoleLocalService, setRolePersistence, setRoleService

Methods inherited from class com.liferay.portal.kernel.service.BaseServiceImpl

getClassLoader, getGuestOrUser, getGuestOrUserId, getPermissionChecker, getUser, getUserId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RoleServiceImpl

public RoleServiceImpl()

Method Detail

addRole

public com.liferay.portal.kernel.model.Role addRole(java.lang.String className,
                                                    long classPK,
                                                    java.lang.String name,
                                                    java.util.Map<java.util.Locale,java.lang.String> titleMap,
                                                    java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                    int type,
                                                    java.lang.String subtype,
                                                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                             throws com.liferay.portal.kernel.exception.PortalException

Adds a role. The user is reindexed after role is added.

Parameters:

className - the name of the class for which the role is created

classPK - the primary key of the class for which the role is created (optionally 0)

name - the role's name

titleMap - the role's localized titles (optionally null)

descriptionMap - the role's localized descriptions (optionally null)

type - the role's type (optionally 0)

subtype - the role's subtype (optionally null)

serviceContext - the service context to be applied (optionally null). Can set the expando bridge attributes for the role.

Returns:

the role

Throws:

com.liferay.portal.kernel.exception.PortalException

addUserRoles

public void addUserRoles(long userId,
                         long[] roleIds)
                  throws com.liferay.portal.kernel.exception.PortalException

Adds the roles to the user. The user is reindexed after the roles are added.

Parameters:

userId - the primary key of the user

roleIds - the primary keys of the roles

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteRole

public void deleteRole(long roleId)
                throws com.liferay.portal.kernel.exception.PortalException

Deletes the role with the primary key and its associated permissions.

Parameters:

roleId - the primary key of the role

Throws:

com.liferay.portal.kernel.exception.PortalException

fetchRole

public com.liferay.portal.kernel.model.Role fetchRole(long roleId)
                                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getGroupRoles

public java.util.List<com.liferay.portal.kernel.model.Role> getGroupRoles(long groupId)
                                                                   throws com.liferay.portal.kernel.exception.PortalException

Returns all the roles associated with the group.

Parameters:

groupId - the primary key of the group

Returns:

the roles associated with the group

Throws:

com.liferay.portal.kernel.exception.PortalException

getGroupRolesAndTeamRoles

public java.util.List<com.liferay.portal.kernel.model.Role> getGroupRolesAndTeamRoles(long companyId,
                                                                                      java.lang.String keywords,
                                                                                      java.util.List<java.lang.String> excludedNames,
                                                                                      int[] types,
                                                                                      long excludedTeamRoleId,
                                                                                      long teamGroupId,
                                                                                      int start,
                                                                                      int end)

getGroupRolesAndTeamRolesCount

public int getGroupRolesAndTeamRolesCount(long companyId,
                                          java.lang.String keywords,
                                          java.util.List<java.lang.String> excludedNames,
                                          int[] types,
                                          long excludedTeamRoleId,
                                          long teamGroupId)

getRole

public com.liferay.portal.kernel.model.Role getRole(long roleId)
                                             throws com.liferay.portal.kernel.exception.PortalException

Returns the role with the primary key.

Parameters:

roleId - the primary key of the role

Returns:

the role with the primary key

Throws:

com.liferay.portal.kernel.exception.PortalException

getRole

public com.liferay.portal.kernel.model.Role getRole(long companyId,
                                                    java.lang.String name)
                                             throws com.liferay.portal.kernel.exception.PortalException

Returns the role with the name in the company.

The method searches the system roles map first for default roles. If a role with the name is not found, then the method will query the database.

Parameters:

companyId - the primary key of the company

name - the role's name

Returns:

the role with the name

Throws:

com.liferay.portal.kernel.exception.PortalException

getRoles

public java.util.List<com.liferay.portal.kernel.model.Role> getRoles(int type,
                                                                     java.lang.String subtype)
                                                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getRoles

public java.util.List<com.liferay.portal.kernel.model.Role> getRoles(long companyId,
                                                                     int[] types)
                                                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getUserGroupGroupRoles

public java.util.List<com.liferay.portal.kernel.model.Role> getUserGroupGroupRoles(long userId,
                                                                                   long groupId)
                                                                            throws com.liferay.portal.kernel.exception.PortalException

Returns all the user's roles within the user group.

Parameters:

userId - the primary key of the user

groupId - the primary key of the group

Returns:

the user's roles within the user group

Throws:

com.liferay.portal.kernel.exception.PortalException

getUserGroupRoles

public java.util.List<com.liferay.portal.kernel.model.Role> getUserGroupRoles(long userId,
                                                                              long groupId)
                                                                       throws com.liferay.portal.kernel.exception.PortalException

Returns all the user's roles within the user group.

Parameters:

userId - the primary key of the user

groupId - the primary key of the group

Returns:

the user's roles within the user group

Throws:

com.liferay.portal.kernel.exception.PortalException

getUserRelatedRoles

public java.util.List<com.liferay.portal.kernel.model.Role> getUserRelatedRoles(long userId,
                                                                                java.util.List<com.liferay.portal.kernel.model.Group> groups)
                                                                         throws com.liferay.portal.kernel.exception.PortalException

Returns the union of all the user's roles within the groups.

Parameters:

userId - the primary key of the user

groups - the groups (optionally null)

Returns:

the union of all the user's roles within the groups

Throws:

com.liferay.portal.kernel.exception.PortalException

getUserRoles

public java.util.List<com.liferay.portal.kernel.model.Role> getUserRoles(long userId)
                                                                  throws com.liferay.portal.kernel.exception.PortalException

Returns all the roles associated with the user.

Parameters:

userId - the primary key of the user

Returns:

the roles associated with the user

Throws:

com.liferay.portal.kernel.exception.PortalException

hasUserRole

public boolean hasUserRole(long userId,
                           long companyId,
                           java.lang.String name,
                           boolean inherited)
                    throws com.liferay.portal.kernel.exception.PortalException

Returns true if the user is associated with the named regular role.

Parameters:

userId - the primary key of the user

companyId - the primary key of the company

name - the name of the role

inherited - whether to include the user's inherited roles in the search

Returns:

true if the user is associated with the regular role; false otherwise

Throws:

com.liferay.portal.kernel.exception.PortalException

hasUserRoles

public boolean hasUserRoles(long userId,
                            long companyId,
                            java.lang.String[] names,
                            boolean inherited)
                     throws com.liferay.portal.kernel.exception.PortalException

Returns true if the user has any one of the named regular roles.

Parameters:

userId - the primary key of the user

companyId - the primary key of the company

names - the names of the roles

inherited - whether to include the user's inherited roles in the search

Returns:

true if the user has any one of the regular roles; false otherwise

Throws:

com.liferay.portal.kernel.exception.PortalException

search

public java.util.List<com.liferay.portal.kernel.model.Role> search(long companyId,
                                                                   java.lang.String keywords,
                                                                   java.lang.Integer[] types,
                                                                   java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                   int start,
                                                                   int end,
                                                                   com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Role> orderByComparator)

searchCount

public int searchCount(long companyId,
                       java.lang.String keywords,
                       java.lang.Integer[] types,
                       java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)

unsetUserRoles

public void unsetUserRoles(long userId,
                           long[] roleIds)
                    throws com.liferay.portal.kernel.exception.PortalException

Removes the matching roles associated with the user. The user is reindexed after the roles are removed.

Parameters:

userId - the primary key of the user

roleIds - the primary keys of the roles

Throws:

com.liferay.portal.kernel.exception.PortalException

updateRole

public com.liferay.portal.kernel.model.Role updateRole(long roleId,
                                                       java.lang.String name,
                                                       java.util.Map<java.util.Locale,java.lang.String> titleMap,
                                                       java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                       java.lang.String subtype,
                                                       com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                throws com.liferay.portal.kernel.exception.PortalException

Updates the role with the primary key.

Parameters:

roleId - the primary key of the role

name - the role's new name

titleMap - the new localized titles (optionally null) to replace those existing for the role

descriptionMap - the new localized descriptions (optionally null) to replace those existing for the role

subtype - the role's new subtype (optionally null)

serviceContext - the service context to be applied (optionally null). Can set the expando bridge attributes for the role.

Returns:

the role with the primary key

Throws:

com.liferay.portal.kernel.exception.PortalException

checkUserRolesPermission

protected void checkUserRolesPermission(long userId,
                                        long[] roleIds)
                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

filterRoles

protected java.util.List<com.liferay.portal.kernel.model.Role> filterRoles(java.util.List<com.liferay.portal.kernel.model.Role> roles)
                                                                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException