org.acegisecurity.acls

Interface MutableAcl

All Superinterfaces:

Acl, Serializable

All Known Subinterfaces:

AuditableAcl, OwnershipAcl

All Known Implementing Classes:

AclImpl

public interface MutableAcl
extends Acl

A mutable Acl.

A mutable ACL must ensure that appropriate security checks are performed before allowing access to its methods.

Version:

$Id: MutableAcl.java 1867 2007-05-25 02:22:18Z benalex $

Author:

Ben Alex

Method Summary

Modifier and Type	Method and Description
void	deleteAce(Serializable aceId)
AccessControlEntry[]	getEntries() Retrieves all of the non-deleted AccessControlEntry instances currently stored by the MutableAcl.
Serializable	getId() Obtains an identifier that represents this MutableAcl.
void	insertAce(Serializable afterAceId, Permission permission, Sid sid, boolean granting)
void	setEntriesInheriting(boolean entriesInheriting) Change the value returned by Acl.isEntriesInheriting().
void	setParent(Acl newParent) Changes the parent of this ACL.
void	updateAce(Serializable aceId, Permission permission)

Methods inherited from interface org.acegisecurity.acls.Acl

getObjectIdentity, getOwner, getParentAcl, isEntriesInheriting, isGranted, isSidLoaded

Method Detail

deleteAce

void deleteAce(Serializable aceId)
        throws NotFoundException

Throws:

NotFoundException

getEntries

AccessControlEntry[] getEntries()

Retrieves all of the non-deleted AccessControlEntry instances currently stored by the MutableAcl. The returned objects should be immutable outside the package, and therefore it is safe to return them to the caller for informational purposes. The AccessControlEntry information is needed so that invocations of update and delete methods on the MutableAcl can refer to a valid AccessControlEntry.getId().

Specified by:

getEntries in interface Acl

Returns:

DOCUMENT ME!

getId

Serializable getId()

Obtains an identifier that represents this MutableAcl.

Returns:

the identifier, or null if unsaved

insertAce

void insertAce(Serializable afterAceId,
               Permission permission,
               Sid sid,
               boolean granting)
        throws NotFoundException

Throws:

NotFoundException

setEntriesInheriting

void setEntriesInheriting(boolean entriesInheriting)

Change the value returned by Acl.isEntriesInheriting().

Parameters:

entriesInheriting - the new value

setParent

void setParent(Acl newParent)

Changes the parent of this ACL.

Parameters:

newParent - the new parent

updateAce

void updateAce(Serializable aceId,
               Permission permission)
        throws NotFoundException

Throws:

NotFoundException