AccessControlProvider.java revision 85fa1db655ec75262d9042259f86e7b9ce5c312b
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
* add the following below this CDDL HEADER, with the fields enclosed
* by brackets "[]" replaced with your own identifying information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Portions Copyright 2006-2007 Sun Microsystems, Inc.
*/
/**
* This class defines an interface for managing the life-cycle of an
* access control handler. The access control handler configuration
* should specify the name of a class implementing this interface.
*
* @param <T>
* The type of access control configuration handled by
* this access control provider implementation.
*/
public interface AccessControlProvider
<T extends AccessControlHandlerCfg>
{
/**
* Initializes the access control handler implementation based on
* the information in the provided configuration entry.
*
* @param configuration
* The configuration object that contains the information
* to use to initialize this access control handler.
* @throws ConfigException
* If an unrecoverable problem arises in the process of
* performing the initialization.
* @throws InitializationException
* If a problem occurs during initialization that is not
* related to the server configuration.
*/
public void initializeAccessControlHandler(T configuration)
throws ConfigException, InitializationException;
/**
* Performs any necessary finalization for the access control
* handler implementation. This will be called just after the
* handler has been deregistered with the server but before it has
* been unloaded.
*/
public void finalizeAccessControlHandler();
/**
* Get the access control handler responsible for making access
* control decisions. This method is called each time an access
* control decision is needed.
*
* @return Returns the access control handler.
*/
}