Class BaseSiteMembershipPolicy
Object
com.liferay.portal.kernel.security.membershippolicy.BaseSiteMembershipPolicy
- All Implemented Interfaces:
SiteMembershipPolicy
- Direct Known Subclasses:
DummySiteMembershipPolicy
- Author:
- Roberto Díaz, Sergio González
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidcheckRoles(List<UserGroupRole> addUserGroupRoles, List<UserGroupRole> removeUserGroupRoles) Checks if the site roles can be added to or removed from their users.booleanisMembershipAllowed(long userId, long groupId) Returnstrueif the user can be added to the site.booleanisMembershipProtected(PermissionChecker permissionChecker, long userId, long groupId) Returnstrueif the policy prevents the user from being removed from the site by the user associated with the permission checker.booleanisMembershipRequired(long userId, long groupId) Returnstrueif site membership for the user is mandatory.booleanisRoleAllowed(long userId, long groupId, long roleId) Returnstrueif the role can be added to the user on the site.booleanisRoleProtected(PermissionChecker permissionChecker, long userId, long groupId, long roleId) Returnstrueif the policy prevents the user from being removed from the role by the user associated with the permission checker.booleanisRoleRequired(long userId, long groupId, long roleId) Returnstrueif the role is mandatory for the user on the site.voidpropagateRoles(List<UserGroupRole> addUserGroupRoles, List<UserGroupRole> removeUserGroupRoles) Performs membership policy related actions after the respective site roles are added to and removed from the affected users.voidChecks the integrity of the membership policy of each of the portal's sites and performs operations necessary for the compliance of each site and site role.voidverifyPolicy(Group group) Checks the integrity of the membership policy of the site and performs operations necessary for the site's compliance.voidverifyPolicy(Role role) Checks the integrity of the membership policy of the site role and performs operations necessary for the role's compliance.voidverifyPolicy(Role role, Role oldRole, Map<String, Serializable> oldExpandoAttributes) Checks the integrity of the membership policy of the site role, with respect to its expando attributes, and performs operations necessary for the role's compliance.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.liferay.portal.kernel.security.membershippolicy.SiteMembershipPolicy
checkMembership, propagateMembership, verifyPolicy
-
Constructor Details
-
BaseSiteMembershipPolicy
public BaseSiteMembershipPolicy()
-
-
Method Details
-
checkRoles
public void checkRoles(List<UserGroupRole> addUserGroupRoles, List<UserGroupRole> removeUserGroupRoles) throws PortalException Description copied from interface:SiteMembershipPolicyChecks if the site 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 site roles. If this method throws an exception, the service foregoes making the changes.
- Specified by:
checkRolesin interfaceSiteMembershipPolicy- Parameters:
addUserGroupRoles- the user group roles to be addedremoveUserGroupRoles- the user group roles to be removed- Throws:
PortalException
-
isMembershipAllowed
Description copied from interface:SiteMembershipPolicyReturnstrueif the user can be added to the site. Liferay's UI calls this method.- Specified by:
isMembershipAllowedin interfaceSiteMembershipPolicy- Parameters:
userId- the primary key of the usergroupId- the primary key of the site- Returns:
trueif the user can be added to the site;falseotherwise- Throws:
PortalException
-
isMembershipProtected
public boolean isMembershipProtected(PermissionChecker permissionChecker, long userId, long groupId) throws PortalException Description copied from interface:SiteMembershipPolicyReturnstrueif the policy prevents the user from being removed from the site by the user associated with the permission checker.- Specified by:
isMembershipProtectedin interfaceSiteMembershipPolicy- Parameters:
permissionChecker- the permission checker referencing a useruserId- the primary key of the user to check for protectiongroupId- the primary key of the site- Returns:
trueif the policy prevents the user from being removed from the site by the user associated with the permission checker;falseotherwise- Throws:
PortalException
-
isMembershipRequired
Description copied from interface:SiteMembershipPolicyReturnstrueif site membership for the user is mandatory. Liferay's UI, for example, calls this method in deciding whether to display the option to leave the site.- Specified by:
isMembershipRequiredin interfaceSiteMembershipPolicy- Parameters:
userId- the primary key of the usergroupId- the primary key of the site- Returns:
trueif site membership for the user is mandatory;falseotherwise- Throws:
PortalException
-
isRoleAllowed
Description copied from interface:SiteMembershipPolicyReturnstrueif the role can be added to the user on the site. Liferay's UI calls this method.- Specified by:
isRoleAllowedin interfaceSiteMembershipPolicy- Parameters:
userId- the primary key of the usergroupId- the primary key of the siteroleId- the primary key of the role- Returns:
trueif the role can be added to the user on the site;falseotherwise- Throws:
PortalException
-
isRoleProtected
public boolean isRoleProtected(PermissionChecker permissionChecker, long userId, long groupId, long roleId) throws PortalException Description copied from interface:SiteMembershipPolicyReturnstrueif the policy prevents the user from being removed from the role by the user associated with the permission checker.- Specified by:
isRoleProtectedin interfaceSiteMembershipPolicy- Parameters:
permissionChecker- the permission checker referencing a useruserId- the primary key of the user to check for protectiongroupId- the primary key of the siteroleId- the primary key of the role- Returns:
trueif the policy prevents the user from being removed from the role by the user associated with the permission checker;falseotherwise- Throws:
PortalException
-
isRoleRequired
public boolean isRoleRequired(long userId, long groupId, long roleId) Description copied from interface:SiteMembershipPolicyReturnstrueif the role is mandatory for the user on the site. Liferay's UI calls this method.- Specified by:
isRoleRequiredin interfaceSiteMembershipPolicy- Parameters:
userId- the primary key of the usergroupId- the primary key of the siteroleId- the primary key of the role- Returns:
trueif the role is mandatory for the user on the site;falseotherwise
-
propagateRoles
public void propagateRoles(List<UserGroupRole> addUserGroupRoles, List<UserGroupRole> removeUserGroupRoles) throws PortalException Description copied from interface:SiteMembershipPolicyPerforms membership policy related actions after the respective site 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 site 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.
- Specified by:
propagateRolesin interfaceSiteMembershipPolicy- Parameters:
addUserGroupRoles- the user group roles addedremoveUserGroupRoles- the user group roles removed- Throws:
PortalException
-
verifyPolicy
Description copied from interface:SiteMembershipPolicyChecks the integrity of the membership policy of each of the portal's sites and performs operations necessary for the compliance of each site and site role. This method can be triggered manually from the Control Panel. If themembership.policy.auto.verifyportal property istruethis method is triggered when starting Liferay and every time a membership policy hook is deployed.- Specified by:
verifyPolicyin interfaceSiteMembershipPolicy- Throws:
PortalException
-
verifyPolicy
Description copied from interface:SiteMembershipPolicyChecks the integrity of the membership policy of the site and performs operations necessary for the site's compliance.- Specified by:
verifyPolicyin interfaceSiteMembershipPolicy- Parameters:
group- the site to verify- Throws:
PortalException
-
verifyPolicy
Description copied from interface:SiteMembershipPolicyChecks the integrity of the membership policy of the site role and performs operations necessary for the role's compliance.- Specified by:
verifyPolicyin interfaceSiteMembershipPolicy- Parameters:
role- the role to verify
-
verifyPolicy
Description copied from interface:SiteMembershipPolicyChecks the integrity of the membership policy of the site role, with respect to its expando attributes, and performs operations necessary for the role's compliance. Liferay calls this method when adding and updating site roles.- Specified by:
verifyPolicyin interfaceSiteMembershipPolicy- Parameters:
role- the added or updated role to verifyoldRole- the old roleoldExpandoAttributes- the old expando attributes
-