Package org.jboss.security.acl

Class JPAPersistenceStrategy

java.lang.Object

org.jboss.security.acl.JPAPersistenceStrategy

All Implemented Interfaces:

ACLPersistenceStrategy

public class JPAPersistenceStrategy
extends Object
implements ACLPersistenceStrategy

Implementation of ACLPersistenceStrategy that uses the Java Persistence API (JPA) to persist the ACLs.

Author:

Stefan Guilhen

Constructor Summary

Constructors

Constructor	Description
JPAPersistenceStrategy()
JPAPersistenceStrategy(ACLResourceFactory resourceFactory)

Method Summary

Modifier and Type	Method	Description
ACL	createACL(Resource resource)	Creates a new ACL and associates it to the given resource.
ACL	createACL(Resource resource, Collection<ACLEntry> entries)	Creates a new ACL with the specified entries and associates it to the given resource.
ACL	getACL(Resource resource)	Obtains a reference to the ACL associated to the given resource.
Collection<ACL>	getACLs()	Obtains all ACLs that are managed by this ACLPersistenceStrategy.
boolean	removeACL(ACL acl)	Removes the given ACL, breaking the existing association with the resource it relates to.
boolean	removeACL(Resource resource)	Removes the ACL associated with the specified resource.
boolean	updateACL(ACL acl)	Updates the given ACL.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JPAPersistenceStrategy

public JPAPersistenceStrategy()

JPAPersistenceStrategy

public JPAPersistenceStrategy(ACLResourceFactory resourceFactory)

Method Detail

createACL

public ACL createACL(Resource resource)

Description copied from interface: ACLPersistenceStrategy

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

Specified by:

createACL in interface ACLPersistenceStrategy

Parameters:

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

Returns:

a reference to the created ACL.

createACL

public ACL createACL(Resource resource,
                     Collection<ACLEntry> entries)

Description copied from interface: ACLPersistenceStrategy

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

Specified by:

createACL in interface ACLPersistenceStrategy

Parameters:

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

entries - a Collection containing the entries that must be added to the ACL.

Returns:

a reference to the created ACL.

removeACL

public boolean removeACL(ACL acl)

Description copied from interface: ACLPersistenceStrategy

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

Specified by:

removeACL in interface ACLPersistenceStrategy

Parameters:

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

Returns:

true if the ACL was removed; false otherwise.

removeACL

public boolean removeACL(Resource resource)

Description copied from interface: ACLPersistenceStrategy

Removes the ACL associated with the specified resource.

Specified by:

removeACL in interface ACLPersistenceStrategy

Parameters:

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

Returns:

true if the ACL was removed; false otherwise.

getACL

public ACL getACL(Resource resource)

Description copied from interface: ACLPersistenceStrategy

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

Specified by:

getACL in interface ACLPersistenceStrategy

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.

getACLs

public Collection<ACL> getACLs()

Description copied from interface: ACLPersistenceStrategy

Obtains all ACLs that are managed by this ACLPersistenceStrategy.

Specified by:

getACLs in interface ACLPersistenceStrategy

Returns:

a Collection containing all ACLs retrieved by this strategy.

updateACL

public boolean updateACL(ACL acl)

Description copied from interface: ACLPersistenceStrategy

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

Specified by:

updateACL in interface ACLPersistenceStrategy

Parameters:

acl - the ACL that needs to be updated.

Returns:

true if the ACL was updated; false otherwise.