/*
|
* 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
|
* or http://forgerock.org/license/CDDLv1.0.html.
|
* 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-2010 Sun Microsystems, Inc.
|
* Portions Copyright 2011-2014 ForgeRock AS
|
* Portions Copyright 2014 Manuel Gaupp
|
*/
|
package org.opends.server.backends.jeb;
|
|
import java.util.*;
|
import java.util.concurrent.atomic.AtomicBoolean;
|
|
import org.forgerock.i18n.LocalizableMessage;
|
import org.forgerock.i18n.LocalizableMessageBuilder;
|
import org.forgerock.i18n.slf4j.LocalizedLogger;
|
import org.forgerock.opendj.config.server.ConfigException;
|
import org.forgerock.opendj.ldap.Assertion;
|
import org.forgerock.opendj.ldap.ByteString;
|
import org.forgerock.opendj.ldap.DecodeException;
|
import org.forgerock.opendj.ldap.ResultCode;
|
import org.forgerock.opendj.ldap.schema.MatchingRule;
|
import org.forgerock.opendj.ldap.spi.IndexQueryFactory;
|
import org.forgerock.opendj.ldap.spi.IndexingOptions;
|
import org.forgerock.util.Utils;
|
import org.opends.server.admin.server.ConfigurationChangeListener;
|
import org.opends.server.admin.std.meta.LocalDBIndexCfgDefn.IndexType;
|
import org.opends.server.admin.std.server.LocalDBIndexCfg;
|
import org.opends.server.core.DirectoryServer;
|
import org.opends.server.monitors.DatabaseEnvironmentMonitor;
|
import org.opends.server.types.*;
|
import org.opends.server.util.StaticUtils;
|
|
import com.sleepycat.je.DatabaseEntry;
|
import com.sleepycat.je.DatabaseException;
|
import com.sleepycat.je.Environment;
|
import com.sleepycat.je.Transaction;
|
|
import static org.opends.messages.JebMessages.*;
|
import static org.opends.server.util.ServerConstants.*;
|
import static org.opends.server.util.StaticUtils.*;
|
|
/**
|
* Class representing an attribute index.
|
* We have a separate database for each type of indexing, which makes it easy
|
* to tell which attribute indexes are configured. The different types of
|
* indexing are equality, presence, substrings and ordering. The keys in the
|
* ordering index are ordered by setting the btree comparator to the ordering
|
* matching rule comparator.
|
* Note that the values in the equality index are normalized by the equality
|
* matching rule, whereas the values in the ordering index are normalized
|
* by the ordering matching rule. If these could be guaranteed to be identical
|
* then we would not need a separate ordering index.
|
*/
|
public class AttributeIndex
|
implements ConfigurationChangeListener<LocalDBIndexCfg>
|
{
|
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
|
|
/** Type of the index filter. */
|
static enum IndexFilterType
|
{
|
/** Equality. */
|
EQUALITY(IndexType.EQUALITY),
|
/** Presence. */
|
PRESENCE(IndexType.PRESENCE),
|
/** Ordering. */
|
GREATER_OR_EQUAL(IndexType.ORDERING),
|
/** Ordering. */
|
LESS_OR_EQUAL(IndexType.ORDERING),
|
/** Substring. */
|
SUBSTRING(IndexType.SUBSTRING),
|
/** Approximate. */
|
APPROXIMATE(IndexType.APPROXIMATE);
|
|
private final IndexType indexType;
|
|
private IndexFilterType(IndexType indexType)
|
{
|
this.indexType = indexType;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public String toString()
|
{
|
return indexType.toString();
|
}
|
}
|
|
/*
|
* FIXME Matthew Swift: Once the matching rules have been migrated we should
|
* revisit this class. All of the evaluateXXX methods should go (the Matcher
|
* class in the SDK could implement the logic, I hope).
|
*/
|
|
/**
|
* A database key for the presence index.
|
*/
|
public static final DatabaseEntry presenceKey =
|
new DatabaseEntry("+".getBytes());
|
|
/**
|
* The entryContainer in which this attribute index resides.
|
*/
|
private EntryContainer entryContainer;
|
private Environment env;
|
private State state;
|
|
/**
|
* The attribute index configuration.
|
*/
|
private LocalDBIndexCfg indexConfig;
|
|
/** The mapping from names to indexes. */
|
private final Map<String, Index> nameToIndexes;
|
private final IndexQueryFactory<IndexQuery> indexQueryFactory;
|
|
private int cursorEntryLimit = 100000;
|
|
/**
|
* The mapping from extensible index types (e.g. "substring" or "shared") to list of indexes.
|
*/
|
private Map<String, Collection<Index>> extensibleIndexesMapping;
|
|
/**
|
* Create a new attribute index object.
|
*
|
* @param entryContainer The entryContainer of this attribute index.
|
* @param state The state database to persist index state info.
|
* @param env The JE environment handle.
|
* @param indexConfig The attribute index configuration.
|
* @throws DatabaseException if a JE database error occurs.
|
* @throws ConfigException if a configuration related error occurs.
|
*/
|
public AttributeIndex(LocalDBIndexCfg indexConfig, State state,
|
Environment env, EntryContainer entryContainer)
|
throws DatabaseException, ConfigException
|
{
|
this.entryContainer = entryContainer;
|
this.env = env;
|
this.indexConfig = indexConfig;
|
this.state = state;
|
nameToIndexes = new HashMap<String, Index>();
|
|
AttributeType attrType = indexConfig.getAttribute();
|
String name = entryContainer.getDatabasePrefix() + "_" + attrType.getNameOrOID();
|
|
buildPresenceIndex(indexConfig, name);
|
buildIndexes(IndexType.EQUALITY, indexConfig, name);
|
buildIndexes(IndexType.SUBSTRING, indexConfig, name);
|
buildIndexes(IndexType.ORDERING, indexConfig, name);
|
buildIndexes(IndexType.APPROXIMATE, indexConfig, name);
|
buildExtensibleIndexes(indexConfig, name);
|
|
final JEIndexConfig config = new JEIndexConfig(indexConfig.getSubstringLength());
|
indexQueryFactory = new IndexQueryFactoryImpl(nameToIndexes, config);
|
extensibleIndexesMapping = computeExtensibleIndexesMapping();
|
}
|
|
private void buildPresenceIndex(LocalDBIndexCfg indexConfig, String name)
|
{
|
IndexType indexType = IndexType.PRESENCE;
|
if (indexConfig.getIndexType().contains(indexType))
|
{
|
final AttributeType attrType = indexConfig.getAttribute();
|
final int indexEntryLimit = indexConfig.getIndexEntryLimit();
|
String indexID = indexType.toString();
|
String indexName = name + "." + indexID;
|
Index presenceIndex = newIndex(indexName, indexEntryLimit, new PresenceIndexer(attrType));
|
nameToIndexes.put(indexID, presenceIndex);
|
}
|
}
|
|
private void buildExtensibleIndexes(LocalDBIndexCfg indexConfig, String name) throws ConfigException
|
{
|
final IndexType indexType = IndexType.EXTENSIBLE;
|
if (indexConfig.getIndexType().contains(indexType))
|
{
|
final AttributeType attrType = indexConfig.getAttribute();
|
Set<String> extensibleRules = indexConfig.getIndexExtensibleMatchingRule();
|
if (extensibleRules == null || extensibleRules.isEmpty())
|
{
|
throw new ConfigException(ERR_CONFIG_INDEX_TYPE_NEEDS_MATCHING_RULE.get(attrType, indexType.toString()));
|
}
|
|
// Iterate through the Set and create the index only if necessary.
|
// Collation equality and Ordering matching rules share the same indexer and index
|
// A Collation substring matching rule is treated differently
|
// as it uses a separate indexer and index.
|
final int indexEntryLimit = indexConfig.getIndexEntryLimit();
|
for (final String ruleName : extensibleRules)
|
{
|
MatchingRule rule = DirectoryServer.getMatchingRule(toLowerCase(ruleName));
|
if (rule == null)
|
{
|
logger.error(ERR_CONFIG_INDEX_TYPE_NEEDS_VALID_MATCHING_RULE, attrType, ruleName);
|
continue;
|
}
|
for (org.forgerock.opendj.ldap.spi.Indexer indexer : rule.getIndexers())
|
{
|
final String indexId = indexer.getIndexID();
|
if (!nameToIndexes.containsKey(indexId))
|
{
|
// There is no index available for this index id. Create a new index
|
final Index index = newAttributeIndex(attrType, name, indexEntryLimit, indexer);
|
nameToIndexes.put(indexId, index);
|
}
|
}
|
}
|
}
|
}
|
|
private Index newIndex(String indexName, int indexEntryLimit, Indexer indexer)
|
{
|
return new Index(indexName, indexer, state, indexEntryLimit, cursorEntryLimit, false, env, entryContainer);
|
}
|
|
private void buildIndexes(IndexType indexType, LocalDBIndexCfg cfg, String name) throws ConfigException
|
{
|
if (cfg.getIndexType().contains(indexType))
|
{
|
final AttributeType attrType = indexConfig.getAttribute();
|
final String indexID = indexType.toString();
|
final MatchingRule rule = getMatchingRule(indexType, attrType);
|
if (rule == null)
|
{
|
throw new ConfigException(ERR_CONFIG_INDEX_TYPE_NEEDS_MATCHING_RULE.get(attrType, indexID));
|
}
|
|
for (org.forgerock.opendj.ldap.spi.Indexer indexer : rule.getIndexers())
|
{
|
final Index index = newAttributeIndex(attrType, name, cfg.getIndexEntryLimit(), indexer);
|
nameToIndexes.put(indexID, index);
|
}
|
}
|
}
|
|
private MatchingRule getMatchingRule(IndexType indexType, AttributeType attrType)
|
{
|
switch (indexType)
|
{
|
case APPROXIMATE:
|
return attrType.getApproximateMatchingRule();
|
case EQUALITY:
|
return attrType.getEqualityMatchingRule();
|
case ORDERING:
|
return attrType.getOrderingMatchingRule();
|
case SUBSTRING:
|
return attrType.getSubstringMatchingRule();
|
default:
|
throw new IllegalArgumentException("Not implemented for index type " + indexType);
|
}
|
}
|
|
private Index newAttributeIndex(AttributeType attrType, String name, final int indexEntryLimit,
|
org.forgerock.opendj.ldap.spi.Indexer indexer)
|
{
|
final String indexName = name + "." + indexer.getIndexID();
|
final AttributeIndexer attrIndexer = new AttributeIndexer(attrType, indexer);
|
return newIndex(indexName, indexEntryLimit, attrIndexer);
|
}
|
|
/**
|
* Open the attribute index.
|
*
|
* @throws DatabaseException if a JE database error occurs while
|
* opening the index.
|
*/
|
public void open() throws DatabaseException
|
{
|
for (Index index : nameToIndexes.values())
|
{
|
index.open();
|
}
|
indexConfig.addChangeListener(this);
|
}
|
|
/**
|
* Close the attribute index.
|
*
|
* @throws DatabaseException if a JE database error occurs while
|
* closing the index.
|
*/
|
public void close() throws DatabaseException
|
{
|
Utils.closeSilently(nameToIndexes.values());
|
indexConfig.removeChangeListener(this);
|
// The entryContainer is responsible for closing the JE databases.
|
}
|
|
/**
|
* Get the attribute type of this attribute index.
|
* @return The attribute type of this attribute index.
|
*/
|
public AttributeType getAttributeType()
|
{
|
return indexConfig.getAttribute();
|
}
|
|
/**
|
* Return the indexing options of this AttributeIndex.
|
*
|
* @return the indexing options of this AttributeIndex.
|
*/
|
public IndexingOptions getIndexingOptions()
|
{
|
return indexQueryFactory.getIndexingOptions();
|
}
|
|
/**
|
* Get the JE index configuration used by this index.
|
* @return The configuration in effect.
|
*/
|
public LocalDBIndexCfg getConfiguration()
|
{
|
return indexConfig;
|
}
|
|
/**
|
* Update the attribute index for a new entry.
|
*
|
* @param buffer The index buffer to use to store the added keys
|
* @param entryID The entry ID.
|
* @param entry The contents of the new entry.
|
* @return True if all the index keys for the entry are added. False if the
|
* entry ID already exists for some keys.
|
* @throws DatabaseException If an error occurs in the JE database.
|
* @throws DirectoryException If a Directory Server error occurs.
|
*/
|
public boolean addEntry(IndexBuffer buffer, EntryID entryID, Entry entry)
|
throws DatabaseException, DirectoryException
|
{
|
boolean success = true;
|
|
final IndexingOptions options = indexQueryFactory.getIndexingOptions();
|
for (Index index : nameToIndexes.values())
|
{
|
if (!index.addEntry(buffer, entryID, entry, options))
|
{
|
success = false;
|
}
|
}
|
return success;
|
}
|
|
/**
|
* Update the attribute index for a new entry.
|
*
|
* @param txn The database transaction to be used for the insertions.
|
* @param entryID The entry ID.
|
* @param entry The contents of the new entry.
|
* @return True if all the index keys for the entry are added. False if the
|
* entry ID already exists for some keys.
|
* @throws DatabaseException If an error occurs in the JE database.
|
* @throws DirectoryException If a Directory Server error occurs.
|
*/
|
public boolean addEntry(Transaction txn, EntryID entryID, Entry entry)
|
throws DatabaseException, DirectoryException
|
{
|
boolean success = true;
|
|
final IndexingOptions options = indexQueryFactory.getIndexingOptions();
|
for (Index index : nameToIndexes.values())
|
{
|
if (!index.addEntry(txn, entryID, entry, options))
|
{
|
success = false;
|
}
|
}
|
return success;
|
}
|
|
/**
|
* Update the attribute index for a deleted entry.
|
*
|
* @param buffer The index buffer to use to store the deleted keys
|
* @param entryID The entry ID
|
* @param entry The contents of the deleted entry.
|
* @throws DatabaseException If an error occurs in the JE database.
|
* @throws DirectoryException If a Directory Server error occurs.
|
*/
|
public void removeEntry(IndexBuffer buffer, EntryID entryID, Entry entry)
|
throws DatabaseException, DirectoryException
|
{
|
final IndexingOptions options = indexQueryFactory.getIndexingOptions();
|
for (Index index : nameToIndexes.values())
|
{
|
index.removeEntry(buffer, entryID, entry, options);
|
}
|
}
|
|
/**
|
* Update the attribute index for a deleted entry.
|
*
|
* @param txn The database transaction to be used for the deletions
|
* @param entryID The entry ID
|
* @param entry The contents of the deleted entry.
|
* @throws DatabaseException If an error occurs in the JE database.
|
* @throws DirectoryException If a Directory Server error occurs.
|
*/
|
public void removeEntry(Transaction txn, EntryID entryID, Entry entry)
|
throws DatabaseException, DirectoryException
|
{
|
final IndexingOptions options = indexQueryFactory.getIndexingOptions();
|
for (Index index : nameToIndexes.values())
|
{
|
index.removeEntry(txn, entryID, entry, options);
|
}
|
}
|
|
/**
|
* Update the index to reflect a sequence of modifications in a Modify
|
* operation.
|
*
|
* @param txn The JE transaction to use for database updates.
|
* @param entryID The ID of the entry that was modified.
|
* @param oldEntry The entry before the modifications were applied.
|
* @param newEntry The entry after the modifications were applied.
|
* @param mods The sequence of modifications in the Modify operation.
|
* @throws DatabaseException If an error occurs during an operation on a
|
* JE database.
|
*/
|
public void modifyEntry(Transaction txn,
|
EntryID entryID,
|
Entry oldEntry,
|
Entry newEntry,
|
List<Modification> mods)
|
throws DatabaseException
|
{
|
final IndexingOptions options = indexQueryFactory.getIndexingOptions();
|
for (Index index : nameToIndexes.values())
|
{
|
index.modifyEntry(txn, entryID, oldEntry, newEntry, mods, options);
|
}
|
}
|
|
/**
|
* Update the index to reflect a sequence of modifications in a Modify
|
* operation.
|
*
|
* @param buffer The index buffer used to buffer up the index changes.
|
* @param entryID The ID of the entry that was modified.
|
* @param oldEntry The entry before the modifications were applied.
|
* @param newEntry The entry after the modifications were applied.
|
* @param mods The sequence of modifications in the Modify operation.
|
* @throws DatabaseException If an error occurs during an operation on a
|
* JE database.
|
*/
|
public void modifyEntry(IndexBuffer buffer,
|
EntryID entryID,
|
Entry oldEntry,
|
Entry newEntry,
|
List<Modification> mods)
|
throws DatabaseException
|
{
|
final IndexingOptions options = indexQueryFactory.getIndexingOptions();
|
for (Index index : nameToIndexes.values())
|
{
|
index.modifyEntry(buffer, entryID, oldEntry, newEntry, mods, options);
|
}
|
}
|
|
/**
|
* Makes a byte array representing a substring index key for
|
* one substring of a value.
|
*
|
* @param bytes The byte array containing the value.
|
* @param pos The starting position of the substring.
|
* @param len The length of the substring.
|
* @return A byte array containing a substring key.
|
*/
|
private byte[] makeSubstringKey(byte[] bytes, int pos, int len)
|
{
|
byte[] keyBytes = new byte[len];
|
System.arraycopy(bytes, pos, keyBytes, 0, len);
|
return keyBytes;
|
}
|
|
/**
|
* Decompose an attribute value into a set of substring index keys.
|
* The ID of the entry containing this value should be inserted
|
* into the list of each of these keys.
|
*
|
* @param value A byte array containing the normalized attribute value.
|
* @return A set of index keys.
|
*/
|
Set<ByteString> substringKeys(byte[] value)
|
{ // FIXME replace this code with SDK's
|
// AbstractSubstringMatchingRuleImpl.SubstringIndexer.createKeys()
|
|
// Eliminate duplicates by putting the keys into a set.
|
// Sorting the keys will ensure database record locks are acquired
|
// in a consistent order and help prevent transaction deadlocks between
|
// concurrent writers.
|
Set<ByteString> set = new HashSet<ByteString>();
|
|
int substrLength = indexConfig.getSubstringLength();
|
|
// Example: The value is ABCDE and the substring length is 3.
|
// We produce the keys ABC BCD CDE DE E
|
// To find values containing a short substring such as DE,
|
// iterate through keys with prefix DE. To find values
|
// containing a longer substring such as BCDE, read keys
|
// BCD and CDE.
|
for (int i = 0, remain = value.length; remain > 0; i++, remain--)
|
{
|
int len = Math.min(substrLength, remain);
|
byte[] keyBytes = makeSubstringKey(value, i, len);
|
set.add(ByteString.wrap(keyBytes));
|
}
|
|
return set;
|
}
|
|
/**
|
* Retrieve the entry IDs that might match the provided assertion.
|
*
|
* @param indexQuery
|
* The query used to retrieve entries.
|
* @param indexName
|
* The name of index used to retrieve entries.
|
* @param filter
|
* The filter on entries.
|
* @param debugBuffer
|
* If not null, a diagnostic string will be written which will help
|
* determine how the indexes contributed to this search.
|
* @param monitor
|
* The database environment monitor provider that will keep index
|
* filter usage statistics.
|
* @return The candidate entry IDs that might contain the filter assertion
|
* value.
|
*/
|
private EntryIDSet evaluateIndexQuery(IndexQuery indexQuery, String indexName, SearchFilter filter,
|
StringBuilder debugBuffer, DatabaseEnvironmentMonitor monitor)
|
{
|
LocalizableMessageBuilder debugMessage = monitor.isFilterUseEnabled() ? new LocalizableMessageBuilder() : null;
|
EntryIDSet results = indexQuery.evaluate(debugMessage);
|
|
if (debugBuffer != null)
|
{
|
debugBuffer.append("[INDEX:").append(indexConfig.getAttribute().getNameOrOID())
|
.append(".").append(indexName).append("]");
|
}
|
|
if (monitor.isFilterUseEnabled())
|
{
|
if (results.isDefined())
|
{
|
monitor.updateStats(filter, results.size());
|
}
|
else
|
{
|
monitor.updateStats(filter, debugMessage.toMessage());
|
}
|
}
|
return results;
|
}
|
|
/**
|
* Retrieve the entry IDs that might match two filters that restrict a value
|
* to both a lower bound and an upper bound.
|
*
|
* @param filter1
|
* The first filter, that is either a less-or-equal filter or a
|
* greater-or-equal filter.
|
* @param filter2
|
* The second filter, that is either a less-or-equal filter or a
|
* greater-or-equal filter. It must not be of the same type than the
|
* first filter.
|
* @param debugBuffer
|
* If not null, a diagnostic string will be written which will help
|
* determine how the indexes contributed to this search.
|
* @param monitor
|
* The database environment monitor provider that will keep index
|
* filter usage statistics.
|
* @return The candidate entry IDs that might contain match both filters.
|
*/
|
public EntryIDSet evaluateBoundedRange(SearchFilter filter1, SearchFilter filter2, StringBuilder debugBuffer,
|
DatabaseEnvironmentMonitor monitor)
|
{
|
// TODO : this implementation is not optimal
|
// as it implies two separate evaluations instead of a single one,
|
// thus defeating the purpose of the optimization done
|
// in IndexFilter#evaluateLogicalAndFilter method.
|
// One solution could be to implement a boundedRangeAssertion that combine
|
// the two operations in one.
|
EntryIDSet results = evaluate(filter1, debugBuffer, monitor);
|
EntryIDSet results2 = evaluate(filter2, debugBuffer, monitor);
|
results.retainAll(results2);
|
return results;
|
}
|
|
private EntryIDSet evaluate(SearchFilter filter, StringBuilder debugBuffer, DatabaseEnvironmentMonitor monitor)
|
{
|
boolean isLessOrEqual = filter.getFilterType() == FilterType.LESS_OR_EQUAL;
|
IndexFilterType indexFilterType = isLessOrEqual ? IndexFilterType.LESS_OR_EQUAL : IndexFilterType.GREATER_OR_EQUAL;
|
return evaluateFilter(indexFilterType, filter, debugBuffer, monitor);
|
}
|
|
/**
|
* Retrieve the entry IDs that might match a filter.
|
*
|
* @param indexFilterType the index type filter
|
* @param filter The filter.
|
* @param debugBuffer If not null, a diagnostic string will be written
|
* which will help determine how the indexes contributed
|
* to this search.
|
* @param monitor The database environment monitor provider that will keep
|
* index filter usage statistics.
|
* @return The candidate entry IDs that might contain a value
|
* that matches the filter type.
|
*/
|
public EntryIDSet evaluateFilter(IndexFilterType indexFilterType, SearchFilter filter, StringBuilder debugBuffer,
|
DatabaseEnvironmentMonitor monitor)
|
{
|
try
|
{
|
final IndexQuery indexQuery = getIndexQuery(indexFilterType, filter);
|
return evaluateIndexQuery(indexQuery, indexFilterType.toString(), filter, debugBuffer, monitor);
|
}
|
catch (DecodeException e)
|
{
|
logger.traceException(e);
|
return new EntryIDSet();
|
}
|
}
|
|
private IndexQuery getIndexQuery(IndexFilterType indexFilterType, SearchFilter filter) throws DecodeException
|
{
|
MatchingRule rule;
|
Assertion assertion;
|
switch (indexFilterType)
|
{
|
case EQUALITY:
|
rule = filter.getAttributeType().getEqualityMatchingRule();
|
assertion = rule.getAssertion(filter.getAssertionValue());
|
return assertion.createIndexQuery(indexQueryFactory);
|
|
case PRESENCE:
|
return indexQueryFactory.createMatchAllQuery();
|
|
case GREATER_OR_EQUAL:
|
rule = filter.getAttributeType().getOrderingMatchingRule();
|
assertion = rule.getGreaterOrEqualAssertion(filter.getAssertionValue());
|
return assertion.createIndexQuery(indexQueryFactory);
|
|
case LESS_OR_EQUAL:
|
rule = filter.getAttributeType().getOrderingMatchingRule();
|
assertion = rule.getLessOrEqualAssertion(filter.getAssertionValue());
|
return assertion.createIndexQuery(indexQueryFactory);
|
|
case SUBSTRING:
|
rule = filter.getAttributeType().getSubstringMatchingRule();
|
assertion = rule.getSubstringAssertion(
|
filter.getSubInitialElement(), filter.getSubAnyElements(), filter.getSubFinalElement());
|
return assertion.createIndexQuery(indexQueryFactory);
|
|
case APPROXIMATE:
|
rule = filter.getAttributeType().getApproximateMatchingRule();
|
assertion = rule.getAssertion(filter.getAssertionValue());
|
return assertion.createIndexQuery(indexQueryFactory);
|
|
default:
|
return null;
|
}
|
}
|
|
/**
|
* The default lexicographic byte array comparator.
|
* Is there one available in the Java platform?
|
*/
|
public static class KeyComparator implements Comparator<byte[]>
|
{
|
/**
|
* Compares its two arguments for order. Returns a negative integer,
|
* zero, or a positive integer as the first argument is less than, equal
|
* to, or greater than the second.
|
*
|
* @param a the first object to be compared.
|
* @param b the second object to be compared.
|
* @return a negative integer, zero, or a positive integer as the
|
* first argument is less than, equal to, or greater than the
|
* second.
|
*/
|
@Override
|
public int compare(byte[] a, byte[] b)
|
{
|
int i;
|
for (i = 0; i < a.length && i < b.length; i++)
|
{
|
if (a[i] > b[i])
|
{
|
return 1;
|
}
|
else if (a[i] < b[i])
|
{
|
return -1;
|
}
|
}
|
if (a.length == b.length)
|
{
|
return 0;
|
}
|
if (a.length > b.length)
|
{
|
return 1;
|
}
|
return -1;
|
}
|
}
|
|
/**
|
* Byte string key comparator. The default lexicographic byte string
|
* comparator.
|
* <p>
|
* This is the byte string equivalent of {@link KeyComparator}.
|
* <p>
|
* Note: Matt reckons we could simply use ByteString.compareTo(),
|
* but I am using this for now as an intermediate step.
|
*/
|
public static class BSKeyComparator implements Comparator<ByteString>
|
{
|
/**
|
* Compares its two arguments for order. Returns a negative integer, zero,
|
* or a positive integer as the first argument is less than, equal to, or
|
* greater than the second.
|
*
|
* @param a
|
* the first object to be compared.
|
* @param b
|
* the second object to be compared.
|
* @return a negative integer, zero, or a positive integer as the first
|
* argument is less than, equal to, or greater than the second.
|
*/
|
@Override
|
public int compare(ByteString a, ByteString b)
|
{
|
int i;
|
for (i = 0; i < a.length() && i < b.length(); i++)
|
{
|
if (a.byteAt(i) > b.byteAt(i))
|
{
|
return 1;
|
}
|
else if (a.byteAt(i) < b.byteAt(i))
|
{
|
return -1;
|
}
|
}
|
if (a.length() == b.length())
|
{
|
return 0;
|
}
|
if (a.length() > b.length())
|
{
|
return 1;
|
}
|
return -1;
|
}
|
}
|
|
/**
|
* Close cursors related to the attribute indexes.
|
*
|
* @throws DatabaseException If a database error occurs.
|
*/
|
public void closeCursors() throws DatabaseException {
|
for (Index index : nameToIndexes.values())
|
{
|
index.closeCursor();
|
}
|
}
|
|
/**
|
* Return the number of values that have exceeded the entry limit since this
|
* object was created.
|
*
|
* @return The number of values that have exceeded the entry limit.
|
*/
|
public long getEntryLimitExceededCount()
|
{
|
long entryLimitExceededCount = 0;
|
|
for (Index index : nameToIndexes.values())
|
{
|
entryLimitExceededCount += index.getEntryLimitExceededCount();
|
}
|
return entryLimitExceededCount;
|
}
|
|
/**
|
* Get a list of the databases opened by this attribute index.
|
* @param dbList A list of database containers.
|
*/
|
public void listDatabases(List<DatabaseContainer> dbList)
|
{
|
dbList.addAll(nameToIndexes.values());
|
}
|
|
/**
|
* Get a string representation of this object.
|
* @return return A string representation of this object.
|
*/
|
@Override
|
public String toString()
|
{
|
return getName();
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public synchronized boolean isConfigurationChangeAcceptable(
|
LocalDBIndexCfg cfg, List<LocalizableMessage> unacceptableReasons)
|
{
|
if (!isIndexAcceptable(cfg, IndexType.EQUALITY, unacceptableReasons)
|
|| !isIndexAcceptable(cfg, IndexType.SUBSTRING, unacceptableReasons)
|
|| !isIndexAcceptable(cfg, IndexType.ORDERING, unacceptableReasons)
|
|| !isIndexAcceptable(cfg, IndexType.APPROXIMATE, unacceptableReasons))
|
{
|
return false;
|
}
|
|
AttributeType attrType = cfg.getAttribute();
|
if (cfg.getIndexType().contains(IndexType.EXTENSIBLE))
|
{
|
Set<String> newRules = cfg.getIndexExtensibleMatchingRule();
|
if (newRules == null || newRules.isEmpty())
|
{
|
unacceptableReasons.add(ERR_CONFIG_INDEX_TYPE_NEEDS_MATCHING_RULE.get(attrType, "extensible"));
|
return false;
|
}
|
}
|
return true;
|
}
|
|
private boolean isIndexAcceptable(LocalDBIndexCfg cfg, IndexType indexType,
|
List<LocalizableMessage> unacceptableReasons)
|
{
|
final String indexId = indexType.toString();
|
final AttributeType attrType = cfg.getAttribute();
|
if (cfg.getIndexType().contains(indexType)
|
&& nameToIndexes.get(indexId) == null
|
&& getMatchingRule(indexType, attrType) == null)
|
{
|
unacceptableReasons.add(ERR_CONFIG_INDEX_TYPE_NEEDS_MATCHING_RULE.get(attrType, indexId));
|
return false;
|
}
|
return true;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public synchronized ConfigChangeResult applyConfigurationChange(LocalDBIndexCfg cfg)
|
{
|
// this method is not perf sensitive, using an AtomicBoolean will not hurt
|
AtomicBoolean adminActionRequired = new AtomicBoolean(false);
|
ArrayList<LocalizableMessage> messages = new ArrayList<LocalizableMessage>();
|
try
|
{
|
AttributeType attrType = cfg.getAttribute();
|
String name = entryContainer.getDatabasePrefix() + "_" + attrType.getNameOrOID();
|
|
applyChangeToPresenceIndex(cfg, name, adminActionRequired, messages);
|
applyChangeToIndex(IndexType.EQUALITY, cfg, name, adminActionRequired, messages);
|
applyChangeToIndex(IndexType.SUBSTRING, cfg, name, adminActionRequired, messages);
|
applyChangeToIndex(IndexType.ORDERING, cfg, name, adminActionRequired, messages);
|
applyChangeToIndex(IndexType.APPROXIMATE, cfg, name, adminActionRequired, messages);
|
applyChangeToExtensibleIndexes(cfg, attrType, name, adminActionRequired, messages);
|
|
extensibleIndexesMapping = computeExtensibleIndexesMapping();
|
indexConfig = cfg;
|
|
return new ConfigChangeResult(ResultCode.SUCCESS, adminActionRequired.get(), messages);
|
}
|
catch(Exception e)
|
{
|
messages.add(LocalizableMessage.raw(StaticUtils.stackTraceToSingleLineString(e)));
|
return new ConfigChangeResult(
|
DirectoryServer.getServerErrorResultCode(), adminActionRequired.get(), messages);
|
}
|
}
|
|
private void applyChangeToExtensibleIndexes(LocalDBIndexCfg cfg, AttributeType attrType,
|
String name, AtomicBoolean adminActionRequired, ArrayList<LocalizableMessage> messages)
|
{
|
if (!cfg.getIndexType().contains(IndexType.EXTENSIBLE))
|
{
|
final Set<MatchingRule> validRules = Collections.emptySet();
|
final Set<String> validIndexIds = Collections.emptySet();
|
removeIndexesForExtensibleMatchingRules(validRules, validIndexIds);
|
return;
|
}
|
|
final Set<String> extensibleRules = cfg.getIndexExtensibleMatchingRule();
|
final Set<MatchingRule> validRules = new HashSet<MatchingRule>();
|
final Set<String> validIndexIds = new HashSet<String>();
|
final int indexEntryLimit = cfg.getIndexEntryLimit();
|
|
for (String ruleName : extensibleRules)
|
{
|
MatchingRule rule = DirectoryServer.getMatchingRule(toLowerCase(ruleName));
|
if (rule == null)
|
{
|
logger.error(ERR_CONFIG_INDEX_TYPE_NEEDS_VALID_MATCHING_RULE, attrType, ruleName);
|
continue;
|
}
|
validRules.add(rule);
|
for (org.forgerock.opendj.ldap.spi.Indexer indexer : rule.getIndexers())
|
{
|
String indexId = indexer.getIndexID();
|
validIndexIds.add(indexId);
|
if (!nameToIndexes.containsKey(indexId))
|
{
|
Index index = newAttributeIndex(attrType, name, indexEntryLimit, indexer);
|
openIndex(index, adminActionRequired, messages);
|
nameToIndexes.put(indexId, index);
|
}
|
else
|
{
|
Index index = nameToIndexes.get(indexId);
|
if (index.setIndexEntryLimit(indexEntryLimit))
|
{
|
adminActionRequired.set(true);
|
messages.add(NOTE_JEB_CONFIG_INDEX_ENTRY_LIMIT_REQUIRES_REBUILD.get(index.getName()));
|
}
|
if (indexConfig.getSubstringLength() != cfg.getSubstringLength())
|
{
|
index.setIndexer(new AttributeIndexer(attrType, indexer));
|
}
|
}
|
}
|
}
|
removeIndexesForExtensibleMatchingRules(validRules, validIndexIds);
|
}
|
|
/** Remove indexes which do not correspond to valid rules. */
|
private void removeIndexesForExtensibleMatchingRules(Set<MatchingRule> validRules, Set<String> validIndexIds)
|
{
|
final Set<MatchingRule> rulesToDelete = getCurrentExtensibleMatchingRules();
|
rulesToDelete.removeAll(validRules);
|
if (!rulesToDelete.isEmpty())
|
{
|
entryContainer.exclusiveLock.lock();
|
try
|
{
|
for (MatchingRule rule: rulesToDelete)
|
{
|
final List<String> indexIdsToRemove = new ArrayList<String>();
|
for (org.forgerock.opendj.ldap.spi.Indexer indexer : rule.getIndexers())
|
{
|
final String indexId = indexer.getIndexID();
|
if (!validIndexIds.contains(indexId))
|
{
|
indexIdsToRemove.add(indexId);
|
}
|
}
|
// Delete indexes which are not used
|
for (String indexId : indexIdsToRemove)
|
{
|
Index index = nameToIndexes.get(indexId);
|
if (index != null)
|
{
|
entryContainer.deleteDatabase(index);
|
nameToIndexes.remove(index);
|
}
|
}
|
}
|
}
|
finally
|
{
|
entryContainer.exclusiveLock.unlock();
|
}
|
}
|
}
|
|
private Set<MatchingRule> getCurrentExtensibleMatchingRules()
|
{
|
final Set<MatchingRule> rules = new HashSet<MatchingRule>();
|
for (String ruleName : indexConfig.getIndexExtensibleMatchingRule())
|
{
|
final MatchingRule rule = DirectoryServer.getMatchingRule(toLowerCase(ruleName));
|
if (rule != null)
|
{
|
rules.add(rule);
|
}
|
}
|
return rules;
|
}
|
|
private void applyChangeToIndex(IndexType indexType, LocalDBIndexCfg cfg, String name,
|
AtomicBoolean adminActionRequired, ArrayList<LocalizableMessage> messages)
|
{
|
String indexId = indexType.toString();
|
Index index = nameToIndexes.get(indexId);
|
if (!cfg.getIndexType().contains(indexType))
|
{
|
removeIndex(index, indexType);
|
return;
|
}
|
|
final AttributeType attrType = cfg.getAttribute();
|
final int indexEntryLimit = cfg.getIndexEntryLimit();
|
if (index == null)
|
{
|
final MatchingRule matchingRule = getMatchingRule(indexType, attrType);
|
for (org.forgerock.opendj.ldap.spi.Indexer indexer : matchingRule.getIndexers())
|
{
|
index = newAttributeIndex(attrType, name, indexEntryLimit, indexer);
|
openIndex(index, adminActionRequired, messages);
|
nameToIndexes.put(indexId, index);
|
}
|
}
|
else
|
{
|
// already exists. Just update index entry limit.
|
if (index.setIndexEntryLimit(indexEntryLimit))
|
{
|
adminActionRequired.set(true);
|
messages.add(NOTE_JEB_CONFIG_INDEX_ENTRY_LIMIT_REQUIRES_REBUILD.get(index.getName()));
|
}
|
}
|
}
|
|
private void applyChangeToPresenceIndex(LocalDBIndexCfg cfg, String name, AtomicBoolean adminActionRequired,
|
ArrayList<LocalizableMessage> messages)
|
{
|
IndexType indexType = IndexType.PRESENCE;
|
String indexId = indexType.toString();
|
Index index = nameToIndexes.get(indexId);
|
if (!cfg.getIndexType().contains(indexType))
|
{
|
removeIndex(index, indexType);
|
return;
|
}
|
|
final AttributeType attrType = cfg.getAttribute();
|
final int indexEntryLimit = cfg.getIndexEntryLimit();
|
if (index == null)
|
{
|
index = newIndex(name + "." + indexType, indexEntryLimit, new PresenceIndexer(attrType));
|
openIndex(index, adminActionRequired, messages);
|
nameToIndexes.put(indexId, index);
|
}
|
else
|
{
|
// already exists. Just update index entry limit.
|
if (index.setIndexEntryLimit(indexEntryLimit))
|
{
|
adminActionRequired.set(true);
|
messages.add(NOTE_JEB_CONFIG_INDEX_ENTRY_LIMIT_REQUIRES_REBUILD.get(index.getName()));
|
}
|
}
|
}
|
|
private void removeIndex(Index index, IndexType indexType)
|
{
|
if (index != null)
|
{
|
entryContainer.exclusiveLock.lock();
|
try
|
{
|
nameToIndexes.remove(indexType.toString());
|
entryContainer.deleteDatabase(index);
|
}
|
finally
|
{
|
entryContainer.exclusiveLock.unlock();
|
}
|
}
|
}
|
|
private void openIndex(Index index, AtomicBoolean adminActionRequired, ArrayList<LocalizableMessage> messages)
|
{
|
index.open();
|
|
if (!index.isTrusted())
|
{
|
adminActionRequired.set(true);
|
messages.add(NOTE_JEB_INDEX_ADD_REQUIRES_REBUILD.get(index.getName()));
|
}
|
}
|
|
/**
|
* Set the index truststate.
|
* @param txn A database transaction, or null if none is required.
|
* @param trusted True if this index should be trusted or false
|
* otherwise.
|
* @throws DatabaseException If an error occurs in the JE database.
|
*/
|
public synchronized void setTrusted(Transaction txn, boolean trusted)
|
throws DatabaseException
|
{
|
for (Index index : nameToIndexes.values())
|
{
|
index.setTrusted(txn, trusted);
|
}
|
}
|
|
/**
|
* Return true iff this index is trusted.
|
* @return the trusted state of this index
|
*/
|
public boolean isTrusted()
|
{
|
for (Index index : nameToIndexes.values())
|
{
|
if (!index.isTrusted())
|
{
|
return false;
|
}
|
}
|
return true;
|
}
|
|
/**
|
* Set the rebuild status of this index.
|
* @param rebuildRunning True if a rebuild process on this index
|
* is running or False otherwise.
|
*/
|
public synchronized void setRebuildStatus(boolean rebuildRunning)
|
{
|
for (Index index : nameToIndexes.values())
|
{
|
index.setRebuildStatus(rebuildRunning);
|
}
|
}
|
|
/**
|
* Get the JE database name prefix for indexes in this attribute index.
|
*
|
* @return JE database name for this database container.
|
*/
|
public String getName()
|
{
|
return entryContainer.getDatabasePrefix()
|
+ "_"
|
+ indexConfig.getAttribute().getNameOrOID();
|
}
|
|
/**
|
* Return the equality index.
|
*
|
* @return The equality index.
|
*/
|
public Index getEqualityIndex() {
|
return nameToIndexes.get(IndexType.EQUALITY.toString());
|
}
|
|
/**
|
* Return the approximate index.
|
*
|
* @return The approximate index.
|
*/
|
public Index getApproximateIndex() {
|
return nameToIndexes.get(IndexType.APPROXIMATE.toString());
|
}
|
|
/**
|
* Return the ordering index.
|
*
|
* @return The ordering index.
|
*/
|
public Index getOrderingIndex() {
|
return nameToIndexes.get(IndexType.ORDERING.toString());
|
}
|
|
/**
|
* Return the substring index.
|
*
|
* @return The substring index.
|
*/
|
public Index getSubstringIndex() {
|
return nameToIndexes.get(IndexType.SUBSTRING.toString());
|
}
|
|
/**
|
* Return the presence index.
|
*
|
* @return The presence index.
|
*/
|
public Index getPresenceIndex() {
|
return nameToIndexes.get(IndexType.PRESENCE.toString());
|
}
|
|
/**
|
* Return the mapping of extensible index types and indexes.
|
*
|
* @return The map containing entries (extensible index type, list of indexes)
|
*/
|
public Map<String, Collection<Index>> getExtensibleIndexes()
|
{
|
return extensibleIndexesMapping;
|
}
|
|
private Map<String, Collection<Index>> computeExtensibleIndexesMapping()
|
{
|
final Collection<Index> substring = new ArrayList<Index>();
|
final Collection<Index> shared = new ArrayList<Index>();
|
for (Map.Entry<String, Index> entry : nameToIndexes.entrySet())
|
{
|
final String indexId = entry.getKey();
|
if (isDefaultIndex(indexId)) {
|
continue;
|
}
|
if (indexId.endsWith(EXTENSIBLE_INDEXER_ID_SUBSTRING))
|
{
|
substring.add(entry.getValue());
|
}
|
else
|
{
|
shared.add(entry.getValue());
|
}
|
}
|
final Map<String, Collection<Index>> indexMap = new HashMap<String,Collection<Index>>();
|
indexMap.put(EXTENSIBLE_INDEXER_ID_SUBSTRING, substring);
|
indexMap.put(EXTENSIBLE_INDEXER_ID_SHARED, shared);
|
return Collections.unmodifiableMap(indexMap);
|
}
|
|
private boolean isDefaultIndex(String indexId)
|
{
|
return indexId.equals(IndexType.EQUALITY.toString())
|
|| indexId.equals(IndexType.PRESENCE.toString())
|
|| indexId.equals(IndexType.SUBSTRING.toString())
|
|| indexId.equals(IndexType.ORDERING.toString())
|
|| indexId.equals(IndexType.APPROXIMATE.toString());
|
}
|
|
/**
|
* Retrieves all the indexes used by this attribute index.
|
*
|
* @return A collection of all indexes in use by this attribute
|
* index.
|
*/
|
public Collection<Index> getAllIndexes() {
|
return new LinkedHashSet<Index>(nameToIndexes.values());
|
}
|
|
/**
|
* Retrieve the entry IDs that might match an extensible filter.
|
*
|
* @param filter The extensible filter.
|
* @param debugBuffer If not null, a diagnostic string will be written
|
* which will help determine how the indexes contributed
|
* to this search.
|
* @param monitor The database environment monitor provider that will keep
|
* index filter usage statistics.
|
* @return The candidate entry IDs that might contain the filter
|
* assertion value.
|
*/
|
public EntryIDSet evaluateExtensibleFilter(SearchFilter filter,
|
StringBuilder debugBuffer,
|
DatabaseEnvironmentMonitor monitor)
|
{
|
//Get the Matching Rule OID of the filter.
|
String matchRuleOID = filter.getMatchingRuleID();
|
/**
|
* Use the default equality index in two conditions:
|
* 1. There is no matching rule provided
|
* 2. The matching rule specified is actually the default equality.
|
*/
|
MatchingRule eqRule = indexConfig.getAttribute().getEqualityMatchingRule();
|
if (matchRuleOID == null
|
|| matchRuleOID.equals(eqRule.getOID())
|
|| matchRuleOID.equalsIgnoreCase(eqRule.getNameOrOID()))
|
{
|
//No matching rule is defined; use the default equality matching rule.
|
return evaluateFilter(IndexFilterType.EQUALITY, filter, debugBuffer, monitor);
|
}
|
|
MatchingRule rule = DirectoryServer.getMatchingRule(matchRuleOID);
|
if (!ruleHasAtLeasOneIndex(rule))
|
{
|
if (monitor.isFilterUseEnabled())
|
{
|
monitor.updateStats(filter, INFO_JEB_INDEX_FILTER_MATCHING_RULE_NOT_INDEXED.get(
|
matchRuleOID, indexConfig.getAttribute().getNameOrOID()));
|
}
|
return IndexQuery.createNullIndexQuery().evaluate(null);
|
}
|
|
try
|
{
|
if (debugBuffer != null)
|
{
|
debugBuffer.append("[INDEX:");
|
for (org.forgerock.opendj.ldap.spi.Indexer indexer : rule.getIndexers())
|
{
|
debugBuffer.append(" ")
|
.append(filter.getAttributeType().getNameOrOID())
|
.append(".")
|
.append(indexer.getIndexID());
|
}
|
debugBuffer.append("]");
|
}
|
|
final IndexQuery indexQuery = rule.getAssertion(filter.getAssertionValue()).createIndexQuery(indexQueryFactory);
|
LocalizableMessageBuilder debugMessage = monitor.isFilterUseEnabled() ? new LocalizableMessageBuilder() : null;
|
EntryIDSet results = indexQuery.evaluate(debugMessage);
|
if (monitor.isFilterUseEnabled())
|
{
|
if (results.isDefined())
|
{
|
monitor.updateStats(filter, results.size());
|
}
|
else
|
{
|
monitor.updateStats(filter, debugMessage.toMessage());
|
}
|
}
|
return results;
|
}
|
catch (DecodeException e)
|
{
|
logger.traceException(e);
|
return IndexQuery.createNullIndexQuery().evaluate(null);
|
}
|
}
|
|
private boolean ruleHasAtLeasOneIndex(MatchingRule rule)
|
{
|
for (org.forgerock.opendj.ldap.spi.Indexer indexer : rule.getIndexers())
|
{
|
if (nameToIndexes.containsKey(indexer.getIndexID()))
|
{
|
return true;
|
}
|
}
|
return false;
|
}
|
|
/**
|
* This class extends the IndexConfig for JE Backend.
|
*/
|
private class JEIndexConfig implements IndexingOptions
|
{
|
/** The length of the substring index. */
|
private int substringLength;
|
|
/**
|
* Creates a new JEIndexConfig instance.
|
* @param substringLength The length of the substring.
|
*/
|
private JEIndexConfig(int substringLength)
|
{
|
this.substringLength = substringLength;
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public int substringKeySize()
|
{
|
return substringLength;
|
}
|
}
|
}
|
