AclUtilService (Grails 8.0.0-SNAPSHOT)

grails.plugin.springsecurity.acl.AclUtilService

```
@Slf4j
class AclUtilService
extends java.lang.Object
```
Utility service that hides a lot of the implementation details for working with ACLs.
Authors:
Burt Beckwith

Properties Summary

Properties
Type	Name and description
`java.lang.Object`	`aclService` Dependency injection for aclService.
`ObjectIdentityRetrievalStrategyAndGenerator`	`objectIdentityRetrievalStrategy` Dependency injection for objectIdentityRetrievalStrategy.
`PermissionEvaluator`	`permissionEvaluator` Dependency injection for permissionEvaluator.
`SidRetrievalStrategy`	`sidRetrievalStrategy` Dependency injection for sidRetrievalStrategy.

Constructor Summary

Constructors
Constructor and description
`AclUtilService()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addPermission(java.lang.Class<?> domainClass, java.io.Serializable id, java.lang.Object recipient, Permission permission)` Grant a permission.
	`void`	`addPermission(java.lang.Object domainObject, java.lang.Object recipient, Permission permission)` Grant a permission.
	`void`	`addPermission(ObjectIdentity oid, java.lang.Object recipient, Permission permission)` Grant a permission.
	`void`	`changeOwner(java.lang.Object domainObject, java.lang.String newUsername)` Update the owner of the domain class instance.
	`protected Sid`	`createSid(java.lang.Object recipient)`
	`void`	`deleteAcl(java.lang.Object domainObject)` Helper method to delete an ACL for a domain class.
	`void`	`deletePermission(java.lang.Object domainObject, java.lang.Object recipient, Permission permission)` Removes a granted permission.
	`void`	`deletePermission(java.lang.Class<?> domainClass, long id, java.lang.Object recipient, Permission permission)` Removes a granted permission.
	`boolean`	`hasPermission(Authentication authentication, java.lang.Object domainObject, Permission[] permissions)` Check if the authentication has grants for the specified permission(s) on the domain class instance.
	`boolean`	`hasPermission(Authentication authentication, java.lang.Object domainObject, java.util.List<Permission> permissions)` Check if the authentication has grants for the specified permission(s) on the domain class instance.
	`Acl`	`readAcl(java.lang.Object domainObject)` Helper method to retrieve the ACL for a domain class instance.
	`Acl`	`readAcl(java.lang.Class<?> domainClass, java.lang.Object id)` Helper method to retrieve the ACL for a domain class instance.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Property Detail
  - java.lang.Object aclService
    
    Dependency injection for aclService.
  - ObjectIdentityRetrievalStrategyAndGenerator objectIdentityRetrievalStrategy
    
    Dependency injection for objectIdentityRetrievalStrategy.
  - PermissionEvaluator permissionEvaluator
    
    Dependency injection for permissionEvaluator.
  - SidRetrievalStrategy sidRetrievalStrategy
    
    Dependency injection for sidRetrievalStrategy.
- Constructor Detail
  - AclUtilService()
- Method Detail
  - void addPermission(java.lang.Class<?> domainClass, java.io.Serializable id, java.lang.Object recipient, Permission permission)
    
    Grant a permission. Used when you don't have the instance available.
    Parameters:
    domainClass - the domain class
    id - the instance id
    recipient - the grantee; can be a username, role name, Sid, or Authentication
    permission - the permission to grant
  - void addPermission(java.lang.Object domainObject, java.lang.Object recipient, Permission permission)
    
    Grant a permission. Used when you have the instance available.
    Parameters:
    domainObject - the domain class instance
    recipient - the grantee; can be a username, role name, Sid, or Authentication
    permission - the permission to grant
  - void addPermission(ObjectIdentity oid, java.lang.Object recipient, Permission permission)
    
    Grant a permission.
    Parameters:
    oid - represents the domain object
    recipient - the grantee; can be a username, role name, Sid, or Authentication
    permission - the permission to grant
  - void changeOwner(java.lang.Object domainObject, java.lang.String newUsername)
    
    Update the owner of the domain class instance.
    Parameters:
    domainObject - the domain class instance
    newOwnerUsername - the new username
  - protected Sid createSid(java.lang.Object recipient)
  - void deleteAcl(java.lang.Object domainObject)
    
    Helper method to delete an ACL for a domain class.
    Parameters:
    domainObject - the domain class instance
  - void deletePermission(java.lang.Object domainObject, java.lang.Object recipient, Permission permission)
    
    Removes a granted permission. Used when you have the instance available.
    Parameters:
    domainObject - the domain class instance
    recipient - the grantee; can be a username, role name, Sid, or Authentication
    permission - the permission to remove
  - void deletePermission(java.lang.Class<?> domainClass, long id, java.lang.Object recipient, Permission permission)
    
    Removes a granted permission. Used when you don't have the instance available.
    Parameters:
    domainClass - the domain class
    id - the instance id
    recipient - the grantee; can be a username, role name, Sid, or Authentication
    permission - the permission to remove
  - boolean hasPermission(Authentication authentication, java.lang.Object domainObject, Permission[] permissions)
    
    Check if the authentication has grants for the specified permission(s) on the domain class instance.
    Parameters:
    authentication - an authentication representing a user and roles
    domainObject - the domain class instance
    permissions - one or more permissions to check
    Returns:
    true if granted
  - boolean hasPermission(Authentication authentication, java.lang.Object domainObject, java.util.List<Permission> permissions)
    
    Check if the authentication has grants for the specified permission(s) on the domain class instance.
    Parameters:
    authentication - an authentication representing a user and roles
    domainObject - the domain class instance
    permissions - one or more permissions to check
    Returns:
    true if granted
  - Acl readAcl(java.lang.Object domainObject)
    
    Helper method to retrieve the ACL for a domain class instance.
    Parameters:
    domainObject - the domain class instance
    Returns:
    the Acl (never null)
  - Acl readAcl(java.lang.Class<?> domainClass, java.lang.Object id)
    
    Helper method to retrieve the ACL for a domain class instance.
    Parameters:
    domainClass - the domain class
    id - the instance id
    Returns:
    the Acl (never null)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class AclUtilService

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.Object aclService

ObjectIdentityRetrievalStrategyAndGenerator objectIdentityRetrievalStrategy

PermissionEvaluator permissionEvaluator

SidRetrievalStrategy sidRetrievalStrategy

Constructor Detail

AclUtilService()

Method Detail

void addPermission(java.lang.Class<?> domainClass, java.io.Serializable id, java.lang.Object recipient, Permission permission)

void addPermission(java.lang.Object domainObject, java.lang.Object recipient, Permission permission)

void addPermission(ObjectIdentity oid, java.lang.Object recipient, Permission permission)

void changeOwner(java.lang.Object domainObject, java.lang.String newUsername)

protected Sid createSid(java.lang.Object recipient)

void deleteAcl(java.lang.Object domainObject)

void deletePermission(java.lang.Object domainObject, java.lang.Object recipient, Permission permission)

void deletePermission(java.lang.Class<?> domainClass, long id, java.lang.Object recipient, Permission permission)

boolean hasPermission(Authentication authentication, java.lang.Object domainObject, Permission[] permissions)

boolean hasPermission(Authentication authentication, java.lang.Object domainObject, java.util.List<Permission> permissions)

Acl readAcl(java.lang.Object domainObject)

Acl readAcl(java.lang.Class<?> domainClass, java.lang.Object id)