VLVIndexDescriptor.java revision 9e82f3d205d5756d6cc6a400dc92e07c078862d6
/*
* 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 2008-2010 Sun Microsystems, Inc.
* Portions Copyright 2015 ForgeRock AS
*/
/**
* The class used to describe the VLV index configuration.
*/
public class VLVIndexDescriptor extends AbstractIndexDescriptor
{
private final SearchScope scope;
private int hashCode;
/**
* Constructor for the VLVIndexDescriptor.
*
* @param name
* the name of the index.
* @param backend
* the backend where the index is defined.
* @param baseDN
* the baseDN of the search indexed by the VLV index.
* @param scope
* the scope of the search indexed by the VLV index.
* @param filter
* the filter or the search indexed by the VLV index.
* @param sortOrder
* the sort order list of the VLV index.
*/
public VLVIndexDescriptor(String name, BackendDescriptor backend, DN baseDN, SearchScope scope, String filter,
{
}
public int compareTo(AbstractIndexDescriptor o)
{
}
public int hashCode()
{
return hashCode;
}
/**
* Returns the baseDN of the search indexed by the VLV index.
*
* @return the baseDN of the search indexed by the VLV index.
*/
{
return baseDN;
}
/**
* Returns the filter of the search indexed by the VLV index.
*
* @return the filter of the search indexed by the VLV index.
*/
{
return filter;
}
/**
* Returns the scope of the search indexed by the VLV index.
*
* @return the scope of the search indexed by the VLV index.
*/
public SearchScope getScope()
{
return scope;
}
/**
* Returns the sort order list of the VLV index.
*
* @return the sort order list of the VLV index.
*/
{
return sortOrder;
}
{
if (o == this)
{
return true;
}
if (!(o instanceof VLVIndexDescriptor))
{
return false;
}
&& backendIdEqual(index);
}
{
return getBackend() != null
// Only compare the backend IDs. In this context is better to
// do this since the backend object contains some state (like
// number entries) that can change.
}
protected void recalculateHashCode()
{
for (final VLVSortOrder s : sortOrder)
{
}
if (getBackend() != null)
{
}
}
/**
* Returns the equivalent {@code BackendVLVIndexCfgDefn.Scope} to the provided
* search scope.
*
* @param scope
* The {@code SearchScope} to convert.
* @return the equivalent {@code BackendVLVIndexCfgDefn.Scope} to the provided
* search scope.
*/
public static BackendVLVIndexCfgDefn.Scope getPluggableBackendVLVIndexScope(final SearchScope scope)
{
{
case BASE_OBJECT:
case SINGLE_LEVEL:
case SUBORDINATES:
case WHOLE_SUBTREE:
case UNKNOWN:
default:
}
}
// FIXME: Remove once local-db backend will be pluggable.
/**
* Returns the equivalent {@code LocalDBVLVIndexCfgDefn.Scope} to the provided
* search scope.
*
* @param scope
* The {@code SearchScope} to convert.
* @return the equivalent {@code LocalDBVLVIndexCfgDefn.Scope} to the provided
* search scope.
*/
{
{
case BASE_OBJECT:
case SINGLE_LEVEL:
case SUBORDINATES:
case WHOLE_SUBTREE:
case UNKNOWN:
default:
}
}
/**
* Convert the provided {@code BackendVLVIndexCfgDefn.Scope} to
* {@code SearchScope}.
*
* @param scope
* The scope to convert.
* @return the provided {@code BackendVLVIndexCfgDefn.Scope} to
* {@code SearchScope}
*/
{
switch (scope)
{
case BASE_OBJECT:
return SearchScope.BASE_OBJECT;
case SINGLE_LEVEL:
return SearchScope.SINGLE_LEVEL;
case SUBORDINATE_SUBTREE:
return SearchScope.SUBORDINATES;
case WHOLE_SUBTREE:
return SearchScope.WHOLE_SUBTREE;
default:
}
}
// FIXME: Remove once local-db backend will be pluggable.
/**
* Convert the provided {@code LocalDBVLVIndexCfgDefn.Scope} to
* {@code SearchScope}.
*
* @param scope
* The scope to convert.
* @return the provided {@code LocalDBVLVIndexCfgDefn.Scope} to
* {@code SearchScope}
*/
{
switch (scope)
{
case BASE_OBJECT:
return SearchScope.BASE_OBJECT;
case SINGLE_LEVEL:
return SearchScope.SINGLE_LEVEL;
case SUBORDINATE_SUBTREE:
return SearchScope.SUBORDINATES;
case WHOLE_SUBTREE:
return SearchScope.WHOLE_SUBTREE;
default:
}
}
}