/*
* 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
*
*
* Copyright 2008 Sun Microsystems, Inc.
* Portions Copyright 2011 ForgeRock AS
*/
package org.opends.server.extensions;
import org.opends.server.types.ByteString;
import org.opends.messages.Message;
import java.util.Iterator;
import java.util.ArrayList;
import java.util.Set;
import org.opends.server.types.DirectoryConfig;
import org.opends.server.types.DirectoryException;
import org.opends.server.types.DN;
import org.opends.server.types.Entry;
import org.opends.server.types.MemberList;
import org.opends.server.types.MembershipException;
import org.opends.server.types.SearchFilter;
import org.opends.server.types.SearchScope;
import static org.opends.server.loggers.debug.DebugLogger.*;
import org.opends.server.loggers.debug.DebugTracer;
import org.opends.server.types.DebugLogLevel;
import static org.opends.messages.ExtensionMessages.*;
import static org.opends.server.util.Validator.*;
/**
* This class provides an implementation of the {@code MemberList} class that
* may be used in conjunction when static groups when additional criteria is to
* be used to select a subset of the group members.
*/
public class FilteredStaticGroupMemberList
extends MemberList
{
/**
* The tracer object for the debug logger.
*/
private static final DebugTracer TRACER = getTracer();
// The base DN below which all returned members should exist.
private DN baseDN;
// The DN of the static group with which this member list is associated.
private DN groupDN;
// The entry of the next entry that matches the member list criteria.
private Entry nextMatchingEntry;
// The iterator used to traverse the set of member DNs.
private Iterator<ByteString> memberDNIterator;
// The set of DNs for the users that are members of the associated static
// group.
private ArrayList<ByteString> memberDNs;
// The membership exception that should be thrown the next time a member is
// requested.
private MembershipException nextMembershipException;
// The search filter that all returned members should match.
private SearchFilter filter;
// The search scope to apply against the base DN for the member subset.
private SearchScope scope;
/**
* Creates a new filtered static group member list with the provided
* information.
*
* @param groupDN The DN of the static group with which this member list
* is associated.
* @param memberDNs The set of DNs for the users that are members of the
* associated static group.
* @param baseDN The base DN below which all returned members should
* exist. If this is {@code null}, then all members will
* be considered to match the base and scope criteria.
* @param scope The search scope to apply against the base DN when
* selecting eligible members.
* @param filter The search filter which all returned members should
* match. If this is {@code null}, then all members will
* be considered eligible.
*/
public FilteredStaticGroupMemberList(DN groupDN, Set<ByteString> memberDNs,
DN baseDN, SearchScope scope,
SearchFilter filter)
{
ensureNotNull(groupDN, memberDNs);
this.groupDN = groupDN;
this.memberDNs = new ArrayList<ByteString>(memberDNs);
memberDNIterator = memberDNs.iterator();
this.baseDN = baseDN;
this.filter = filter;
if (scope == null)
{
this.scope = SearchScope.WHOLE_SUBTREE;
}
else
{
this.scope = scope;
}
nextMatchingEntry = null;
nextMembershipException = null;
nextMemberInternal();
}
/**
* Attempts to find the next member that matches the associated criteria.
* When this method returns, if {@code nextMembershipException} is
* non-{@code null}, then that exception should be thrown on the next attempt
* to retrieve a member. If {@code nextMatchingEntry} is non-{@code null},
* then that entry should be returned on the next attempt to retrieve a
* member. If both are {@code null}, then there are no more members to
* return.
*/
private void nextMemberInternal()
{
while (memberDNIterator.hasNext())
{
DN nextDN = null;
try
{
nextDN = DN.decode(memberDNIterator.next());
}
catch (DirectoryException de)
{
if (debugEnabled())
{
TRACER.debugCaught(DebugLogLevel.ERROR, de);
}
Message message = ERR_STATICMEMBERS_CANNOT_DECODE_DN.
get(String.valueOf(nextDN), String.valueOf(groupDN),
String.valueOf(de.getMessageObject()));
nextMembershipException =
new MembershipException(message, true, de);
return;
}
// Check to see if we can eliminate the entry as a possible match purely
// based on base DN and scope.
if (baseDN != null)
{
switch (scope)
{
case BASE_OBJECT:
if (! baseDN.equals(nextDN))
{
continue;
}
break;
case SINGLE_LEVEL:
if (! baseDN.equals(nextDN.getParent()))
{
continue;
}
break;
case SUBORDINATE_SUBTREE:
if (baseDN.equals(nextDN) || (! baseDN.isAncestorOf(nextDN)))
{
continue;
}
break;
default:
if (! baseDN.isAncestorOf(nextDN))
{
continue;
}
break;
}
}
// Get the entry for the potential member. If we can't, then populate
// the next membership exception.
try
{
Entry memberEntry = DirectoryConfig.getEntry(nextDN);
if (memberEntry == null)
{
Message message = ERR_STATICMEMBERS_NO_SUCH_ENTRY.get(
String.valueOf(nextDN), String.valueOf(groupDN));
nextMembershipException =
new MembershipException(message, true);
return;
}
if (filter == null)
{
nextMatchingEntry = memberEntry;
return;
}
else
{
if (filter.matchesEntry(memberEntry))
{
nextMatchingEntry = memberEntry;
return;
}
else
{
continue;
}
}
}
catch (DirectoryException de)
{
if (debugEnabled())
{
TRACER.debugCaught(DebugLogLevel.ERROR, de);
}
Message message = ERR_STATICMEMBERS_CANNOT_GET_ENTRY.
get(String.valueOf(nextDN), String.valueOf(groupDN),
String.valueOf(de.getMessageObject()));
nextMembershipException =
new MembershipException(message, true, de);
return;
}
}
// If we've gotten here, then there are no more members.
nextMatchingEntry = null;
nextMembershipException = null;
}
/**
* {@inheritDoc}
*/
@Override()
public boolean hasMoreMembers()
{
if (! memberDNIterator.hasNext())
{
return false;
}
return ((nextMatchingEntry != null) || (nextMembershipException != null));
}
/**
* {@inheritDoc}
*/
@Override()
public DN nextMemberDN()
throws MembershipException
{
if (! memberDNIterator.hasNext())
{
return null;
}
Entry e = nextMemberEntry();
if (e == null)
{
return null;
}
else
{
return e.getDN();
}
}
/**
* {@inheritDoc}
*/
@Override()
public Entry nextMemberEntry()
throws MembershipException
{
if (! memberDNIterator.hasNext())
{
return null;
}
if (nextMembershipException == null)
{
Entry e = nextMatchingEntry;
nextMatchingEntry = null;
nextMemberInternal();
return e;
}
else
{
MembershipException me = nextMembershipException;
nextMembershipException = null;
nextMemberInternal();
throw me;
}
}
/**
* {@inheritDoc}
*/
@Override()
public void close()
{
// No implementation is required.
}
}