/* 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.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 1784 2007-02-24 21:00:24Z luke_t $

  */

 public interface ObjectDefinitionSource {

     //~ Methods ========================================================================================================

     /**

      * Accesses the <code>ConfigAttributeDefinition</code> that applies to a given secure object.<P>Returns

      * <code>null</code> if no <code>ConfigAttribiteDefinition</code> applies.</p>

      *

      * @param object the object being secured

      *

      * @return the <code>ConfigAttributeDefinition</code> that applies to the passed object

      *

      * @throws IllegalArgumentException if the passed object is not of a type supported by the

      *         <code>ObjectDefinitionSource</code> implementation

      */

     ConfigAttributeDefinition getAttributes(Object object)

         throws IllegalArgumentException;

     /**

      * If available, all of the <code>ConfigAttributeDefinition</code>s defined by the implementing class.<P>This

      * is used by the {@link AbstractSecurityInterceptor} to perform startup time validation of each

      * <code>ConfigAttribute</code> configured against it.</p>

      *

      * @return an iterator over all the <code>ConfigAttributeDefinition</code>s or <code>null</code> if unsupported

      */

     Iterator getConfigAttributeDefinitions();

     /**

      * Indicates whether the <code>ObjectDefinitionSource</code> implementation is able to provide

      * <code>ConfigAttributeDefinition</code>s for the indicated secure object type.

      *

      * @param clazz the class that is being queried

      *

      * @return true if the implementation can process the indicated class

      */

     boolean supports(Class clazz);

 }