org.acegisecurity.acl.AclManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of acegi-security Show documentation

There is a newer version: 1.0.7

/* Copyright 2004, 2005, 2006 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;

import org.acegisecurity.Authentication;


/**
 * Obtains the AclEntry instances that apply to a particular
 * domain object instance.
 *
 * @author Ben Alex
 * @version $Id: AclManager.java 1496 2006-05-23 13:38:33Z benalex $
 */
public interface AclManager {
    //~ Methods ========================================================================================================

    /**
     * Obtains the ACLs that apply to the specified domain instance.
     *
     * @param domainInstance the instance for which ACL information is required (never null)
     *
     * @return the ACLs that apply, or null if no ACLs apply to the specified domain instance
     */
    public AclEntry[] getAcls(Object domainInstance);

    /**
     * Obtains the ACLs that apply to the specified domain instance, but only including those ACLs which have
     * been granted to the presented Authentication object
     *
     * @param domainInstance the instance for which ACL information is required (never null)
     * @param authentication the prncipal for which ACL information should be filtered (never null)
     *
     * @return only those ACLs applying to the domain instance that have been granted to the principal (or
     *         null) if no such ACLs are found
     */
    public AclEntry[] getAcls(Object domainInstance, Authentication authentication);
}