public abstract class BaseSiteMembershipPolicy extends Object implements SiteMembershipPolicy
| Constructor and Description |
|---|
BaseSiteMembershipPolicy() |
| Modifier and Type | Method and Description |
|---|---|
void |
checkRoles(List<UserGroupRole> addUserGroupRoles,
List<UserGroupRole> removeUserGroupRoles)
Checks if the site roles can be added to or removed from their users.
|
boolean |
isMembershipAllowed(long userId,
long groupId)
Returns
true if the user can be added to the site. |
boolean |
isMembershipProtected(PermissionChecker permissionChecker,
long userId,
long groupId)
Returns
true if the policy prevents the user from being
removed from the site by the user associated with the permission checker. |
boolean |
isMembershipRequired(long userId,
long groupId)
Returns
true if site membership for the user is mandatory. |
boolean |
isRoleAllowed(long userId,
long groupId,
long roleId)
Returns
true if the role can be added to the user on the
site. |
boolean |
isRoleProtected(PermissionChecker permissionChecker,
long userId,
long groupId,
long roleId)
Returns
true if the policy prevents the user from being
removed from the role by the user associated with the permission checker. |
boolean |
isRoleRequired(long userId,
long groupId,
long roleId)
Returns
true if the role is mandatory for the user on the
site. |
void |
propagateRoles(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.
|
void |
verifyPolicy()
Checks 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.
|
void |
verifyPolicy(Group group)
Checks the integrity of the membership policy of the site and performs
operations necessary for the site's compliance.
|
void |
verifyPolicy(Role role)
Checks the integrity of the membership policy of the site role and
performs operations necessary for the role's compliance.
|
void |
verifyPolicy(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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcheckMembership, propagateMembership, verifyPolicypublic void checkRoles(List<UserGroupRole> addUserGroupRoles, List<UserGroupRole> removeUserGroupRoles) throws PortalException
SiteMembershipPolicyLiferay'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.
checkRoles in interface SiteMembershipPolicyaddUserGroupRoles - the user group roles to be addedremoveUserGroupRoles - the user group roles to be removedPortalExceptionpublic boolean isMembershipAllowed(long userId,
long groupId)
throws PortalException
SiteMembershipPolicytrue if the user can be added to the site. Liferay's
UI calls this method.isMembershipAllowed in interface SiteMembershipPolicyuserId - the primary key of the usergroupId - the primary key of the sitetrue if the user can be added to the site;
false otherwisePortalExceptionpublic boolean isMembershipProtected(PermissionChecker permissionChecker, long userId, long groupId) throws PortalException
SiteMembershipPolicytrue if the policy prevents the user from being
removed from the site by the user associated with the permission checker.isMembershipProtected in interface SiteMembershipPolicypermissionChecker - the permission checker referencing a useruserId - the primary key of the user to check for protectiongroupId - the primary key of the sitetrue if the policy prevents the user from being
removed from the site by the user associated with the permission
checker; false otherwisePortalExceptionpublic boolean isMembershipRequired(long userId,
long groupId)
throws PortalException
SiteMembershipPolicytrue if 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.isMembershipRequired in interface SiteMembershipPolicyuserId - the primary key of the usergroupId - the primary key of the sitetrue if site membership for the user is mandatory;
false otherwisePortalExceptionpublic boolean isRoleAllowed(long userId,
long groupId,
long roleId)
throws PortalException
SiteMembershipPolicytrue if the role can be added to the user on the
site. Liferay's UI calls this method.isRoleAllowed in interface SiteMembershipPolicyuserId - the primary key of the usergroupId - the primary key of the siteroleId - the primary key of the roletrue if the role can be added to the user on the
site; false otherwisePortalExceptionpublic boolean isRoleProtected(PermissionChecker permissionChecker, long userId, long groupId, long roleId) throws PortalException
SiteMembershipPolicytrue if the policy prevents the user from being
removed from the role by the user associated with the permission checker.isRoleProtected in interface SiteMembershipPolicypermissionChecker - 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 roletrue if the policy prevents the user from being
removed from the role by the user associated with the permission
checker; false otherwisePortalExceptionpublic boolean isRoleRequired(long userId,
long groupId,
long roleId)
SiteMembershipPolicytrue if the role is mandatory for the user on the
site. Liferay's UI calls this method.isRoleRequired in interface SiteMembershipPolicyuserId - the primary key of the usergroupId - the primary key of the siteroleId - the primary key of the roletrue if the role is mandatory for the user on the
site; false otherwisepublic void propagateRoles(List<UserGroupRole> addUserGroupRoles, List<UserGroupRole> removeUserGroupRoles) throws PortalException
SiteMembershipPolicyThe actions must ensure the membership policy of each site role. For example, some actions for implementations to consider performing are:
propagateRoles in interface SiteMembershipPolicyaddUserGroupRoles - the user group roles addedremoveUserGroupRoles - the user group roles removedPortalExceptionpublic void verifyPolicy()
throws PortalException
SiteMembershipPolicymembership.policy.auto.verify portal property
is true this method is triggered when starting Liferay and
every time a membership policy hook is deployed.verifyPolicy in interface SiteMembershipPolicyPortalExceptionpublic void verifyPolicy(Group group) throws PortalException
SiteMembershipPolicyverifyPolicy in interface SiteMembershipPolicygroup - the site to verifyPortalExceptionpublic void verifyPolicy(Role role)
SiteMembershipPolicyverifyPolicy in interface SiteMembershipPolicyrole - the role to verifypublic void verifyPolicy(Role role, Role oldRole, Map<String,Serializable> oldExpandoAttributes)
SiteMembershipPolicyverifyPolicy in interface SiteMembershipPolicyrole - the added or updated role to verifyoldRole - the old roleoldExpandoAttributes - the old expando attributes