com.liferay.portal.security.permission

Class AdvancedPermissionChecker

java.lang.Object

com.liferay.portal.security.permission.BasePermissionChecker

com.liferay.portal.security.permission.AdvancedPermissionChecker

All Implemented Interfaces:

com.liferay.portal.kernel.security.permission.PermissionChecker, java.lang.Cloneable

public class AdvancedPermissionChecker
extends BasePermissionChecker

Author:

Charles May, Brian Wing Shun Chan, Raymond Augé, Wesley Gong, Connor McKay

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	RESULTS_SEPARATOR Deprecated. As of Bunyan (6.0.x)

Fields inherited from class com.liferay.portal.security.permission.BasePermissionChecker

checkGuest, defaultUserId, omniadmin, ownerRole, signedIn, user

Fields inherited from interface com.liferay.portal.kernel.security.permission.PermissionChecker

DEFAULT_ROLE_IDS

Constructor Summary

Constructors

Constructor and Description
AdvancedPermissionChecker()

Method Summary

Modifier and Type	Method and Description
protected void	addTeamRoles(long userId, com.liferay.portal.kernel.model.Group group, java.util.Set<java.lang.Long> roleIds)
AdvancedPermissionChecker	clone()
protected boolean	doCheckPermission(long companyId, long groupId, java.lang.String name, java.lang.String primKey, long[] roleIds, java.lang.String actionId, org.apache.commons.lang.time.StopWatch stopWatch)
protected long[]	doGetRoleIds(long userId, long groupId)
protected java.util.List<com.liferay.portal.kernel.model.Resource>	fixMissingResources(long companyId, long groupId, java.lang.String name, java.lang.String primKey, java.lang.String actionId, java.util.List<com.liferay.portal.kernel.model.Resource> resources)
com.liferay.portal.kernel.security.permission.ResourceBlockIdsBag	getGuestResourceBlockIdsBag(long companyId, long groupId, java.lang.String name) Deprecated. As of Judson (7.1.x), with no direct replacement
long[]	getGuestUserRoleIds()
java.util.List<java.lang.Long>	getOwnerResourceBlockIds(long companyId, long groupId, java.lang.String name, java.lang.String actionId) Deprecated. As of Judson (7.1.x), with no direct replacement
com.liferay.portal.kernel.security.permission.ResourceBlockIdsBag	getOwnerResourceBlockIdsBag(long companyId, long groupId, java.lang.String name) Deprecated. As of Judson (7.1.x), with no direct replacement
java.util.List<java.lang.Long>	getResourceBlockIds(long companyId, long groupId, long userId, java.lang.String name, java.lang.String actionId) Deprecated. As of Judson (7.1.x), with no direct replacement
com.liferay.portal.kernel.security.permission.ResourceBlockIdsBag	getResourceBlockIdsBag(long companyId, long groupId, java.lang.String name, long[] roleIds) Deprecated. As of Judson (7.1.x), with no direct replacement
protected java.util.List<com.liferay.portal.kernel.model.Resource>	getResources(long companyId, long groupId, java.lang.String name, java.lang.String primKey, java.lang.String actionId) Returns representations of the resource at each scope level.
long[]	getRoleIds(long userId, long groupId)
com.liferay.portal.kernel.security.permission.UserBag	getUserBag()
protected boolean	hasGuestPermission(long groupId, java.lang.String name, java.lang.String primKey, java.lang.String actionId) Deprecated. As of Judson (7.1.x), with no direct replacement
boolean	hasOwnerPermission(long companyId, java.lang.String name, java.lang.String primKey, long ownerId, java.lang.String actionId)
boolean	hasPermission(com.liferay.portal.kernel.model.Group group, java.lang.String name, java.lang.String primKey, java.lang.String actionId)
protected boolean	hasPermissionImpl(long groupId, java.lang.String name, java.lang.String primKey, long[] roleIds, java.lang.String actionId) Deprecated. As of Judson (7.1.x), with no direct replacement
protected boolean	hasUserPermissionImpl(long groupId, java.lang.String name, java.lang.String primKey, long[] roleIds, java.lang.String actionId) Deprecated. As of Judson (7.1.x), with no direct replacement
void	init(com.liferay.portal.kernel.model.User user)
void	init(com.liferay.portal.kernel.model.User user, com.liferay.portal.kernel.security.permission.contributor.RoleContributor[] roleContributors)
boolean	isCompanyAdmin()
boolean	isCompanyAdmin(long companyId)
protected boolean	isCompanyAdminImpl(long companyId)
boolean	isContentReviewer(long companyId, long groupId)
protected boolean	isContentReviewerImpl(long groupId)
protected boolean	isContentReviewerImpl(long companyId, long groupId)
boolean	isGroupAdmin(long groupId)
protected boolean	isGroupAdminImpl(com.liferay.portal.kernel.model.Group group)
protected boolean	isGroupAdminImpl(long groupId) Deprecated. As of Judson (7.1.x), with no direct replacement
boolean	isGroupMember(long groupId)
protected boolean	isGroupMemberImpl(long groupId)
boolean	isGroupOwner(long groupId)
protected boolean	isGroupOwnerImpl(com.liferay.portal.kernel.model.Group group)
protected boolean	isGroupOwnerImpl(long groupId)
boolean	isOrganizationAdmin(long organizationId)
protected boolean	isOrganizationAdminImpl(long organizationId)
protected boolean	isOrganizationAdminImpl(com.liferay.portal.kernel.model.Organization organization)
boolean	isOrganizationOwner(long organizationId)
protected boolean	isOrganizationOwnerImpl(long organizationId)
protected boolean	isOrganizationOwnerImpl(com.liferay.portal.kernel.model.Organization organization)
protected void	logHasUserPermission(long groupId, java.lang.String name, java.lang.String primKey, java.lang.String actionId, org.apache.commons.lang.time.StopWatch stopWatch, int block)

Methods inherited from class com.liferay.portal.security.permission.BasePermissionChecker

getCompanyId, getOwnerRoleId, getPermissionChecksMap, getUser, getUserId, hasOwnerPermission, hasPermission, hasPermission, hasPermission, isCheckGuest, isOmniadmin, isSignedIn

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESULTS_SEPARATOR

@Deprecated
protected static final java.lang.String RESULTS_SEPARATOR

Deprecated. As of Bunyan (6.0.x)

See Also:

Constant Field Values

Constructor Detail

AdvancedPermissionChecker

public AdvancedPermissionChecker()

Method Detail

clone

public AdvancedPermissionChecker clone()

Specified by:

clone in interface com.liferay.portal.kernel.security.permission.PermissionChecker

Specified by:

clone in class BasePermissionChecker

getGuestResourceBlockIdsBag

@Deprecated
public com.liferay.portal.kernel.security.permission.ResourceBlockIdsBag getGuestResourceBlockIdsBag(long companyId,
                                                                                                                 long groupId,
                                                                                                                 java.lang.String name)
                                                                                                          throws java.lang.Exception

Deprecated. As of Judson (7.1.x), with no direct replacement

Throws:

java.lang.Exception

getGuestUserRoleIds

public long[] getGuestUserRoleIds()

Specified by:

getGuestUserRoleIds in interface com.liferay.portal.kernel.security.permission.PermissionChecker

Overrides:

getGuestUserRoleIds in class BasePermissionChecker

getOwnerResourceBlockIds

@Deprecated
public java.util.List<java.lang.Long> getOwnerResourceBlockIds(long companyId,
                                                                           long groupId,
                                                                           java.lang.String name,
                                                                           java.lang.String actionId)

Deprecated. As of Judson (7.1.x), with no direct replacement

Specified by:

getOwnerResourceBlockIds in interface com.liferay.portal.kernel.security.permission.PermissionChecker

Overrides:

getOwnerResourceBlockIds in class BasePermissionChecker

getOwnerResourceBlockIdsBag

@Deprecated
public com.liferay.portal.kernel.security.permission.ResourceBlockIdsBag getOwnerResourceBlockIdsBag(long companyId,
                                                                                                                 long groupId,
                                                                                                                 java.lang.String name)

Deprecated. As of Judson (7.1.x), with no direct replacement

getResourceBlockIds

@Deprecated
public java.util.List<java.lang.Long> getResourceBlockIds(long companyId,
                                                                      long groupId,
                                                                      long userId,
                                                                      java.lang.String name,
                                                                      java.lang.String actionId)

Deprecated. As of Judson (7.1.x), with no direct replacement

Specified by:

getResourceBlockIds in interface com.liferay.portal.kernel.security.permission.PermissionChecker

Overrides:

getResourceBlockIds in class BasePermissionChecker

getResourceBlockIdsBag

@Deprecated
public com.liferay.portal.kernel.security.permission.ResourceBlockIdsBag getResourceBlockIdsBag(long companyId,
                                                                                                            long groupId,
                                                                                                            java.lang.String name,
                                                                                                            long[] roleIds)
                                                                                                     throws java.lang.Exception

Deprecated. As of Judson (7.1.x), with no direct replacement

Throws:

java.lang.Exception

getRoleIds

public long[] getRoleIds(long userId,
                         long groupId)

Specified by:

getRoleIds in interface com.liferay.portal.kernel.security.permission.PermissionChecker

Overrides:

getRoleIds in class BasePermissionChecker

getUserBag

public com.liferay.portal.kernel.security.permission.UserBag getUserBag()
                                                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

hasOwnerPermission

public boolean hasOwnerPermission(long companyId,
                                  java.lang.String name,
                                  java.lang.String primKey,
                                  long ownerId,
                                  java.lang.String actionId)

hasPermission

public boolean hasPermission(com.liferay.portal.kernel.model.Group group,
                             java.lang.String name,
                             java.lang.String primKey,
                             java.lang.String actionId)

init

public void init(com.liferay.portal.kernel.model.User user)

Specified by:

init in interface com.liferay.portal.kernel.security.permission.PermissionChecker

Overrides:

init in class BasePermissionChecker

init

public void init(com.liferay.portal.kernel.model.User user,
                 com.liferay.portal.kernel.security.permission.contributor.RoleContributor[] roleContributors)

isCompanyAdmin

public boolean isCompanyAdmin()

isCompanyAdmin

public boolean isCompanyAdmin(long companyId)

isContentReviewer

public boolean isContentReviewer(long companyId,
                                 long groupId)

isGroupAdmin

public boolean isGroupAdmin(long groupId)

isGroupMember

public boolean isGroupMember(long groupId)

isGroupOwner

public boolean isGroupOwner(long groupId)

isOrganizationAdmin

public boolean isOrganizationAdmin(long organizationId)

isOrganizationOwner

public boolean isOrganizationOwner(long organizationId)

addTeamRoles

protected void addTeamRoles(long userId,
                            com.liferay.portal.kernel.model.Group group,
                            java.util.Set<java.lang.Long> roleIds)
                     throws java.lang.Exception

Throws:

java.lang.Exception

doCheckPermission

protected boolean doCheckPermission(long companyId,
                                    long groupId,
                                    java.lang.String name,
                                    java.lang.String primKey,
                                    long[] roleIds,
                                    java.lang.String actionId,
                                    org.apache.commons.lang.time.StopWatch stopWatch)
                             throws java.lang.Exception

Throws:

java.lang.Exception

doGetRoleIds

protected long[] doGetRoleIds(long userId,
                              long groupId)
                       throws java.lang.Exception

Throws:

java.lang.Exception

fixMissingResources

protected java.util.List<com.liferay.portal.kernel.model.Resource> fixMissingResources(long companyId,
                                                                                       long groupId,
                                                                                       java.lang.String name,
                                                                                       java.lang.String primKey,
                                                                                       java.lang.String actionId,
                                                                                       java.util.List<com.liferay.portal.kernel.model.Resource> resources)
                                                                                throws java.lang.Exception

Throws:

java.lang.Exception

getResources

protected java.util.List<com.liferay.portal.kernel.model.Resource> getResources(long companyId,
                                                                                long groupId,
                                                                                java.lang.String name,
                                                                                java.lang.String primKey,
                                                                                java.lang.String actionId)
                                                                         throws java.lang.Exception

Returns representations of the resource at each scope level.

For example, if the class name and primary key of a blog entry were passed to this method, it would return a resource for the blog entry itself (individual scope), a resource representing all blog entries within its group (group scope), a resource standing for all blog entries within a group the user has a suitable role in (group-template scope), and a resource signifying all blog entries within the company (company scope).

Parameters:

companyId - the primary key of the company

groupId - the primary key of the group containing the resource

name - the resource's name, which can be either a class name or a portlet ID

primKey - the primary key of the resource

actionId - unused

Returns:

representations of the resource at each scope level

Throws:

java.lang.Exception - if an exception occurred

hasGuestPermission

@Deprecated
protected boolean hasGuestPermission(long groupId,
                                                 java.lang.String name,
                                                 java.lang.String primKey,
                                                 java.lang.String actionId)
                                          throws java.lang.Exception

Deprecated. As of Judson (7.1.x), with no direct replacement

Throws:

java.lang.Exception

hasPermissionImpl

@Deprecated
protected boolean hasPermissionImpl(long groupId,
                                                java.lang.String name,
                                                java.lang.String primKey,
                                                long[] roleIds,
                                                java.lang.String actionId)

Deprecated. As of Judson (7.1.x), with no direct replacement

hasUserPermissionImpl

@Deprecated
protected boolean hasUserPermissionImpl(long groupId,
                                                    java.lang.String name,
                                                    java.lang.String primKey,
                                                    long[] roleIds,
                                                    java.lang.String actionId)
                                             throws java.lang.Exception

Deprecated. As of Judson (7.1.x), with no direct replacement

Throws:

java.lang.Exception

isCompanyAdminImpl

protected boolean isCompanyAdminImpl(long companyId)
                              throws java.lang.Exception

Throws:

java.lang.Exception

isContentReviewerImpl

protected boolean isContentReviewerImpl(long groupId)
                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

isContentReviewerImpl

protected boolean isContentReviewerImpl(long companyId,
                                        long groupId)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

isGroupAdminImpl

protected boolean isGroupAdminImpl(com.liferay.portal.kernel.model.Group group)
                            throws java.lang.Exception

Throws:

java.lang.Exception

isGroupAdminImpl

@Deprecated
protected boolean isGroupAdminImpl(long groupId)
                                        throws java.lang.Exception

Deprecated. As of Judson (7.1.x), with no direct replacement

Throws:

java.lang.Exception

isGroupMemberImpl

protected boolean isGroupMemberImpl(long groupId)
                             throws java.lang.Exception

Throws:

java.lang.Exception

isGroupOwnerImpl

protected boolean isGroupOwnerImpl(com.liferay.portal.kernel.model.Group group)
                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

isGroupOwnerImpl

protected boolean isGroupOwnerImpl(long groupId)
                            throws java.lang.Exception

Throws:

java.lang.Exception

isOrganizationAdminImpl

protected boolean isOrganizationAdminImpl(long organizationId)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

isOrganizationAdminImpl

protected boolean isOrganizationAdminImpl(com.liferay.portal.kernel.model.Organization organization)
                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

isOrganizationOwnerImpl

protected boolean isOrganizationOwnerImpl(long organizationId)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

isOrganizationOwnerImpl

protected boolean isOrganizationOwnerImpl(com.liferay.portal.kernel.model.Organization organization)
                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

logHasUserPermission

protected void logHasUserPermission(long groupId,
                                    java.lang.String name,
                                    java.lang.String primKey,
                                    java.lang.String actionId,
                                    org.apache.commons.lang.time.StopWatch stopWatch,
                                    int block)