|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.security.membershippolicy.BaseSiteMembershipPolicy com.liferay.portal.security.membershippolicy.DefaultSiteMembershipPolicy
public class DefaultSiteMembershipPolicy
Field Summary | |
---|---|
static int |
DELETE_INTERVAL
|
Constructor Summary | |
---|---|
DefaultSiteMembershipPolicy()
|
Method Summary | |
---|---|
protected void |
checkAddUsersLimitedGroup(long[] userIds,
long[] groupIds)
|
void |
checkMembership(long[] userIds,
long[] addGroupIds,
long[] removeGroupIds)
Checks if the users can be added to and removed from the respective sites. |
protected List<Group> |
getLimitedChildrenGroups(Group group)
|
boolean |
isMembershipAllowed(long userId,
long groupId)
Returns true if the user can be added to the site. |
void |
propagateMembership(long[] userIds,
long[] addGroupIds,
long[] removeGroupIds)
Performs membership policy related actions after the users are added to and removed from the respective sites. |
protected void |
removeUsersFromLimitedChildrenGroups(long[] userIds,
long groupId)
|
protected void |
verifyLimitedParentMembership(Group group)
|
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(Group group,
Group oldGroup,
List<AssetCategory> oldAssetCategories,
List<AssetTag> oldAssetTags,
Map<String,Serializable> oldExpandoAttributes,
UnicodeProperties oldTypeSettingsProperties)
Checks the integrity of the membership policy of the site, with respect to the site's new attribute values, categories, tags, expando attributes, and type settings properties, and performs operations necessary for the compliance of the site and its site roles. |
Methods inherited from class com.liferay.portal.security.membershippolicy.BaseSiteMembershipPolicy |
---|
checkRoles, isMembershipProtected, isMembershipRequired, isRoleAllowed, isRoleProtected, isRoleRequired, propagateRoles, verifyPolicy, verifyPolicy, verifyPolicy |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DELETE_INTERVAL
Constructor Detail |
---|
public DefaultSiteMembershipPolicy()
Method Detail |
---|
public void checkMembership(long[] userIds, long[] addGroupIds, long[] removeGroupIds) throws PortalException, SystemException
SiteMembershipPolicy
Liferay's core services call this method before adding the users to and removing the users from the respective sites. 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 sitesaddGroupIds
- the primary keys of the sites to which the users are
to be added (optionally null
)removeGroupIds
- the primary keys of the sites from which the users
are to be removed (optionally null
)
PortalException
- if any one user could not be added to a site, if
any one user could not be removed from a site, or if a portal
exception occurred
SystemException
- if a system exception occurredpublic boolean isMembershipAllowed(long userId, long groupId)
SiteMembershipPolicy
true
if the user can be added to the site. Liferay's
UI calls this method.
isMembershipAllowed
in interface SiteMembershipPolicy
isMembershipAllowed
in class BaseSiteMembershipPolicy
userId
- the primary key of the usergroupId
- the primary key of the site
true
if the user can be added to the site;
false
otherwisepublic void propagateMembership(long[] userIds, long[] addGroupIds, long[] removeGroupIds) throws PortalException, SystemException
SiteMembershipPolicy
The actions must ensure the integrity of each site's membership policy. For example, some actions for implementations to consider performing are:
userIds
- the primary key of the users that have been added or
removedaddGroupIds
- the primary keys of the sites to which the users were
added (optionally null
)removeGroupIds
- the primary keys of the sites from which the users
were removed (optionally null
)
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic void verifyPolicy(Group group) throws PortalException, SystemException
SiteMembershipPolicy
verifyPolicy
in interface SiteMembershipPolicy
verifyPolicy
in class BaseSiteMembershipPolicy
group
- the site to verify
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic void verifyPolicy(Group group, Group oldGroup, List<AssetCategory> oldAssetCategories, List<AssetTag> oldAssetTags, Map<String,Serializable> oldExpandoAttributes, UnicodeProperties oldTypeSettingsProperties) throws PortalException, SystemException
SiteMembershipPolicy
The actions must ensure the integrity of the site's membership policy based on what has changed in the site's attribute values, categories, tags, expando attributes, and type settings properties.
For example, if the membership policy is that sites with the "admnistrator" tag should only allow administrators as users, then this method could enforce that policy using the following logic:
assetTagLocalService.getTags(Group.class.getName(),
group.getGroupId());
.
group
- the added or updated site to verifyoldGroup
- the old siteoldAssetCategories
- the old categoriesoldAssetTags
- the old tagsoldExpandoAttributes
- the old expando attributesoldTypeSettingsProperties
- the old type settings properties
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredprotected void checkAddUsersLimitedGroup(long[] userIds, long[] groupIds) throws PortalException, SystemException
PortalException
SystemException
protected List<Group> getLimitedChildrenGroups(Group group) throws PortalException, SystemException
PortalException
SystemException
protected void removeUsersFromLimitedChildrenGroups(long[] userIds, long groupId) throws PortalException, SystemException
PortalException
SystemException
protected void verifyLimitedParentMembership(Group group) throws PortalException, SystemException
PortalException
SystemException
|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |