Class DummyRoleMembershipPolicy
Object
com.liferay.portal.kernel.security.membershippolicy.BaseRoleMembershipPolicy
com.liferay.portal.kernel.security.membershippolicy.DummyRoleMembershipPolicy
- All Implemented Interfaces:
RoleMembershipPolicy
- Author:
- Brian Wing Shun Chan, Roberto Díaz, Sergio González
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
checkRoles
(long[] userIds, long[] addRoleIds, long[] removeRoleIds) Checks if the roles can be added to or removed from their users.boolean
isRoleAllowed
(long userId, long roleId) Returnstrue
if the role can be added to the user.boolean
isRoleRequired
(long userId, long roleId) Returnstrue
if the role is mandatory for the user.void
propagateRoles
(long[] userIds, long[] addRoleIds, long[] removeRoleIds) Performs membership policy related actions after the respective roles are added to and removed from the affected users.void
verifyPolicy
(Role role) Checks the integrity of the membership policy of the role and performs operations necessary for the compliance of the role.void
verifyPolicy
(Role role, Role oldRole, Map<String, Serializable> oldExpandoAttributes) Checks the integrity of the membership policy of the role, with respect to the role's new attribute values and expando attributes, and performs operations necessary for the role's compliance.Methods inherited from class com.liferay.portal.kernel.security.membershippolicy.BaseRoleMembershipPolicy
verifyPolicy
-
Constructor Details
-
DummyRoleMembershipPolicy
public DummyRoleMembershipPolicy()
-
-
Method Details
-
checkRoles
public void checkRoles(long[] userIds, long[] addRoleIds, long[] removeRoleIds) Description copied from interface:RoleMembershipPolicy
Checks if the roles can be added to or removed from their users.Liferay's core services call this method before adding the users to and removing the users from the respective roles. If this method throws an exception, the service foregoes making the changes.
- Parameters:
userIds
- the primary keys of the users to be added and removed from the rolesaddRoleIds
- the primary keys of the roles to be added (optionallynull
)removeRoleIds
- the primary keys of the roles to be removed (optionallynull
)
-
isRoleAllowed
public boolean isRoleAllowed(long userId, long roleId) Description copied from interface:RoleMembershipPolicy
Returnstrue
if the role can be added to the user. Liferay's UI calls this method.- Specified by:
isRoleAllowed
in interfaceRoleMembershipPolicy
- Overrides:
isRoleAllowed
in classBaseRoleMembershipPolicy
- Parameters:
userId
- the primary key of the userroleId
- the primary key of the role- Returns:
true
if the role can be added to the user;false
otherwise
-
isRoleRequired
public boolean isRoleRequired(long userId, long roleId) Description copied from interface:RoleMembershipPolicy
Returnstrue
if the role is mandatory for the user. Liferay's UI, for example, calls this method in deciding whether the checkbox to select a role will be enable.- Specified by:
isRoleRequired
in interfaceRoleMembershipPolicy
- Overrides:
isRoleRequired
in classBaseRoleMembershipPolicy
- Parameters:
userId
- the primary key of the userroleId
- the primary key of the role- Returns:
true
if the role is mandatory for the user;false
otherwise
-
propagateRoles
public void propagateRoles(long[] userIds, long[] addRoleIds, long[] removeRoleIds) Description copied from interface:RoleMembershipPolicy
Performs membership policy related actions after the respective roles are added to and removed from the affected users. Liferay's core services call this method after the roles are added to and removed from the users.The actions must ensure the membership policy of each role. For example, some actions for implementations to consider performing are:
- If the role A is added to a user, role B should be added too.
- If the role A is removed from a user, role B should be removed too.
- Parameters:
userIds
- the primary keys of the usersaddRoleIds
- the primary keys of the added rolesremoveRoleIds
- the primary keys of the removed roles
-
verifyPolicy
Description copied from interface:RoleMembershipPolicy
Checks the integrity of the membership policy of the role and performs operations necessary for the compliance of the role.- Specified by:
verifyPolicy
in interfaceRoleMembershipPolicy
- Overrides:
verifyPolicy
in classBaseRoleMembershipPolicy
- Parameters:
role
- the role to verify
-
verifyPolicy
Description copied from interface:RoleMembershipPolicy
Checks the integrity of the membership policy of the role, with respect to the role's new attribute values and expando attributes, and performs operations necessary for the role's compliance. Liferay calls this method when adding and updating roles.- Parameters:
role
- the added or updated role to verifyoldRole
- the old roleoldExpandoAttributes
- the old expando attributes
-