org.acegisecurity.intercept.ObjectDefinitionSource 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.intercept;

import org.acegisecurity.ConfigAttributeDefinition;

import java.util.Iterator;


/**
 * Implemented by classes that store and can identify the {@link
 * ConfigAttributeDefinition} that applies to a given secure object
 * invocation.
 *
 * @author Ben Alex
 * @version $Id: ObjectDefinitionSource.java,v 1.3 2005/11/17 00:55:51 benalex Exp $
 */
public interface ObjectDefinitionSource {
    //~ Methods ================================================================

    /**
     * Accesses the ConfigAttributeDefinition that applies to a
     * given secure object.
     * 
     * 
     * Returns null if no ConfigAttribiteDefinition
     * applies.
     * 
     *
     * @param object the object being secured
     *
     * @return the ConfigAttributeDefinition that applies to the
     *         passed object
     *
     * @throws IllegalArgumentException if the passed object is not of a type
     *         supported by the ObjectDefinitionSource
     *         implementation
     */
    public ConfigAttributeDefinition getAttributes(Object object)
        throws IllegalArgumentException;

    /**
     * If available, all of the ConfigAttributeDefinitions defined
     * by the implementing class.
     * 
     * 
     * This is used by the {@link AbstractSecurityInterceptor} to perform
     * startup time validation of each ConfigAttribute configured
     * against it.
     * 
     *
     * @return an iterator over all the ConfigAttributeDefinitions
     *         or null if unsupported
     */
    public Iterator getConfigAttributeDefinitions();

    /**
     * Indicates whether the ObjectDefinitionSource implementation
     * is able to provide ConfigAttributeDefinitions for the
     * indicated secure 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);
}