Class DummyUserGroupMembershipPolicy
Object
com.liferay.portal.kernel.security.membershippolicy.BaseUserGroupMembershipPolicy
com.liferay.portal.kernel.security.membershippolicy.DummyUserGroupMembershipPolicy
- All Implemented Interfaces:
UserGroupMembershipPolicy
- Author:
- Roberto Díaz, Sergio González
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidcheckMembership(long[] userIds, long[] addUserGroupIds, long[] removeUserGroupIds) Checks if the users can be added to and removed from the respective user groups.booleanisMembershipAllowed(long userId, long userGroupId) Returnstrueif the user can be added to the user group.booleanisMembershipRequired(long userId, long userGroupId) Returnstrueif user group membership for the user is mandatory.voidpropagateMembership(long[] userIds, long[] addUserGroupIds, long[] removeUserGroupIds) Performs membership policy related actions after the users are added to and removed from the respective user groups.voidverifyPolicy(UserGroup userGroup) Checks the integrity of the membership policy of the user group and performs operations necessary for the user group's compliance.voidverifyPolicy(UserGroup userGroup, UserGroup oldUserGroup, Map<String, Serializable> oldExpandoAttributes) Checks the integrity of the membership policy of the user group, with respect to the user group's new attribute values and expando attributes, and performs operations necessary for the compliance of the user group.Methods inherited from class com.liferay.portal.kernel.security.membershippolicy.BaseUserGroupMembershipPolicy
verifyPolicy
-
Constructor Details
-
DummyUserGroupMembershipPolicy
public DummyUserGroupMembershipPolicy()
-
-
Method Details
-
checkMembership
public void checkMembership(long[] userIds, long[] addUserGroupIds, long[] removeUserGroupIds) Description copied from interface:UserGroupMembershipPolicyChecks if the users can be added to and removed from the respective user groups.Liferay's core services call this method before adding the users to and removing the users from the respective user groups. 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 user groupsaddUserGroupIds- the primary keys of the user groups to which the users are to be added (optionallynull)removeUserGroupIds- the primary keys of the user groups from which the users are to be removed (optionallynull)
-
isMembershipAllowed
public boolean isMembershipAllowed(long userId, long userGroupId) Description copied from interface:UserGroupMembershipPolicyReturnstrueif the user can be added to the user group. Liferay's UI calls this method.- Specified by:
isMembershipAllowedin interfaceUserGroupMembershipPolicy- Overrides:
isMembershipAllowedin classBaseUserGroupMembershipPolicy- Parameters:
userId- the primary key of the useruserGroupId- the primary key of the user group- Returns:
trueif the user can be added to the user group;falseotherwise
-
isMembershipRequired
public boolean isMembershipRequired(long userId, long userGroupId) Description copied from interface:UserGroupMembershipPolicyReturnstrueif user group membership for the user is mandatory. Liferay's UI, for example, calls this method in deciding whether the checkbox to select the user group will be enable.- Specified by:
isMembershipRequiredin interfaceUserGroupMembershipPolicy- Overrides:
isMembershipRequiredin classBaseUserGroupMembershipPolicy- Parameters:
userId- the primary key of the useruserGroupId- the primary key of the user group- Returns:
trueif user group membership for the user is mandatory;falseotherwise
-
propagateMembership
public void propagateMembership(long[] userIds, long[] addUserGroupIds, long[] removeUserGroupIds) Description copied from interface:UserGroupMembershipPolicyPerforms membership policy related actions after the users are added to and removed from the respective user groups. Liferay's core services call this method after adding and removing the users to and from the respective user groups.The actions must ensure the integrity of each user group's membership policy. For example, some actions for implementations to consider performing are:
- If a user is added to user group A, he should be added to user group B too.
- If a user is removed from user group A, he should be removed from user group B too.
- Parameters:
userIds- the primary key of the users to be added or removedaddUserGroupIds- the primary keys of the user groups to which the users were added (optionallynull)removeUserGroupIds- the primary keys of the user groups from which the users were removed (optionallynull)
-
verifyPolicy
Description copied from interface:UserGroupMembershipPolicyChecks the integrity of the membership policy of the user group and performs operations necessary for the user group's compliance.- Specified by:
verifyPolicyin interfaceUserGroupMembershipPolicy- Overrides:
verifyPolicyin classBaseUserGroupMembershipPolicy- Parameters:
userGroup- the user group to verify
-
verifyPolicy
public void verifyPolicy(UserGroup userGroup, UserGroup oldUserGroup, Map<String, Serializable> oldExpandoAttributes) Description copied from interface:UserGroupMembershipPolicyChecks the integrity of the membership policy of the user group, with respect to the user group's new attribute values and expando attributes, and performs operations necessary for the compliance of the user group. Liferay calls this method when adding and updating user groups.The actions must ensure the integrity of the user group's membership policy based on what has changed in the user group's attribute values and expando attributes.
For example, if the membership policy is that user groups with the expando attribute A should only allow administrators, then this method could enforce that policy using the following logic:
-
If the oldExpandoAttributes include the expando attribute A and the new
expando attributes include it too, then no action needs to be performed
regarding the policy. Note, the new expando attributes can be obtained
by calling
assetTagLocalService.getTags(Group.class.getName(), group.getGroupId());. - If the oldExpandoAttributes include the expando attribute A and the new expando attributes don't include it, then no action needs to be performed regarding the policy, as non-administrator users need not be removed.
- However, if the oldExpandoAttributes don't include the expando attribute A and the new expando attributes include it, any user group user that does not have the Administrator role must be removed from the user group.
- Parameters:
userGroup- the added or updated user group to verifyoldUserGroup- the old user groupoldExpandoAttributes- the old expando attributes
-
If the oldExpandoAttributes include the expando attribute A and the new
expando attributes include it too, then no action needs to be performed
regarding the policy. Note, the new expando attributes can be obtained
by calling
-