ExactMatchIdentityMapper.java revision ea1068c292e9b341af6d6b563cd8988a96be20a9
/*
* 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 legal-notices/CDDLv1_0.txt
* 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 legal-notices/CDDLv1_0.txt.
* 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
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
* Portions Copyright 2014-2015 ForgeRock AS
*/
/**
* This class provides an implementation of a Directory Server identity mapper
* that looks for the exact value provided as the ID string to appear in an
* attribute of a user's entry. This mapper may be configured to look in one or
* more attributes using zero or more search bases. In order for the mapping to
* be established properly, exactly one entry must have an attribute that
* exactly matches (according to the equality matching rule associated with that
* attribute) the ID value.
*/
public class ExactMatchIdentityMapper
implements ConfigurationChangeListener<
{
// The set of attribute types to use when performing lookups.
private AttributeType[] attributeTypes;
// The DN of the configuration entry for this identity mapper.
private DN configEntryDN;
// The current configuration for this identity mapper.
private ExactMatchIdentityMapperCfg currentConfig;
// The set of attributes to return in search result entries.
/**
* Creates a new instance of this exact match identity mapper. All
* initialization should be performed in the {@code initializeIdentityMapper}
* method.
*/
public ExactMatchIdentityMapper()
{
super();
// Don't do any initialization here.
}
/**
* {@inheritDoc}
*/
public void initializeIdentityMapper(
{
// Get the attribute types to use for the searches. Ensure that they are
// all indexed for equality.
{
}
for (AttributeType t : attributeTypes)
{
{
{
}
}
}
// Create the attribute list to include in search requests. We want to
// include all user and operational attributes.
}
/**
* Performs any finalization that may be necessary for this identity mapper.
*/
public void finalizeIdentityMapper()
{
}
/**
* 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.
*/
throws DirectoryException
{
// Construct the search filter to use to make the determination.
{
}
else
{
for (AttributeType t : attributeTypes)
{
}
}
// Iterate through the set of search bases and process an internal search
// to find any matching entries. Since we'll only allow a single match,
// then use size and time limits to constrain costly searches resulting from
// non-unique or inefficient criteria.
{
}
{
.setSizeLimit(1)
.setTimeLimit(10)
{
case SUCCESS:
// This is fine. No action needed.
break;
case NO_SUCH_OBJECT:
// The search base doesn't exist. Not an ideal situation, but we'll
// ignore it.
break;
case SIZE_LIMIT_EXCEEDED:
// Multiple entries matched the filter. This is not acceptable.
case TIME_LIMIT_EXCEEDED:
case ADMIN_LIMIT_EXCEEDED:
// The search criteria was too inefficient.
default:
// Just pass on the failure that was returned for this search.
}
{
if (matchingEntry == null)
{
{
}
}
else
{
}
}
}
return matchingEntry;
}
/**
* {@inheritDoc}
*/
{
}
/**
* {@inheritDoc}
*/
public boolean isConfigurationChangeAcceptable(
{
boolean configAcceptable = true;
// Make sure that all of the configured attributes are indexed for equality
// in all appropriate backends.
{
}
{
{
{
configAcceptable = false;
}
}
}
return configAcceptable;
}
/**
* {@inheritDoc}
*/
{
return ccr;
}
}