Class BaseRoleMembershipPolicy
Object
com.liferay.portal.kernel.security.membershippolicy.BaseRoleMembershipPolicy
- All Implemented Interfaces:
RoleMembershipPolicy
- Direct Known Subclasses:
DummyRoleMembershipPolicy
- Author:
- Roberto Díaz, Sergio González
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
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
Checks the integrity of the membership policy of each of the portal's roles and performs operations necessary for the compliance of each role.void
verifyPolicy
(Role role) Checks the integrity of the membership policy of the role and performs operations necessary for the compliance of the role.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.liferay.portal.kernel.security.membershippolicy.RoleMembershipPolicy
checkRoles, propagateRoles, verifyPolicy
-
Constructor Details
-
BaseRoleMembershipPolicy
public BaseRoleMembershipPolicy()
-
-
Method Details
-
isRoleAllowed
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
- 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- Throws:
PortalException
-
isRoleRequired
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
- 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- Throws:
PortalException
-
verifyPolicy
Description copied from interface:RoleMembershipPolicy
Checks the integrity of the membership policy of each of the portal's roles and performs operations necessary for the compliance of each role. This method can be triggered manually from the Control Panel. If themembership.policy.auto.verify
portal property istrue
this method is triggered when starting Liferay and every time a membership policy hook is deployed.- Specified by:
verifyPolicy
in interfaceRoleMembershipPolicy
- Throws:
PortalException
-
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
- Parameters:
role
- the role to verify- Throws:
PortalException
-