|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.BaseLocalServiceImpl com.liferay.portal.service.base.RoleLocalServiceBaseImpl com.liferay.portal.service.impl.RoleLocalServiceImpl
public class RoleLocalServiceImpl
The implementation of the role local service.
Field Summary |
---|
Constructor Summary | |
---|---|
RoleLocalServiceImpl()
|
Method Summary | |
---|---|
Role |
addRole(long userId,
long companyId,
String name,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
int type)
Deprecated. addRole(long, String, long, String, Map, Map, int,
String) |
Role |
addRole(long userId,
long companyId,
String name,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
int type,
String className,
long classPK)
Deprecated. addRole(long, String, long, String, Map, Map, int,
String) |
Role |
addRole(long userId,
String className,
long classPK,
String name,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
int type,
String subType)
Adds a role with additional parameters. |
void |
addUserRoles(long userId,
long[] roleIds)
Adds the roles to the user. |
protected void |
checkSystemRole(long companyId,
String name,
Map<Locale,String> descriptionMap,
int type)
|
void |
checkSystemRoles()
Checks to ensure that the system roles map has appropriate default roles in each company. |
void |
checkSystemRoles(long companyId)
Checks to ensure that the system roles map has appropriate default roles in the company. |
Role |
deleteRole(long roleId)
Deletes the role with the primary key and its associated permissions. |
Role |
deleteRole(Role role)
Deletes the role and its associated permissions. |
Role |
fetchRole(long companyId,
String name)
Returns the role with the name in the company. |
protected String[] |
getDefaultControlPanelPortlets()
|
Role |
getDefaultGroupRole(long groupId)
Returns the default role for the group with the primary key. |
List<Role> |
getGroupRoles(long groupId)
Returns all the roles associated with the group. |
List<Role> |
getResourceBlockRoles(long resourceBlockId,
String className,
String actionId)
|
Map<String,List<String>> |
getResourceRoles(long companyId,
String name,
int scope,
String primKey)
Returns a map of role names to associated action IDs for the named resource in the company within the permission scope. |
List<Role> |
getResourceRoles(long companyId,
String name,
int scope,
String primKey,
String actionId)
Returns all the roles associated with the action ID in the company within the permission scope. |
Role |
getRole(long companyId,
String name)
Returns the role with the name in the company. |
List<Role> |
getRoles(int type,
String subtype)
Returns all the roles of the type and subtype. |
List<Role> |
getRoles(long companyId)
Returns all the roles in the company. |
List<Role> |
getRoles(long[] roleIds)
Returns all the roles with the primary keys. |
List<Role> |
getSubtypeRoles(String subtype)
Returns all the roles of the subtype. |
int |
getSubtypeRolesCount(String subtype)
Returns the number of roles of the subtype. |
Role |
getTeamRole(long companyId,
long teamId)
Returns the team role in the company. |
List<Role> |
getUserGroupGroupRoles(long userId,
long groupId)
Returns all the user's roles within the user group. |
List<Role> |
getUserGroupRoles(long userId,
long groupId)
Returns all the user's roles within the user group. |
List<Role> |
getUserRelatedRoles(long userId,
List<Group> groups)
Returns the union of all the user's roles within the groups. |
List<Role> |
getUserRelatedRoles(long userId,
long groupId)
Returns all the user's roles within the group. |
List<Role> |
getUserRelatedRoles(long userId,
long[] groupIds)
Returns the union of all the user's roles within the groups. |
List<Role> |
getUserRoles(long userId)
Returns all the roles associated with the user. |
boolean |
hasUserRole(long userId,
long roleId)
Returns true if the user is associated with the role. |
boolean |
hasUserRole(long userId,
long companyId,
String name,
boolean inherited)
Returns true if the user is associated with the named
regular role. |
boolean |
hasUserRoles(long userId,
long companyId,
String[] names,
boolean inherited)
Returns true if the user has any one of the named regular
roles. |
protected void |
initPersonalControlPanelPortletsPermissions(Role role)
|
Role |
loadFetchRole(long companyId,
String name)
Returns a role with the name in the company. |
Role |
loadGetRole(long companyId,
String name)
Returns a role with the name in the company. |
List<Role> |
search(long companyId,
String keywords,
Integer[] types,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the roles that match the keywords and types. |
List<Role> |
search(long companyId,
String keywords,
Integer[] types,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the roles that match the keywords, types, and params. |
List<Role> |
search(long companyId,
String name,
String description,
Integer[] types,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the roles that match the name, description, and types. |
List<Role> |
search(long companyId,
String name,
String description,
Integer[] types,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the roles that match the name, description, types, and params. |
int |
searchCount(long companyId,
String keywords,
Integer[] types)
Returns the number of roles that match the keywords and types. |
int |
searchCount(long companyId,
String keywords,
Integer[] types,
LinkedHashMap<String,Object> params)
Returns the number of roles that match the keywords, types and params. |
int |
searchCount(long companyId,
String name,
String description,
Integer[] types)
Returns the number of roles that match the name, description, and types. |
int |
searchCount(long companyId,
String name,
String description,
Integer[] types,
LinkedHashMap<String,Object> params)
Returns the number of roles that match the name, description, types, and params. |
protected void |
setRolePermissions(Role role,
String name,
String[] actionIds)
|
void |
setUserRoles(long userId,
long[] roleIds)
Sets the roles associated with the user, replacing the user's existing roles. |
void |
unsetUserRoles(long userId,
long[] roleIds)
Removes the matching roles associated with the user. |
Role |
updateRole(long roleId,
String name,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String subtype)
Updates the role with the primary key. |
protected void |
validate(long roleId,
long companyId,
long classNameId,
String name)
|
Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl |
---|
getClassLoader |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RoleLocalServiceImpl()
Method Detail |
---|
public Role addRole(long userId, long companyId, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type) throws PortalException, SystemException
addRole(long, String, long, String, Map, Map, int,
String)
userId
- the primary key of the usercompanyId
- the primary key of the companyname
- the role's nametitleMap
- the role's localized titles (optionally
null
)descriptionMap
- the role's localized descriptions (optionally
null
)type
- the role's type (optionally 0
)
PortalException
- if the class name or the role name were
invalid, if the role is a duplicate, or if a user with the
primary key could not be found
SystemException
- if a system exception occurredpublic Role addRole(long userId, long companyId, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type, String className, long classPK) throws PortalException, SystemException
addRole(long, String, long, String, Map, Map, int,
String)
userId
- the primary key of the usercompanyId
- the primary key of the companyname
- the role's nametitleMap
- the role's localized titles (optionally
null
)descriptionMap
- the role's localized descriptions (optionally
null
)type
- the role's type (optionally 0
)className
- the name of the class for which the role is created
(optionally null
)classPK
- the primary key of the class for which the role is
created (optionally 0
)
PortalException
- if the class name or the role name were
invalid, if the role is a duplicate, or if a user with the
primary key could not be found
SystemException
- if a system exception occurredpublic Role addRole(long userId, String className, long classPK, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type, String subType) throws PortalException, SystemException
userId
- the primary key of the userclassName
- the name of the class for which the role is created
(optionally null
)classPK
- the primary key of the class for which the role is
created (optionally 0
)name
- the role's nametitleMap
- 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
)
PortalException
- if the class name or the role name were invalid,
if the role is a duplicate, or if a user with the primary key
could not be found
SystemException
- if a system exception occurredpublic void addUserRoles(long userId, long[] roleIds) throws PortalException, SystemException
addUserRoles
in interface RoleLocalService
addUserRoles
in class RoleLocalServiceBaseImpl
userId
- the primary key of the userroleIds
- the primary keys of the roles
PortalException
- if a user with the primary key could not be found
SystemException
- if a system exception occurredUserPersistence.addRoles(
long, long[])
public void checkSystemRoles() throws PortalException, SystemException
PortalException
- if the current user did not have permission to
set applicable permissions on a role
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) public void checkSystemRoles(long companyId) throws PortalException, SystemException
companyId
- the primary key of the company
PortalException
- if the current user did not have permission to
set applicable permissions on a role
SystemException
- if a system exception occurredpublic Role deleteRole(long roleId) throws PortalException, SystemException
deleteRole
in interface RoleLocalService
deleteRole
in class RoleLocalServiceBaseImpl
roleId
- the primary key of the role
PortalException
- if a role with the primary key could not be
found, if the role is a default system role, or if the role's
resource could not be found
SystemException
- if a system exception occurredpublic Role deleteRole(Role role) throws PortalException, SystemException
deleteRole
in interface RoleLocalService
deleteRole
in class RoleLocalServiceBaseImpl
role
- the role
PortalException
- if the role is a default system role or if the
role's resource could not be found
SystemException
- if a system exception occurred@Skip public Role fetchRole(long companyId, String name) throws SystemException
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.
companyId
- the primary key of the companyname
- the role's name
null
if a role
with the name could not be found in the company
SystemException
- if a system exception occurredpublic Role getDefaultGroupRole(long groupId) throws PortalException, SystemException
If the group is a site, then the default role is RoleConstants.SITE_MEMBER
. If the group is an
organization, then the default role is RoleConstants.ORGANIZATION_USER
. If the group
is a user or user group, then the default role is RoleConstants.POWER_USER
. For all other group
types, the default role is RoleConstants.USER
.
groupId
- the primary key of the group
PortalException
- if a group with the primary key could not be
found, or if a default role could not be found for the group
SystemException
- if a system exception occurredpublic List<Role> getGroupRoles(long groupId) throws SystemException
getGroupRoles
in interface RoleLocalService
getGroupRoles
in class RoleLocalServiceBaseImpl
groupId
- the primary key of the group
SystemException
- if a system exception occurredpublic List<Role> getResourceBlockRoles(long resourceBlockId, String className, String actionId) throws SystemException
SystemException
public Map<String,List<String>> getResourceRoles(long companyId, String name, int scope, String primKey) throws SystemException
companyId
- the primary key of the companyname
- the resource namescope
- the permission scopeprimKey
- the primary key of the resource's class
SystemException
- if a system exception occurredRoleFinder.findByC_N_S_P(
long, String, int, String)
public List<Role> getResourceRoles(long companyId, String name, int scope, String primKey, String actionId) throws SystemException
companyId
- the primary key of the companyname
- the resource namescope
- the permission scopeprimKey
- the primary key of the resource's classactionId
- the name of the resource action
SystemException
- if a system exception occurredRoleFinder.findByC_N_S_P_A(
long, String, int, String, String)
@Skip public Role getRole(long companyId, String name) throws PortalException, SystemException
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.
companyId
- the primary key of the companyname
- the role's name
PortalException
- if a role with the name could not be found in the
company
SystemException
- if a system exception occurredpublic List<Role> getRoles(int type, String subtype) throws SystemException
type
- the role's type (optionally 0
)subtype
- the role's subtype (optionally null
)
SystemException
- if a system exception occurredpublic List<Role> getRoles(long companyId) throws SystemException
companyId
- the primary key of the company
SystemException
- if a system exception occurredpublic List<Role> getRoles(long[] roleIds) throws PortalException, SystemException
roleIds
- the primary keys of the roles
PortalException
- if any one of the roles with the primary keys
could not be found
SystemException
- if a system exception occurredpublic List<Role> getSubtypeRoles(String subtype) throws SystemException
subtype
- the role's subtype (optionally null
)
SystemException
- if a system exception occurredpublic int getSubtypeRolesCount(String subtype) throws SystemException
subtype
- the role's subtype (optionally null
)
SystemException
- if a system exception occurredpublic Role getTeamRole(long companyId, long teamId) throws PortalException, SystemException
companyId
- the primary key of the companyteamId
- the primary key of the team
PortalException
- if a role could not be found in the team and
company
SystemException
- if a system exception occurredpublic List<Role> getUserGroupGroupRoles(long userId, long groupId) throws SystemException
userId
- the primary key of the usergroupId
- the primary key of the group
SystemException
- if a system exception occurredRoleFinder.findByUserGroupGroupRole(
long, long)
public List<Role> getUserGroupRoles(long userId, long groupId) throws SystemException
userId
- the primary key of the usergroupId
- the primary key of the group
SystemException
- if a system exception occurredRoleFinder.findByUserGroupRole(
long, long)
public List<Role> getUserRelatedRoles(long userId, List<Group> groups) throws SystemException
userId
- the primary key of the usergroups
- the groups (optionally null
)
SystemException
- if a system exception occurredRoleFinder.findByU_G(
long, List)
public List<Role> getUserRelatedRoles(long userId, long groupId) throws SystemException
userId
- the primary key of the usergroupId
- the primary key of the group
SystemException
- if a system exception occurredRoleFinder.findByU_G(
long, long)
public List<Role> getUserRelatedRoles(long userId, long[] groupIds) throws SystemException
userId
- the primary key of the usergroupIds
- the primary keys of the groups
SystemException
- if a system exception occurredRoleFinder.findByU_G(
long, long[])
public List<Role> getUserRoles(long userId) throws SystemException
getUserRoles
in interface RoleLocalService
getUserRoles
in class RoleLocalServiceBaseImpl
userId
- the primary key of the user
SystemException
- if a system exception occurredpublic boolean hasUserRole(long userId, long roleId) throws SystemException
true
if the user is associated with the role.
hasUserRole
in interface RoleLocalService
hasUserRole
in class RoleLocalServiceBaseImpl
userId
- the primary key of the userroleId
- the primary key of the role
true
if the user is associated with the role;
false
otherwise
SystemException
- if a system exception occurred@ThreadLocalCachable public boolean hasUserRole(long userId, long companyId, String name, boolean inherited) throws PortalException, SystemException
true
if the user is associated with the named
regular role.
userId
- the primary key of the usercompanyId
- the primary key of the companyname
- the name of the roleinherited
- whether to include the user's inherited roles in the
search
true
if the user is associated with the regular
role; false
otherwise
PortalException
- if a role with the name could not be found in the
company or if a default user for the company could not be found
SystemException
- if a system exception occurredpublic boolean hasUserRoles(long userId, long companyId, String[] names, boolean inherited) throws PortalException, SystemException
true
if the user has any one of the named regular
roles.
userId
- the primary key of the usercompanyId
- the primary key of the companynames
- the names of the rolesinherited
- whether to include the user's inherited roles in the
search
true
if the user has any one of the regular roles;
false
otherwise
PortalException
- if any one of the roles with the names could not
be found in the company or if the default user for the company
could not be found
SystemException
- if a system exception occurredpublic Role loadFetchRole(long companyId, String name) throws SystemException
companyId
- the primary key of the companyname
- the role's name (optionally null
)
null
if a role with the
name could not be found in the company
SystemException
- if a system exception occurredpublic Role loadGetRole(long companyId, String name) throws PortalException, SystemException
companyId
- the primary key of the companyname
- the role's name
PortalException
- if a role with the name could not be found in the
company
SystemException
- if a system exception occurredpublic List<Role> search(long companyId, String keywords, Integer[] types, int start, int end, OrderByComparator obc) throws SystemException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
companyId
- the primary key of the companykeywords
- the keywords (space separated), which may occur in the
role's name or description (optionally null
)types
- the role types (optionally null
)start
- the lower bound of the range of roles to returnend
- the upper bound of the range of roles to return (not
inclusive)obc
- the comparator to order the roles (optionally
null
)
obc
SystemException
- if a system exception occurredRoleFinder
public List<Role> search(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc) throws SystemException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
companyId
- the primary key of the companykeywords
- the keywords (space separated), which may occur in the
role's name or description (optionally null
)types
- the role types (optionally null
)params
- the finder parameters. Can specify values for
"permissionsResourceId" and "usersRoles" keys. For more
information, see RoleFinder
start
- the lower bound of the range of roles to returnend
- the upper bound of the range of roles to return (not
inclusive)obc
- the comparator to order the roles (optionally
null
)
obc
SystemException
- if a system exception occurredRoleFinder
public List<Role> search(long companyId, String name, String description, Integer[] types, int start, int end, OrderByComparator obc) throws SystemException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
companyId
- the primary key of the companyname
- the role's name (optionally null
)description
- the role's description (optionally null
)types
- the role types (optionally null
)start
- the lower bound of the range of the roles to returnend
- the upper bound of the range of the roles to return (not
inclusive)obc
- the comparator to order the roles (optionally
null
)
obc
SystemException
- if a system exception occurredRoleFinder
public List<Role> search(long companyId, String name, String description, Integer[] types, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc) throws SystemException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
companyId
- the primary key of the companyname
- the role's name (optionally null
)description
- the role's description (optionally null
)types
- the role types (optionally null
)params
- the finder's parameters. Can specify values for
"permissionsResourceId" and "usersRoles" keys. For more
information, see RoleFinder
start
- the lower bound of the range of the roles to returnend
- the upper bound of the range of the roles to return (not
inclusive)obc
- the comparator to order the roles (optionally
null
)
obc
SystemException
- if a system exception occurredRoleFinder
public int searchCount(long companyId, String keywords, Integer[] types) throws SystemException
companyId
- the primary key of the companykeywords
- the keywords (space separated), which may occur in the
role's name or description (optionally null
)types
- the role types (optionally null
)
SystemException
- if a system exception occurredpublic int searchCount(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params) throws SystemException
companyId
- the primary key of the companykeywords
- the keywords (space separated), which may occur in the
role's name or description (optionally null
)types
- the role types (optionally null
)params
- the finder parameters. For more information, see RoleFinder
SystemException
- if a system exception occurredpublic int searchCount(long companyId, String name, String description, Integer[] types) throws SystemException
companyId
- the primary key of the companyname
- the role's name (optionally null
)description
- the role's description (optionally null
)types
- the role types (optionally null
)
SystemException
- if a system exception occurredpublic int searchCount(long companyId, String name, String description, Integer[] types, LinkedHashMap<String,Object> params) throws SystemException
companyId
- the primary key of the companyname
- the role's name (optionally null
)description
- the role's description (optionally null
)types
- the role types (optionally null
)params
- the finder parameters. Can specify values for
"permissionsResourceId" and "usersRoles" keys. For more
information, see RoleFinder
SystemException
- if a system exception occurredpublic void setUserRoles(long userId, long[] roleIds) throws PortalException, SystemException
setUserRoles
in interface RoleLocalService
setUserRoles
in class RoleLocalServiceBaseImpl
userId
- the primary key of the userroleIds
- the primary keys of the roles
PortalException
- if a user with the primary could not be found or
if any one of the roles with the primary keys could not be found
SystemException
- if a system exception occurredpublic void unsetUserRoles(long userId, long[] roleIds) throws PortalException, SystemException
userId
- the primary key of the userroleIds
- the primary keys of the roles
PortalException
- if a user with the primary key could not be found
or if a role with any one of the primary keys could not be found
SystemException
- if a system exception occurredpublic Role updateRole(long roleId, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String subtype) throws PortalException, SystemException
roleId
- the primary key of the rolename
- the role's new nametitleMap
- the new localized titles (optionally null
)
to replace those existing for the roledescriptionMap
- the new localized descriptions (optionally
null
) to replace those existing for the rolesubtype
- the role's new subtype (optionally null
)
PortalException
- if a role with the primary could not be found or
if the role's name was invalid
SystemException
- if a system exception occurredprotected void checkSystemRole(long companyId, String name, Map<Locale,String> descriptionMap, int type) throws PortalException, SystemException
PortalException
SystemException
protected String[] getDefaultControlPanelPortlets()
protected void initPersonalControlPanelPortletsPermissions(Role role) throws PortalException, SystemException
PortalException
SystemException
protected void setRolePermissions(Role role, String name, String[] actionIds) throws PortalException, SystemException
PortalException
SystemException
protected void validate(long roleId, long companyId, long classNameId, String name) throws PortalException, SystemException
PortalException
SystemException
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |