com.liferay.portal.security.membershippolicy
Class BaseOrganizationMembershipPolicy

java.lang.Object
  com.liferay.portal.security.membershippolicy.BaseOrganizationMembershipPolicy

All Implemented Interfaces:

OrganizationMembershipPolicy

Direct Known Subclasses:

DummyOrganizationMembershipPolicy

public abstract class BaseOrganizationMembershipPolicy
extends Object
implements OrganizationMembershipPolicy

Constructor Summary

BaseOrganizationMembershipPolicy()

Method Summary

void	checkRoles(List<UserGroupRole> addUserGroupRoles, List<UserGroupRole> removeUserGroupRoles) Checks if the organization roles can be added to or removed from their users.
boolean	isMembershipAllowed(long userId, long organizationId) Returns true if the user can be added to the organization.
boolean	isMembershipProtected(PermissionChecker permissionChecker, long userId, long organizationId) Returns true if the policy prevents the user from being removed from the organization by the user associated with the permission checker.
boolean	isMembershipRequired(long userId, long organizationId) Returns true if organization membership for the user is mandatory.
boolean	isRoleAllowed(long userId, long organizationId, long roleId) Returns true if the role can be added to the user on the organization.
boolean	isRoleProtected(PermissionChecker permissionChecker, long userId, long organizationId, 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 organizationId, long roleId) Returns true if the role is mandatory for the user on the organization.
void	propagateRoles(List<UserGroupRole> addUserGroupRoles, List<UserGroupRole> removeUserGroupRoles) Performs membership policy related actions after the respective organization 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 organizations and performs operations necessary for the compliance of each organization and organization role.
void	verifyPolicy(Organization organization) Checks the integrity of the membership policy of the organization and performs operations necessary for the organization's compliance.
void	verifyPolicy(Role role) Checks the integrity of the membership policy of the organization 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 organization 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, wait

Methods inherited from interface com.liferay.portal.security.membershippolicy.OrganizationMembershipPolicy

checkMembership, propagateMembership, verifyPolicy

Constructor Detail

BaseOrganizationMembershipPolicy

public BaseOrganizationMembershipPolicy()

Method Detail

checkRoles

public void checkRoles(List<UserGroupRole> addUserGroupRoles,
                       List<UserGroupRole> removeUserGroupRoles)
                throws PortalException,
                       SystemException

Description copied from interface: OrganizationMembershipPolicy

Checks if the organization 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 organization roles. If this method throws an exception, the service foregoes making the changes.

Specified by:

checkRoles in interface OrganizationMembershipPolicy

Parameters:

addUserGroupRoles - the user group roles to be added

removeUserGroupRoles - the user group roles to be removed

Throws:

PortalException - if any one user group role violated the policy or if a portal exception occurred

SystemException - if a system exception occurred

isMembershipAllowed

public boolean isMembershipAllowed(long userId,
                                   long organizationId)
                            throws PortalException,
                                   SystemException

Description copied from interface: OrganizationMembershipPolicy

Returns true if the user can be added to the organization. Liferay's UI calls this method.

Specified by:

isMembershipAllowed in interface OrganizationMembershipPolicy

Parameters:

userId - the primary key of the user

organizationId - the primary key of the organization

Returns:

true if the user can be added to the organization; false otherwise

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

isMembershipProtected

public boolean isMembershipProtected(PermissionChecker permissionChecker,
                                     long userId,
                                     long organizationId)
                              throws PortalException,
                                     SystemException

Description copied from interface: OrganizationMembershipPolicy

Returns true if the policy prevents the user from being removed from the organization by the user associated with the permission checker.

Specified by:

isMembershipProtected in interface OrganizationMembershipPolicy

Parameters:

permissionChecker - the permission checker referencing a user

userId - the primary key of the user to check for protection

organizationId - the primary key of the organization

Returns:

true if the policy prevents the user from being removed from the organization by the user associated with the permission checker; false otherwise

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

isMembershipRequired

public boolean isMembershipRequired(long userId,
                                    long organizationId)
                             throws PortalException,
                                    SystemException

Description copied from interface: OrganizationMembershipPolicy

Returns true if organization membership for the user is mandatory. Liferay's UI, for example, calls this method in deciding whether to enable the checkbox for removing the user from the organization.

Specified by:

isMembershipRequired in interface OrganizationMembershipPolicy

Parameters:

userId - the primary key of the user

organizationId - the primary key of the organization

Returns:

true if organization membership for the user is mandatory; false otherwise

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

isRoleAllowed

public boolean isRoleAllowed(long userId,
                             long organizationId,
                             long roleId)
                      throws PortalException,
                             SystemException

Description copied from interface: OrganizationMembershipPolicy

Returns true if the role can be added to the user on the organization. Liferay's UI calls this method.

Specified by:

isRoleAllowed in interface OrganizationMembershipPolicy

Parameters:

userId - the primary key of the user

organizationId - the primary key of the organization

roleId - the primary key of the role

Returns:

true if the role can be added to the user on the organization; false otherwise

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

isRoleProtected

public boolean isRoleProtected(PermissionChecker permissionChecker,
                               long userId,
                               long organizationId,
                               long roleId)
                        throws PortalException,
                               SystemException

Description copied from interface: OrganizationMembershipPolicy

Returns true if the policy prevents the user from being removed from the role by the user associated with the permission checker.

Specified by:

isRoleProtected in interface OrganizationMembershipPolicy

Parameters:

permissionChecker - the permission checker referencing a user

userId - the primary key of the user to check for protection

organizationId - the primary key of the organization

roleId - the primary key of the role

Returns:

true if the policy prevents the user from being removed from the role by the user associated with the permission checker; false otherwise

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

isRoleRequired

public boolean isRoleRequired(long userId,
                              long organizationId,
                              long roleId)
                       throws PortalException,
                              SystemException

Description copied from interface: OrganizationMembershipPolicy

Returns true if the role is mandatory for the user on the organization. Liferay's UI calls this method.

Specified by:

isRoleRequired in interface OrganizationMembershipPolicy

Parameters:

userId - the primary key of the user

organizationId - the primary key of the organization

roleId - the primary key of the role

Returns:

true if the role is mandatory for the user on the organization; false otherwise

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

propagateRoles

public void propagateRoles(List<UserGroupRole> addUserGroupRoles,
                           List<UserGroupRole> removeUserGroupRoles)

Description copied from interface: OrganizationMembershipPolicy

Performs membership policy related actions after the respective organization 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 organization 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:

propagateRoles in interface OrganizationMembershipPolicy

Parameters:

addUserGroupRoles - the user group roles added

removeUserGroupRoles - the user group roles removed

verifyPolicy

public void verifyPolicy()
                  throws PortalException,
                         SystemException

Description copied from interface: OrganizationMembershipPolicy

Checks the integrity of the membership policy of each of the portal's organizations and performs operations necessary for the compliance of each organization and organization role. This method can be triggered manually from the Control Panel. If the membership.policy.auto.verify portal property is true this method is triggered when starting Liferay and every time a membership policy hook is deployed.

Specified by:

verifyPolicy in interface OrganizationMembershipPolicy

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

verifyPolicy

public void verifyPolicy(Organization organization)
                  throws PortalException,
                         SystemException

Description copied from interface: OrganizationMembershipPolicy

Checks the integrity of the membership policy of the organization and performs operations necessary for the organization's compliance.

Specified by:

verifyPolicy in interface OrganizationMembershipPolicy

Parameters:

organization - the organization to verify

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

verifyPolicy

public void verifyPolicy(Role role)

Description copied from interface: OrganizationMembershipPolicy

Checks the integrity of the membership policy of the organization role and performs operations necessary for the role's compliance.

Specified by:

verifyPolicy in interface OrganizationMembershipPolicy

Parameters:

role - the role to verify

verifyPolicy

public void verifyPolicy(Role role,
                         Role oldRole,
                         Map<String,Serializable> oldExpandoAttributes)

Description copied from interface: OrganizationMembershipPolicy

Checks the integrity of the membership policy of the organization role, with respect to its expando attributes, and performs operations necessary for the role's compliance. Liferay calls this method when adding and updating organization roles.

Specified by:

verifyPolicy in interface OrganizationMembershipPolicy

Parameters:

role - the added or updated role to verify

oldRole - the old role

oldExpandoAttributes - the old expando attributes