@ProviderType
public class ResourceBlockLocalServiceUtil
extends Object
ResourceBlockLocalServiceImpl and is the
primary access point for service operations in application layer code running
on the local server. Methods of this service will not have security checks
based on the propagated JAAS credentials because this service can only be
accessed from within the same VM.ResourceBlockLocalService,
ResourceBlockLocalServiceBaseImpl,
ResourceBlockLocalServiceImpl| Constructor and Description |
|---|
ResourceBlockLocalServiceUtil() |
| Modifier and Type | Method and Description |
|---|---|
static void |
addCompanyScopePermission(long companyId,
String name,
long roleId,
String actionId) |
static void |
addCompanyScopePermissions(long companyId,
String name,
long roleId,
long actionIdsLong) |
static void |
addGroupScopePermission(long companyId,
long groupId,
String name,
long roleId,
String actionId) |
static void |
addGroupScopePermissions(long companyId,
long groupId,
String name,
long roleId,
long actionIdsLong) |
static void |
addIndividualScopePermission(long companyId,
long groupId,
String name,
long primKey,
long roleId,
String actionId) |
static void |
addIndividualScopePermission(long companyId,
long groupId,
String name,
PermissionedModel permissionedModel,
long roleId,
String actionId) |
static void |
addIndividualScopePermissions(long companyId,
long groupId,
String name,
long primKey,
long roleId,
long actionIdsLong) |
static void |
addIndividualScopePermissions(long companyId,
long groupId,
String name,
PermissionedModel permissionedModel,
long roleId,
long actionIdsLong) |
static ResourceBlock |
addResourceBlock(long companyId,
long groupId,
String name,
String permissionsHash,
ResourceBlockPermissionsContainer resourceBlockPermissionsContainer)
Adds a resource block if necessary and associates the resource block
permissions with it.
|
static ResourceBlock |
addResourceBlock(ResourceBlock resourceBlock)
Adds the resource block to the database.
|
static ResourceBlock |
createResourceBlock(long resourceBlockId)
Creates a new resource block with the primary key.
|
static PersistedModel |
deletePersistedModel(PersistedModel persistedModel) |
static ResourceBlock |
deleteResourceBlock(long resourceBlockId)
Deletes the resource block with the primary key from the database.
|
static ResourceBlock |
deleteResourceBlock(ResourceBlock resourceBlock)
Deletes the resource block from the database.
|
static DynamicQuery |
dynamicQuery() |
static <T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
static <T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows.
|
static <T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query.
|
static ResourceBlock |
fetchResourceBlock(long resourceBlockId) |
static ActionableDynamicQuery |
getActionableDynamicQuery() |
static long |
getActionId(String name,
String actionId) |
static long |
getActionIds(String name,
List<String> actionIds) |
static List<String> |
getActionIds(String name,
long actionIdsLong) |
static List<String> |
getCompanyScopePermissions(ResourceBlock resourceBlock,
long roleId) |
static List<String> |
getGroupScopePermissions(ResourceBlock resourceBlock,
long roleId) |
static IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static PermissionedModel |
getPermissionedModel(String name,
long primKey) |
static List<String> |
getPermissions(ResourceBlock resourceBlock,
long roleId) |
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
static ResourceBlock |
getResourceBlock(long resourceBlockId)
Returns the resource block with the primary key.
|
static ResourceBlock |
getResourceBlock(String name,
long primKey) |
static List<Long> |
getResourceBlockIds(ResourceBlockIdsBag resourceBlockIdsBag,
String name,
String actionId) |
static ResourceBlockIdsBag |
getResourceBlockIdsBag(long companyId,
long groupId,
String name,
long[] roleIds) |
static List<ResourceBlock> |
getResourceBlocks(int start,
int end)
Returns a range of all the resource blocks.
|
static int |
getResourceBlocksCount()
Returns the number of resource blocks.
|
static List<Role> |
getRoles(String name,
long primKey,
String actionId) |
static ResourceBlockLocalService |
getService() |
static boolean |
hasPermission(String name,
long primKey,
String actionId,
ResourceBlockIdsBag resourceBlockIdsBag) |
static boolean |
hasPermission(String name,
PermissionedModel permissionedModel,
String actionId,
ResourceBlockIdsBag resourceBlockIdsBag) |
static boolean |
isSupported(String name) |
static void |
releasePermissionedModelResourceBlock(PermissionedModel permissionedModel) |
static void |
releasePermissionedModelResourceBlock(String name,
long primKey) |
static void |
releaseResourceBlock(long resourceBlockId)
Decrements the reference count of the resource block and updates it in
the database or deletes the resource block if the reference count reaches
zero.
|
static void |
releaseResourceBlock(ResourceBlock resourceBlock)
Decrements the reference count of the resource block and updates it in
the database or deletes the resource block if the reference count reaches
zero.
|
static void |
removeAllGroupScopePermissions(long companyId,
String name,
long roleId,
long actionIdsLong) |
static void |
removeAllGroupScopePermissions(long companyId,
String name,
long roleId,
String actionId) |
static void |
removeCompanyScopePermission(long companyId,
String name,
long roleId,
String actionId) |
static void |
removeCompanyScopePermissions(long companyId,
String name,
long roleId,
long actionIdsLong) |
static void |
removeGroupScopePermission(long companyId,
long groupId,
String name,
long roleId,
String actionId) |
static void |
removeGroupScopePermissions(long companyId,
long groupId,
String name,
long roleId,
long actionIdsLong) |
static void |
removeIndividualScopePermission(long companyId,
long groupId,
String name,
long primKey,
long roleId,
String actionId) |
static void |
removeIndividualScopePermission(long companyId,
long groupId,
String name,
PermissionedModel permissionedModel,
long roleId,
String actionId) |
static void |
removeIndividualScopePermissions(long companyId,
long groupId,
String name,
long primKey,
long roleId,
long actionIdsLong) |
static void |
removeIndividualScopePermissions(long companyId,
long groupId,
String name,
PermissionedModel permissionedModel,
long roleId,
long actionIdsLong) |
static void |
setCompanyScopePermissions(long companyId,
String name,
long roleId,
List<String> actionIds) |
static void |
setCompanyScopePermissions(long companyId,
String name,
long roleId,
long actionIdsLong) |
static void |
setGroupScopePermissions(long companyId,
long groupId,
String name,
long roleId,
List<String> actionIds) |
static void |
setGroupScopePermissions(long companyId,
long groupId,
String name,
long roleId,
long actionIdsLong) |
static void |
setIndividualScopePermissions(long companyId,
long groupId,
String name,
long primKey,
long roleId,
List<String> actionIds) |
static void |
setIndividualScopePermissions(long companyId,
long groupId,
String name,
long primKey,
long roleId,
long actionIdsLong) |
static void |
setIndividualScopePermissions(long companyId,
long groupId,
String name,
long primKey,
Map<Long,String[]> roleIdsToActionIds) |
static void |
setIndividualScopePermissions(long companyId,
long groupId,
String name,
PermissionedModel permissionedModel,
long roleId,
List<String> actionIds) |
static void |
setIndividualScopePermissions(long companyId,
long groupId,
String name,
PermissionedModel permissionedModel,
long roleId,
long actionIdsLong) |
static void |
updateCompanyScopePermissions(long companyId,
String name,
long roleId,
long actionIdsLong,
int operator) |
static void |
updateGroupScopePermissions(long companyId,
long groupId,
String name,
long roleId,
long actionIdsLong,
int operator) |
static void |
updateIndividualScopePermissions(long companyId,
long groupId,
String name,
PermissionedModel permissionedModel,
long roleId,
long actionIdsLong,
int operator) |
static ResourceBlock |
updateResourceBlock(ResourceBlock resourceBlock)
Updates the resource block in the database or adds it if it does not yet exist.
|
static ResourceBlock |
updateResourceBlockId(long companyId,
long groupId,
String name,
PermissionedModel permissionedModel,
String permissionsHash,
ResourceBlockPermissionsContainer resourceBlockPermissionsContainer) |
static void |
verifyResourceBlockId(long companyId,
String name,
long primKey) |
public static void addCompanyScopePermission(long companyId,
String name,
long roleId,
String actionId)
throws PortalException
PortalExceptionpublic static void addCompanyScopePermissions(long companyId,
String name,
long roleId,
long actionIdsLong)
public static void addGroupScopePermission(long companyId,
long groupId,
String name,
long roleId,
String actionId)
throws PortalException
PortalExceptionpublic static void addGroupScopePermissions(long companyId,
long groupId,
String name,
long roleId,
long actionIdsLong)
public static void addIndividualScopePermission(long companyId,
long groupId,
String name,
long primKey,
long roleId,
String actionId)
throws PortalException
PortalExceptionpublic static void addIndividualScopePermission(long companyId,
long groupId,
String name,
PermissionedModel permissionedModel,
long roleId,
String actionId)
throws PortalException
PortalExceptionpublic static void addIndividualScopePermissions(long companyId,
long groupId,
String name,
long primKey,
long roleId,
long actionIdsLong)
throws PortalException
PortalExceptionpublic static void addIndividualScopePermissions(long companyId,
long groupId,
String name,
PermissionedModel permissionedModel,
long roleId,
long actionIdsLong)
public static ResourceBlock addResourceBlock(long companyId, long groupId, String name, String permissionsHash, ResourceBlockPermissionsContainer resourceBlockPermissionsContainer)
companyId - the primary key of the resource block's companygroupId - the primary key of the resource block's groupname - the resource block's namepermissionsHash - the resource block's permission hashresourceBlockPermissionsContainer - the resource block's
permissions containerpublic static ResourceBlock addResourceBlock(ResourceBlock resourceBlock)
resourceBlock - the resource blockpublic static ResourceBlock createResourceBlock(long resourceBlockId)
resourceBlockId - the primary key for the new resource blockpublic static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
PortalExceptionpublic static ResourceBlock deleteResourceBlock(long resourceBlockId) throws PortalException
resourceBlockId - the primary key of the resource blockPortalException - if a resource block with the primary key could not be foundpublic static ResourceBlock deleteResourceBlock(ResourceBlock resourceBlock)
resourceBlock - the resource blockpublic static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic querypublic static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ResourceBlockModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ResourceBlockModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)orderByComparator - the comparator to order the results by (optionally null)public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic querypublic static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the querypublic static ResourceBlock fetchResourceBlock(long resourceBlockId)
public static ActionableDynamicQuery getActionableDynamicQuery()
public static long getActionId(String name,
String actionId)
throws PortalException
PortalExceptionpublic static long getActionIds(String name,
List<String> actionIds)
throws PortalException
PortalExceptionpublic static List<String> getActionIds(String name,
long actionIdsLong)
public static List<String> getCompanyScopePermissions(ResourceBlock resourceBlock, long roleId)
public static List<String> getGroupScopePermissions(ResourceBlock resourceBlock, long roleId)
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static String getOSGiServiceIdentifier()
public static PermissionedModel getPermissionedModel(String name, long primKey) throws PortalException
PortalExceptionpublic static List<String> getPermissions(ResourceBlock resourceBlock, long roleId)
public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
PortalExceptionpublic static ResourceBlock getResourceBlock(long resourceBlockId) throws PortalException
resourceBlockId - the primary key of the resource blockPortalException - if a resource block with the primary key could not be foundpublic static ResourceBlock getResourceBlock(String name, long primKey) throws PortalException
PortalExceptionpublic static List<Long> getResourceBlockIds(ResourceBlockIdsBag resourceBlockIdsBag, String name, String actionId) throws PortalException
PortalExceptionpublic static ResourceBlockIdsBag getResourceBlockIdsBag(long companyId, long groupId, String name, long[] roleIds)
public static List<ResourceBlock> getResourceBlocks(int start, int end)
Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ResourceBlockModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
start - the lower bound of the range of resource blocksend - the upper bound of the range of resource blocks (not inclusive)public static int getResourceBlocksCount()
public static List<Role> getRoles(String name, long primKey, String actionId) throws PortalException
PortalExceptionpublic static boolean hasPermission(String name,
long primKey,
String actionId,
ResourceBlockIdsBag resourceBlockIdsBag)
throws PortalException
PortalExceptionpublic static boolean hasPermission(String name,
PermissionedModel permissionedModel,
String actionId,
ResourceBlockIdsBag resourceBlockIdsBag)
throws PortalException
PortalExceptionpublic static boolean isSupported(String name)
public static void releasePermissionedModelResourceBlock(PermissionedModel permissionedModel)
public static void releasePermissionedModelResourceBlock(String name,
long primKey)
throws PortalException
PortalExceptionpublic static void releaseResourceBlock(long resourceBlockId)
resourceBlockId - the primary key of the resource blockpublic static void releaseResourceBlock(ResourceBlock resourceBlock)
resourceBlock - the resource blockpublic static void removeAllGroupScopePermissions(long companyId,
String name,
long roleId,
long actionIdsLong)
public static void removeAllGroupScopePermissions(long companyId,
String name,
long roleId,
String actionId)
throws PortalException
PortalExceptionpublic static void removeCompanyScopePermission(long companyId,
String name,
long roleId,
String actionId)
throws PortalException
PortalExceptionpublic static void removeCompanyScopePermissions(long companyId,
String name,
long roleId,
long actionIdsLong)
public static void removeGroupScopePermission(long companyId,
long groupId,
String name,
long roleId,
String actionId)
throws PortalException
PortalExceptionpublic static void removeGroupScopePermissions(long companyId,
long groupId,
String name,
long roleId,
long actionIdsLong)
public static void removeIndividualScopePermission(long companyId,
long groupId,
String name,
long primKey,
long roleId,
String actionId)
throws PortalException
PortalExceptionpublic static void removeIndividualScopePermission(long companyId,
long groupId,
String name,
PermissionedModel permissionedModel,
long roleId,
String actionId)
throws PortalException
PortalExceptionpublic static void removeIndividualScopePermissions(long companyId,
long groupId,
String name,
long primKey,
long roleId,
long actionIdsLong)
throws PortalException
PortalExceptionpublic static void removeIndividualScopePermissions(long companyId,
long groupId,
String name,
PermissionedModel permissionedModel,
long roleId,
long actionIdsLong)
public static void setCompanyScopePermissions(long companyId,
String name,
long roleId,
List<String> actionIds)
throws PortalException
PortalExceptionpublic static void setCompanyScopePermissions(long companyId,
String name,
long roleId,
long actionIdsLong)
public static void setGroupScopePermissions(long companyId,
long groupId,
String name,
long roleId,
List<String> actionIds)
throws PortalException
PortalExceptionpublic static void setGroupScopePermissions(long companyId,
long groupId,
String name,
long roleId,
long actionIdsLong)
public static void setIndividualScopePermissions(long companyId,
long groupId,
String name,
long primKey,
long roleId,
List<String> actionIds)
throws PortalException
PortalExceptionpublic static void setIndividualScopePermissions(long companyId,
long groupId,
String name,
long primKey,
long roleId,
long actionIdsLong)
throws PortalException
PortalExceptionpublic static void setIndividualScopePermissions(long companyId,
long groupId,
String name,
long primKey,
Map<Long,String[]> roleIdsToActionIds)
throws PortalException
PortalExceptionpublic static void setIndividualScopePermissions(long companyId,
long groupId,
String name,
PermissionedModel permissionedModel,
long roleId,
List<String> actionIds)
throws PortalException
PortalExceptionpublic static void setIndividualScopePermissions(long companyId,
long groupId,
String name,
PermissionedModel permissionedModel,
long roleId,
long actionIdsLong)
public static void updateCompanyScopePermissions(long companyId,
String name,
long roleId,
long actionIdsLong,
int operator)
public static void updateGroupScopePermissions(long companyId,
long groupId,
String name,
long roleId,
long actionIdsLong,
int operator)
public static void updateIndividualScopePermissions(long companyId,
long groupId,
String name,
PermissionedModel permissionedModel,
long roleId,
long actionIdsLong,
int operator)
public static ResourceBlock updateResourceBlock(ResourceBlock resourceBlock)
resourceBlock - the resource blockpublic static ResourceBlock updateResourceBlockId(long companyId, long groupId, String name, PermissionedModel permissionedModel, String permissionsHash, ResourceBlockPermissionsContainer resourceBlockPermissionsContainer)
public static void verifyResourceBlockId(long companyId,
String name,
long primKey)
throws PortalException
PortalExceptionpublic static ResourceBlockLocalService getService()