/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
package org.apache.directory.server.operations.search;
import static org.apache.directory.server.integ.ServerIntegrationUtils.getWiredContext;
import static org.apache.directory.server.integ.ServerIntegrationUtils.getWiredContextThrowOnRefferal;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.StringReader;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import javax.naming.Context;
import javax.naming.NamingEnumeration;
import javax.naming.NamingException;
import javax.naming.ReferralException;
import javax.naming.directory.DirContext;
import javax.naming.directory.SearchControls;
import javax.naming.directory.SearchResult;
import javax.naming.ldap.LdapContext;
import javax.naming.ldap.ManageReferralControl;
import org.apache.directory.junit.tools.MultiThreadedMultiInvoker;
import org.apache.directory.server.annotations.CreateLdapServer;
import org.apache.directory.server.annotations.CreateTransport;
import org.apache.directory.server.core.annotations.ApplyLdifs;
import org.apache.directory.server.core.integ.AbstractLdapTestUnit;
import org.apache.directory.server.core.integ.FrameworkRunner;
import org.apache.directory.shared.ldap.model.entry.DefaultEntry;
import org.apache.directory.shared.ldap.model.ldif.LdifEntry;
import org.apache.directory.shared.ldap.model.ldif.LdifReader;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
/**
* Tests to make sure the server is operating correctly when handling referrals.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@RunWith(FrameworkRunner.class)
@CreateLdapServer(
transports =
{
@CreateTransport(protocol = "LDAP")
})
@ApplyLdifs(
{
// Add new ref for ou=RemoteUsers
"dn: ou=RemoteUsers,ou=system",
"objectClass: top",
"objectClass: referral",
"objectClass: extensibleObject",
"ou: RemoteUsers",
"ref: ldap://fermi:10389/ou=users,ou=system",
"ref: ldap://hertz:10389/ou=users,dc=example,dc=com",
"ref: ldap://maxwell:10389/ou=users,ou=system",
"dn: c=France,ou=system",
"objectClass: top",
"objectClass: country",
"c: France",
"dn: c=USA,ou=system",
"objectClass: top",
"objectClass: country",
"c: USA",
"dn: l=Paris,c=france,ou=system",
"objectClass: top",
"objectClass: locality",
"l: Paris",
"dn: l=Jacksonville,c=usa,ou=system",
"objectClass: top",
"objectClass: locality",
"l: Jacksonville",
"dn: cn=emmanuel lecharny,l=paris,c=france,ou=system",
"objectClass: top",
"objectClass: person",
"objectClass: residentialPerson",
"cn: emmanuel lecharny",
"sn: elecharny",
"l: Paris",
"dn: cn=alex karasulu,l=jacksonville,c=usa,ou=system",
"objectClass: top",
"objectClass: person",
"objectClass: residentialPerson",
"cn: alex karasulu",
"sn: karasulu",
"l: Jacksonville",
"dn: ou=Countries,ou=system",
"objectClass: top",
"objectClass: organizationalUnit",
"ou: Countries"
})
public class ReferralSearchIT extends AbstractLdapTestUnit
{
@Rule
public MultiThreadedMultiInvoker i = new MultiThreadedMultiInvoker( MultiThreadedMultiInvoker.NOT_THREADSAFE );
@Before
public void setupReferrals() throws Exception
{
String ldif =
"dn: c=europ,ou=Countries,ou=system\n" +
"objectClass: top\n" +
"objectClass: referral\n" +
"objectClass: extensibleObject\n" +
"c: europ\n" +
"ref: ldap://localhost:" + getLdapServer().getPort() + "/c=france,ou=system\n\n" +
"dn: c=america,ou=Countries,ou=system\n" +
"objectClass: top\n" +
"objectClass: referral\n" +
"objectClass: extensibleObject\n" +
"c: america\n" +
"ref: ldap://localhost:" + getLdapServer().getPort() + "/c=usa,ou=system\n\n";
LdifReader reader = new LdifReader( new StringReader( ldif ) );
while ( reader.hasNext() )
{
LdifEntry entry = reader.next();
getLdapServer().getDirectoryService().getAdminSession().add(
new DefaultEntry( getLdapServer().getDirectoryService().getSchemaManager(), entry.getEntry() ) );
}
}
@Test
public void testSearchBaseIsReferral() throws Exception
{
DirContext ctx = getWiredContextThrowOnRefferal( getLdapServer() );
SearchControls controls = new SearchControls();
controls.setSearchScope( SearchControls.SUBTREE_SCOPE );
try
{
ctx.search( "ou=RemoteUsers,ou=system", "(objectClass=*)", controls );
fail( "should never get here" );
}
catch ( ReferralException e )
{
assertEquals( "ldap://fermi:10389/ou=users,ou=system??sub", e.getReferralInfo() );
assertTrue( e.skipReferral() );
assertEquals( "ldap://hertz:10389/ou=users,dc=example,dc=com??sub", e.getReferralInfo() );
assertTrue( e.skipReferral() );
assertEquals( "ldap://maxwell:10389/ou=users,ou=system??sub", e.getReferralInfo() );
assertFalse( e.skipReferral() );
}
finally
{
ctx.close();
}
}
@Test
public void testSearchBaseParentIsReferral() throws Exception
{
DirContext ctx = getWiredContextThrowOnRefferal( getLdapServer() );
SearchControls controls = new SearchControls();
controls.setSearchScope( SearchControls.OBJECT_SCOPE );
try
{
ctx.search( "cn=alex karasulu,ou=RemoteUsers,ou=system", "(objectClass=*)", controls );
}
catch ( ReferralException e )
{
assertEquals( "ldap://fermi:10389/cn=alex%20karasulu,ou=users,ou=system??base", e.getReferralInfo() );
assertTrue( e.skipReferral() );
assertEquals( "ldap://hertz:10389/cn=alex%20karasulu,ou=users,dc=example,dc=com??base", e.getReferralInfo() );
assertTrue( e.skipReferral() );
assertEquals( "ldap://maxwell:10389/cn=alex%20karasulu,ou=users,ou=system??base", e.getReferralInfo() );
assertFalse( e.skipReferral() );
}
finally
{
ctx.close();
}
}
@Test
public void testSearchBaseAncestorIsReferral() throws Exception
{
DirContext ctx = getWiredContextThrowOnRefferal( getLdapServer() );
SearchControls controls = new SearchControls();
controls.setSearchScope( SearchControls.OBJECT_SCOPE );
try
{
ctx.search( "cn=alex karasulu,ou=apache,ou=RemoteUsers,ou=system", "(objectClass=*)", controls );
}
catch ( ReferralException e )
{
assertEquals( "ldap://fermi:10389/cn=alex%20karasulu,ou=apache,ou=users,ou=system??base", e.getReferralInfo() );
assertTrue( e.skipReferral() );
assertEquals( "ldap://hertz:10389/cn=alex%20karasulu,ou=apache,ou=users,dc=example,dc=com??base", e
.getReferralInfo() );
assertTrue( e.skipReferral() );
assertEquals( "ldap://maxwell:10389/cn=alex%20karasulu,ou=apache,ou=users,ou=system??base", e
.getReferralInfo() );
assertFalse( e.skipReferral() );
}
finally
{
ctx.close();
}
}
@Test
public void testSearchContinuations() throws Exception
{
DirContext ctx = getWiredContext( getLdapServer() );
SearchControls controls = new SearchControls();
controls.setSearchScope( SearchControls.SUBTREE_SCOPE );
NamingEnumeration<SearchResult> list = ctx.search( "ou=system", "(objectClass=*)", controls );
Map<String, SearchResult> results = new HashMap<String, SearchResult>();
while ( list.hasMore() )
{
SearchResult result = list.next();
results.put( result.getName(), result );
}
assertNotNull( results.get( "ou=users" ) );
// -------------------------------------------------------------------
// Now we will throw exceptions when searching for referrals
// -------------------------------------------------------------------
ctx.addToEnvironment( Context.REFERRAL, "throw" );
list = ctx.search( "ou=system", "(objectClass=*)", controls );
results = new HashMap<String, SearchResult>();
try
{
while ( list.hasMore() )
{
SearchResult result = list.next();
results.put( result.getName(), result );
}
}
catch ( ReferralException e )
{
// As we use the uuidIndex the order of search continuations returned by
// the server is not deterministic. So we collect all referrals first into
// an hashset and check afterwards if the expected URLs are included.
Set<Object> s = new HashSet<Object>();
s.add( e.getReferralInfo() );
while ( e.skipReferral() )
{
try
{
Context ctx2 = e.getReferralContext();
ctx2.list( "" );
}
catch ( NamingException ne )
{
if ( ne instanceof ReferralException )
{
e = ( ReferralException ) ne;
s.add( e.getReferralInfo() );
}
else
{
break;
}
}
}
assertEquals( 5, s.size() );
assertTrue( s.contains( "ldap://fermi:10389/ou=users,ou=system??sub" ) );
assertTrue( s.contains( "ldap://hertz:10389/ou=users,dc=example,dc=com??sub" ) );
assertTrue( s.contains( "ldap://maxwell:10389/ou=users,ou=system??sub" ) );
}
assertNull( results.get( "ou=remoteusers" ) );
list.close();
// try again but this time with single level scope
controls.setSearchScope( SearchControls.ONELEVEL_SCOPE );
list = ctx.search( "ou=system", "(objectClass=*)", controls );
results = new HashMap<String, SearchResult>();
try
{
while ( list.hasMore() )
{
SearchResult result = list.next();
results.put( result.getName(), result );
}
}
catch ( ReferralException e )
{
assertEquals( "ldap://fermi:10389/ou=users,ou=system??base", e.getReferralInfo() );
assertTrue( e.skipReferral() );
assertEquals( "ldap://hertz:10389/ou=users,dc=example,dc=com??base", e.getReferralInfo() );
assertTrue( e.skipReferral() );
assertEquals( "ldap://maxwell:10389/ou=users,ou=system??base", e.getReferralInfo() );
}
list.close();
ctx.close();
assertNull( results.get( "ou=remoteusers" ) );
}
/**
* Test of an search operation with a referral
*
* search for "cn=alex karasulu" on "c=america, ou=system"
* we should get a referral URL thrown, which point to
* "c=usa, ou=system", and ask for a subtree search
*/
@Test
public void testSearchWithReferralThrow() throws Exception
{
DirContext ctx = getWiredContextThrowOnRefferal( getLdapServer() );
try
{
SearchControls controls = new SearchControls();
controls.setSearchScope( SearchControls.SUBTREE_SCOPE );
ctx.search( "c=america,ou=Countries,ou=system", "(cn=alex karasulu)", controls );
fail( "Should fail here throwing a ReferralException" );
}
catch ( ReferralException re )
{
String referral = ( String ) re.getReferralInfo();
assertEquals( "ldap://localhost:" + getLdapServer().getPort() + "/c=usa,ou=system??sub", referral );
}
finally
{
ctx.close();
}
}
/**
* Test of an search operation with a referral
*
* search for "cn=alex karasulu" on "c=america, ou=system"
* we should get a referral URL thrown, which point to
* "c=usa, ou=system", and ask for a subtree search
*/
@Test
public void testSearchBaseWithReferralThrow() throws Exception
{
DirContext ctx = getWiredContextThrowOnRefferal( getLdapServer() );
SearchControls controls = new SearchControls();
controls.setSearchScope( SearchControls.OBJECT_SCOPE );
try
{
ctx.search( "c=america,ou=Countries,ou=system", "(cn=alex karasulu)", controls );
fail( "Should fail here throwing a ReferralException" );
}
catch ( ReferralException re )
{
String referral = ( String ) re.getReferralInfo();
assertEquals( "ldap://localhost:" + getLdapServer().getPort() + "/c=usa,ou=system??base", referral );
}
finally
{
ctx.close();
}
}
/**
* Test of an search operation with a referral after the entry
* has been renamed.
*
* search for "cn=alex karasulu" on "c=usa, ou=system"
* we should get a referral URL thrown, which point to
* "c=usa, ou=system", and ask for a subtree search
*/
@Test
public void testSearchBaseWithReferralThrowAfterRename() throws Exception
{
DirContext ctx = getWiredContextThrowOnRefferal( getLdapServer() );
SearchControls controls = new SearchControls();
controls.setSearchScope( SearchControls.OBJECT_SCOPE );
try
{
ctx.search( "c=america,ou=Countries,ou=system", "(cn=alex karasulu)", controls );
fail( "Should fail here throwing a ReferralException" );
}
catch ( ReferralException re )
{
String referral = ( String ) re.getReferralInfo();
assertEquals( "ldap://localhost:" + getLdapServer().getPort() + "/c=usa,ou=system??base", referral );
}
( ( LdapContext ) ctx ).setRequestControls( new javax.naming.ldap.Control[]
{ new ManageReferralControl() } );
// Now let's move the entry
ctx.rename( "c=america,ou=Countries,ou=system", "c=USA,ou=Countries,ou=system" );
controls.setSearchScope( SearchControls.OBJECT_SCOPE );
( ( LdapContext ) ctx ).setRequestControls( new javax.naming.ldap.Control[]
{} );
try
{
ctx.search( "c=usa,ou=Countries,ou=system", "(cn=alex karasulu)", controls );
fail( "Should fail here throwing a ReferralException" );
}
catch ( ReferralException re )
{
String referral = ( String ) re.getReferralInfo();
assertEquals( "ldap://localhost:" + getLdapServer().getPort() + "/c=usa,ou=system??base", referral );
}
finally
{
ctx.close();
}
}
}