org.jboss.security.acl
Interface ACLProvider

public interface ACLProvider

An ACLProvider is responsible for the management of the ACLs associated to the resources being protected. Implementations of this interface will tipically interact with some sort of repository, where the ACLs are stored.

Author:

Stefan Guilhen

Method Summary

ACL	createACL(org.jboss.security.authorization.Resource resource) Creates a new ACL and associates it to the given resource.
boolean	removeACL(ACL acl) Removes the given ACL, breaking the existing association with the resource it relates to.
boolean	removeACL(org.jboss.security.authorization.Resource resource) Removes the ACL associated with the specified resource.
ACL	retrieveACL(org.jboss.security.authorization.Resource resource) Obtains a reference to the ACL associated to the given resource.
boolean	updateACL(ACL acl) Updates the given ACL.

Method Detail

retrieveACL

ACL retrieveACL(org.jboss.security.authorization.Resource resource)

Obtains a reference to the ACL associated to the given resource.

Parameters:

resource - the Resource for which the associated ACL is wanted.

Returns:

a reference to the ACL associated with the resource, or null if no ACL could be found.

createACL

ACL createACL(org.jboss.security.authorization.Resource resource)

Creates a new ACL and associates it to the given resource.

Parameters:

resource - the Resource for which an ACL is to be created.

Returns:

a reference to the created ACL.

updateACL

boolean updateACL(ACL acl)

Updates the given ACL. This usually means updating the repository where the ACLs are stored.

Parameters:

acl - the ACL that needs to be updated.

Returns:

true if the ACL was updated; false otherwise.

removeACL

boolean removeACL(ACL acl)

Removes the given ACL, breaking the existing association with the resource it relates to.

Parameters:

acl - a reference to the ACL that is to be removed.

Returns:

true if the ACL was removed; false otherwise.

removeACL

boolean removeACL(org.jboss.security.authorization.Resource resource)

Removes the ACL associated with the specified resource.

Parameters:

resource - the Resource whose associated ACL is to be removed.

Returns:

true if the ACL was removed; false otherwise.