com.liferay.portal.security.permission.PermissionChecker Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.security.permission;
import com.liferay.portal.model.User;
import java.util.List;
import javax.portlet.PortletRequest;
/**
* @author Brian Wing Shun Chan
*/
public interface PermissionChecker extends Cloneable {
public static final long[] DEFAULT_ROLE_IDS = {};
public PermissionChecker clone();
/**
* Returns the primary key of the user's company.
*
* @return the primary key of the user's company
*/
public long getCompanyId();
public List getGuestResourceBlockIds(
long companyId, long groupId, String name, String actionId);
public List getOwnerResourceBlockIds(
long companyId, long groupId, String name, String actionId);
/**
* Returns the primary key of the owner role. This role is automatically
* given to the creator of a resource.
*
* @return the primary key of the owner role
*/
public long getOwnerRoleId();
public List getResourceBlockIds(
long companyId, long groupId, long userId, String name,
String actionId);
/**
* Returns the primary keys of the roles the user has within the group.
*
* @param userId the primary key of the user
* @param groupId the primary key of the group
* @return the primary keys of the roles the user has within the group
*/
public long[] getRoleIds(long userId, long groupId);
public User getUser();
/**
* Returns the primary key of the user.
*
* @return the primary key of the user
*/
public long getUserId();
/**
* Returns true if the user is the owner of the resource and
* has permission to perform the action.
*
* @param companyId the primary key of the user's company
* @param name the resource's name, which can be either a class name or a
* portlet ID
* @param primKey the primary key of the resource
* @param ownerId the primary key of the resource's owner
* @param actionId the action ID
* @return true if the user is the owner of the resource and
* has permission to perform the action; false
* otherwise
*/
public boolean hasOwnerPermission(
long companyId, String name, long primKey, long ownerId,
String actionId);
/**
* Returns true if the user is the owner of the resource and
* has permission to perform the action.
*
* @param companyId the primary key of the user's company
* @param name the resource's name, which can be either a class name or a
* portlet ID
* @param primKey the primary key of the resource
* @param ownerId the primary key of the resource's owner
* @param actionId the action ID
* @return true if the user is the owner of the resource and
* has permission to perform the action; false
* otherwise
*/
public boolean hasOwnerPermission(
long companyId, String name, String primKey, long ownerId,
String actionId);
/**
* Returns true if the user has permission to perform the
* action on the resource.
*
* @param groupId the primary key of the group containing the resource
* @param name the resource's name, which can be either a class name or a
* portlet ID
* @param primKey the primary key of the resource
* @param actionId the action ID
* @return true if the user has permission to perform the
* action on the resource; false otherwise
*/
public boolean hasPermission(
long groupId, String name, long primKey, String actionId);
/**
* Returns true if the user has permission to perform the
* action on the resource.
*
* @param groupId the primary key of the group containing the resource
* @param name the resource's name, which can be either a class name or a
* portlet ID
* @param primKey the primary key of the resource
* @param actionId the action ID
* @return true if the user has permission to perform the
* action on the resource; false otherwise
*/
public boolean hasPermission(
long groupId, String name, String primKey, String actionId);
/**
* Returns true if the user has permission to perform the
* action on the resource without using guest permissions.
*
* @param groupId the primary key of the group containing the resource
* @param name the resource's name, which can be either a class name or a
* portlet ID
* @param primKey the primary key of the resource
* @param actionId the action ID
* @param checkAdmin whether to use permissions gained from administrator
* roles
* @return true if the user has permission to perform the
* action on the resource without using guest permissions;
* false otherwise
*/
public boolean hasUserPermission(
long groupId, String name, String primKey, String actionId,
boolean checkAdmin);
/**
* Initializes this permission checker.
*
* @param user the current user
*/
public void init(User user);
/**
* Returns true if guest permissions will be used in permission
* checks.
*
* @return true if guest permissions will be used in permission
* checks; false otherwise
*/
public boolean isCheckGuest();
/**
* @deprecated As of 6.1.0, renamed to {@link #isGroupAdmin(long)}
*/
public boolean isCommunityAdmin(long groupId);
/**
* @deprecated As of 6.1.0, renamed to {@link #isGroupOwner(long)}
*/
public boolean isCommunityOwner(long groupId);
/**
* Returns true if the user is an administrator of their
* company.
*
* @return true if the user is an administrator of their
* company; false otherwise
*/
public boolean isCompanyAdmin();
/**
* Returns true if the user is an administrator of the company.
*
* @param companyId the primary key of the company
* @return true if the user is an administrator of the company;
* false otherwise
*/
public boolean isCompanyAdmin(long companyId);
/**
* Returns true if the user is an administrator of the group.
*
* @param groupId the primary key of the group
* @return true if the user is an administrator of the group;
* false otherwise
*/
public boolean isGroupAdmin(long groupId);
/**
* Returns true if the user is a member of the group.
*
* @param groupId the primary key of the group
* @return true if the user is a member of the group;
* false otherwise
*/
public boolean isGroupMember(long groupId);
/**
* Returns true if the user is the owner of the group.
*
* @param groupId the primary key of the group
* @return true if the user is the owner of the group;
* false otherwise
*/
public boolean isGroupOwner(long groupId);
/**
* Returns true if the user is a universal administrator.
*
* @return true if the user is a universal administrator;
* false otherwise
* @see com.liferay.portlet.admin.util.OmniadminUtil
*/
public boolean isOmniadmin();
/**
* Returns true if the user is an administrator of the
* organization.
*
* @param organizationId the primary key of the organization
* @return true if the user is an administrator of the
* organization; false otherwise
*/
public boolean isOrganizationAdmin(long organizationId);
/**
* Returns true if the user is an owner of the organization.
*
* @param organizationId the primary key of the organization
* @return true if the user is an owner of the organization;
* false otherwise
*/
public boolean isOrganizationOwner(long organizationId);
/**
* Returns true if the user is signed in.
*
* @return true if the user is signed in; false
* otherwise
*/
public boolean isSignedIn();
/**
* @deprecated As of 6.2.0, does nothing
*/
public void resetValues();
/**
* @deprecated As of 6.2.0, does nothing
*/
public void setValues(PortletRequest portletRequest);
}