|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RoleMembershipPolicy
Provides the Role Membership Policy interface, allowing customization of user membership regarding roles.
Role Membership Policies define the roles a user is allowed to be assigned, and the roles the user must be assigned.
An implementation may include any number of rules and actions to enforce those rules. The implementation may include rules and actions like the following:
Liferay's core services invoke checkRoles(long[], long[], long[])
to
detect policy violations before adding the users to and removing the users
from the roles. On passing the check, the service proceeds with the changes
and propagates appropriate related actions in the portal by invoking propagateRoles(long[], long[], long[])
. On failing the check, the service
foregoes making the changes. For example, Liferay executes this logic when
adding and updating roles, and adding and removing roles with respect to
users.
Liferay's UI calls the "is*" methods, such as isRoleAllowed(long,
long)
, to determine appropriate options to display to the user. For example,
the UI calls isRoleAllowed(long, long)
to decide whether to enable
the checkbox for adding the role to the user.
Method Summary | |
---|---|
void |
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)
Returns true if the role can be added to the user. |
boolean |
isRoleRequired(long userId,
long roleId)
Returns true 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()
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. |
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. |
Method Detail |
---|
void checkRoles(long[] userIds, long[] addRoleIds, long[] removeRoleIds) throws PortalException, SystemException
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.
userIds
- the primary keys of the users to be added and removed
from the rolesaddRoleIds
- the primary keys of the roles to be added (optionally
null
)removeRoleIds
- the primary keys of the roles to be removed
(optionally null
)
PortalException
- if any one role violated the policy or if a
portal exception occurred
SystemException
- if a system exception occurredboolean isRoleAllowed(long userId, long roleId) throws PortalException, SystemException
true
if the role can be added to the user. Liferay's
UI calls this method.
userId
- the primary key of the userroleId
- the primary key of the role
true
if the role can be added to the user;
false
otherwise
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredboolean isRoleRequired(long userId, long roleId) throws PortalException, SystemException
true
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.
userId
- the primary key of the userroleId
- the primary key of the role
true
if the role is mandatory for the user;
false
otherwise
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredvoid propagateRoles(long[] userIds, long[] addRoleIds, long[] removeRoleIds) throws PortalException, SystemException
The actions must ensure the membership policy of each role. For example, some actions for implementations to consider performing are:
userIds
- the primary keys of the usersaddRoleIds
- the primary keys of the added rolesremoveRoleIds
- the primary keys of the removed roles
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredvoid verifyPolicy() throws PortalException, SystemException
membership.policy.auto.verify
portal property is
true
this method is triggered when starting Liferay and
every time a membership policy hook is deployed.
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredvoid verifyPolicy(Role role) throws PortalException, SystemException
role
- the role to verify
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredvoid verifyPolicy(Role role, Role oldRole, Map<String,Serializable> oldExpandoAttributes) throws PortalException, SystemException
role
- the added or updated role to verifyoldRole
- the old roleoldExpandoAttributes
- the old expando attributes
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurred
|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |