org.jboss.security.acl.ACLRegistration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of acl-spi Show documentation

PicketBox is a security project for Java applications.

There is a newer version: 5.1.0.Final

package org.jboss.security.acl;

import java.util.Collection;

import org.jboss.security.authorization.Resource;

/**
 * 
 * Interface to register {@code ACL}s.
 * 
 * 
 * @author Stefan Guilhen
 */
public interface ACLRegistration
{

   /**
    * 
    * Registers an {@code ACL} associated with the specified {@code Resource}. This usually means interacting
    * with a {@code ACLPersistenceStrategy} to persist the created {@code ACL}.
    * 
    * 
    * @param resource    the {@code Resource} for which an {@code ACL} is to be registered.
    */
   public void registerACL(Resource resource);

   /**
    * 
    * Registers an {@code ACL} associated with the specified {@code Resource} using the supplied entries.
    * 
    * 
    * @param resource    the {@code Resource} for which an {@code ACL} is to be registered.
    * @param entries    the entries of the {@code ACL} being registered.
    */
   public void registerACL(Resource resource, Collection entries);

   /**
    * 
    * Deregisters the {@code ACL} associated with the specified resource.
    * 
    * 
    * @param resource    the {@code Resource} for which an {@code ACL} is to be deregistered.
    */
   public void deRegisterACL(Resource resource);
}