org.acegisecurity.afterinvocation.AfterInvocationProvider 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.afterinvocation;

import org.acegisecurity.AccessDeniedException;
import org.acegisecurity.Authentication;
import org.acegisecurity.ConfigAttribute;
import org.acegisecurity.ConfigAttributeDefinition;


/**
 * Indicates a class is responsible for participating in an {@link
 * AfterInvocationProviderManager} decision.
 *
 * @author Ben Alex
 * @version $Id: AfterInvocationProvider.java 1496 2006-05-23 13:38:33Z benalex $
 */
public interface AfterInvocationProvider {
    //~ Methods ========================================================================================================

    public Object decide(Authentication authentication, Object object, ConfigAttributeDefinition config,
        Object returnedObject) throws AccessDeniedException;

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

    /**
     * Indicates whether the AfterInvocationProvider is able to provide "after invocation"
     * processing for the indicated secured object type.
     *
     * @param clazz the class of secure object that is being queried
     *
     * @return true if the implementation can process the indicated class
     */
    public boolean supports(Class clazz);
}