org.acegisecurity.acl.basic.BasicAclDao Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of acegi-security
There is a newer version: 1.0.7
/* Copyright 2004 Acegi Technology Pty Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.acegisecurity.acl.basic;

/**
 * Represents a data access object that can return the {@link BasicAclEntry}s
 * applying to a given ACL object identity.
 * 
 * 
 * BasicAclDao implementations are responsible for interpreting a
 * given {@link AclObjectIdentity} and being able to lookup and return the
 * corresponding {@link BasicAclEntry}[]s.
 * 
 * 
 * 
 * BasicAclDaos many, but are not required to, allow the backend
 * ACL repository to specify the class of BasicAclEntry
 * implementations that should be returned.
 * 
 *
 * @author Ben Alex
 * @version $Id: BasicAclDao.java,v 1.2 2005/11/17 00:55:47 benalex Exp $
 */
public interface BasicAclDao {
    //~ Methods ================================================================

    /**
     * Obtains the ACLs that apply to the specified domain instance.
     * 
     * 
     * Does not perform caching, include ACLs from any inheritance
     * hierarchy or filter returned objects based on effective permissions.
     * Implementations are solely responsible for returning ACLs found in the
     * ACL repository for the specified object identity.
     * 
     *
     * @param aclObjectIdentity the domain object instance that ACL information
     *        is being requested for (never null)
     *
     * @return the ACLs that apply (no nulls are permitted in the
     *         array), or null if no ACLs could be found for the
     *         specified ACL object identity
     */
    public BasicAclEntry[] getAcls(AclObjectIdentity aclObjectIdentity);
}