/*
|
* 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
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
|
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
|
* 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 Sun Microsystems, Inc.
|
*/
|
package org.opends.server.api;
|
|
|
|
import org.opends.server.config.ConfigEntry;
|
import org.opends.server.config.ConfigException;
|
import org.opends.server.types.DirectoryException;
|
import org.opends.server.types.Entry;
|
import org.opends.server.types.InitializationException;
|
|
import static org.opends.server.loggers.Debug.*;
|
|
|
|
/**
|
* This class defines the set of methods and structures that must be
|
* implemented by a Directory Server identity mapper. An identity
|
* mapper is used to identify exactly one user associated with a given
|
* identification value. This API may be used by a number of SASL
|
* mechanisms to identify the user that is authenticating to the
|
* server. It may also be used in other areas, like in conjunction
|
* with the proxied authorization control.
|
*/
|
public abstract class IdentityMapper
|
{
|
/**
|
* The fully-qualified name of this class for debugging purposes.
|
*/
|
private static final String CLASS_NAME =
|
"org.opends.server.api.IdentityMapper";
|
|
|
|
/**
|
* Initializes this identity mapper based on the information in the
|
* provided configuration entry.
|
*
|
* @param configEntry The configuration entry that contains the
|
* information to use to initialize this
|
* identity mapper.
|
*
|
* @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 abstract void initializeIdentityMapper(
|
ConfigEntry configEntry)
|
throws ConfigException, InitializationException;
|
|
|
|
/**
|
* Performs any finalization that may be necessary for this identity
|
* mapper. By default, no finalization is performed.
|
*/
|
public void finalizeIdentityMapper()
|
{
|
assert debugEnter(CLASS_NAME, "finalizeIdentityMapper");
|
|
// No implementation is required by default.
|
}
|
|
|
|
/**
|
* Retrieves the user entry that was mapped to the provided
|
* identification string.
|
*
|
* @param id The identification string that is to be mapped to a
|
* user.
|
*
|
* @return The user entry that was mapped to the provided
|
* identification, or <CODE>null</CODE> if no users were
|
* found that could be mapped to the provided ID.
|
*
|
* @throws DirectoryException If a problem occurs while attempting
|
* to map the given ID to a user entry,
|
* or if there are multiple user
|
* entries that could map to the
|
* provided ID.
|
*/
|
public abstract Entry getEntryForID(String id)
|
throws DirectoryException;
|
}
|
