org.acegisecurity.AccessDecisionManager 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, 2005 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;

/**
 * Makes a final access control (authorization) decision.
 *
 * @author Ben Alex
 * @version $Id: AccessDecisionManager.java,v 1.8 2005/11/17 00:55:49 benalex Exp $
 */
public interface AccessDecisionManager {
    //~ Methods ================================================================

    /**
     * Resolves an access control decision for the passed parameters.
     *
     * @param authentication the caller invoking the method
     * @param object the secured object being called
     * @param config the configuration attributes associated with the secured
     *        object being invoked
     *
     * @throws AccessDeniedException if access is denied as the authentication
     *         does not hold a required authority or ACL privilege
     * @throws InsufficientAuthenticationException if access is denied as the
     *         authentication does not provide a sufficient level of trust
     */
    public void decide(Authentication authentication, Object object,
        ConfigAttributeDefinition config)
        throws AccessDeniedException, InsufficientAuthenticationException;

    /**
     * Indicates whether this AccessDecisionManager is able to
     * process authorization requests presented with the passed
     * ConfigAttribute.
     * 
     * 
     * This allows the AbstractSecurityInterceptor to check every
     * configuration attribute can be consumed by the configured
     * AccessDecisionManager and/or RunAsManager
     * and/or AfterInvocationManager.
     * 
     *
     * @param attribute a configuration attribute that has been configured
     *        against the AbstractSecurityInterceptor
     *
     * @return true if this AccessDecisionManager can support the
     *         passed configuration attribute
     */
    public boolean supports(ConfigAttribute attribute);

    /**
     * Indicates whether the AccessDecisionManager implementation
     * is able to provide access control decisions for the indicated secured
     * object type.
     *
     * @param clazz the class that is being queried
     *
     * @return true if the implementation can process the
     *         indicated class
     */
    public boolean supports(Class clazz);
}