Add search executor namespace support.

See #56.
vt-middleware · Dec 1, 2015 · 96d99b1 · 96d99b1
1 parent 6c17b1d
commit 96d99b1
Show file tree

Hide file tree

Showing 5 changed files with 112 additions and 2 deletions.
diff --git a/beans/src/main/java/org/ldaptive/beans/spring/NamespaceHandler.java b/beans/src/main/java/org/ldaptive/beans/spring/NamespaceHandler.java
@@ -4,6 +4,8 @@
 import org.ldaptive.BindConnectionInitializer;
 import org.ldaptive.ConnectionConfig;
 import org.ldaptive.DefaultConnectionFactory;
+import org.ldaptive.SearchExecutor;
+import org.ldaptive.SearchFilter;
 import org.ldaptive.ad.handler.ObjectGuidHandler;
 import org.ldaptive.ad.handler.ObjectSidHandler;
 import org.ldaptive.auth.AuthenticationResponseHandler;
@@ -54,6 +56,7 @@ public void init()
     registerBeanDefinitionParser("ad-authenticator", new ADAuthenticatorBeanDefinitionParser());
     registerBeanDefinitionParser("pooled-connection-factory", new PooledConnectionFactoryBeanDefinitionParser());
     registerBeanDefinitionParser("connection-factory", new ConnectionFactoryBeanDefinitionParser());
+    registerBeanDefinitionParser("search-executor", new SearchExecutorBeanDefinitionParser());
   }
 
 
@@ -220,7 +223,7 @@ protected void doParse(
 
 
   /**
-   * Parser for <pre>pooled-connection-factory</pre> elements.
+   * Parser for <pre>connection-factory</pre> elements.
    */
   private static class ConnectionFactoryBeanDefinitionParser extends AbstractConnectionFactoryBeanDefinitionParser
   {
@@ -499,4 +502,58 @@ protected BeanDefinition parseProvider(final Element element)
       return provider.getBeanDefinition();
     }
   }
+
+
+  /**
+   * Parser for <pre>search-executor</pre> elements.
+   */
+  private static class SearchExecutorBeanDefinitionParser extends AbstractSingleBeanDefinitionParser
+  {
+
+
+    @Override
+    protected String resolveId(
+      final Element element,
+      // CheckStyle:IllegalTypeCheck OFF
+      final AbstractBeanDefinition definition,
+      // CheckStyle:IllegalTypeCheck ON
+      final ParserContext parserContext)
+      throws BeanDefinitionStoreException
+    {
+      final String idAttrValue = element.getAttribute("id");
+      return StringUtils.hasText(idAttrValue) ? idAttrValue : "search-executor";
+    }
+
+
+    @Override
+    protected Class<?> getBeanClass(final Element element)
+    {
+      return SearchExecutor.class;
+    }
+
+
+    @Override
+    protected void doParse(
+      final Element element,
+      final ParserContext context,
+      final BeanDefinitionBuilder builder)
+    {
+      builder.addPropertyValue("baseDn", element.getAttribute("baseDn"));
+      if (element.hasAttribute("searchFilter")) {
+        final BeanDefinitionBuilder filter = BeanDefinitionBuilder.genericBeanDefinition(SearchFilter.class);
+        filter.addPropertyValue("filter", element.getAttribute("searchFilter"));
+        builder.addPropertyValue("searchFilter", filter.getBeanDefinition());
+      }
+      if (element.hasAttribute("returnAttributes")) {
+        builder.addPropertyValue("returnAttributes", element.getAttribute("returnAttributes"));
+      }
+      builder.addPropertyValue("searchScope", element.getAttribute("searchScope"));
+      builder.addPropertyValue("timeLimit", element.getAttribute("timeLimit"));
+      builder.addPropertyValue("sizeLimit", element.getAttribute("sizeLimit"));
+      if (element.hasAttribute("binaryAttributes")) {
+        builder.addPropertyValue("binaryAttributes", element.getAttribute("binaryAttributes"));
+      }
+      builder.addPropertyValue("sortBehavior", element.getAttribute("sortBehavior"));
+    }
+  }
 }
diff --git a/beans/src/main/resources/org/ldaptive/beans/spring/spring-ext.xsd b/beans/src/main/resources/org/ldaptive/beans/spring/spring-ext.xsd
@@ -13,6 +13,7 @@
   <xsd:element name="ad-authenticator" type="adAuthenticatorType"/>
   <xsd:element name="pooled-connection-factory" type="pooledConnectionFactoryType"/>
   <xsd:element name="connection-factory" type="connectionFactoryType"/>
+  <xsd:element name="search-executor" type="searchExecutorType"/>
 
   <xsd:complexType name="anonymousSearchAuthenticatorType">
     <xsd:complexContent>
@@ -94,4 +95,16 @@
     <xsd:attribute name="provider" type="xsd:string" use="optional" default="org.ldaptive.provider.jndi.JndiProvider"/>
   </xsd:complexType>
 
+  <xsd:complexType name="searchExecutorType">
+    <xsd:attribute name="id" type="xsd:ID" use="optional"/>
+    <xsd:attribute name="baseDn" type="xsd:string" use="optional" default=""/>
+    <xsd:attribute name="searchFilter" type="xsd:string" use="optional"/>
+    <xsd:attribute name="returnAttributes" type="xsd:string" use="optional"/>
+    <xsd:attribute name="searchScope" type="xsd:string" use="optional" default="SUBTREE"/>
+    <xsd:attribute name="timeLimit" type="xsd:string" use="optional" default="0"/>
+    <xsd:attribute name="sizeLimit" type="xsd:string" use="optional" default="0"/>
+    <xsd:attribute name="binaryAttributes" type="xsd:string" use="optional"/>
+    <xsd:attribute name="sortBehavior" type="xsd:string" use="optional" default="UNORDERED"/>
+  </xsd:complexType>
+
 </xsd:schema>
diff --git a/integration/src/test/java/org/ldaptive/beans/spring/NamespaceHandlerTest.java b/integration/src/test/java/org/ldaptive/beans/spring/NamespaceHandlerTest.java
@@ -5,6 +5,9 @@
 import org.ldaptive.ConnectionConfig;
 import org.ldaptive.DefaultConnectionFactory;
 import org.ldaptive.LdapException;
+import org.ldaptive.SearchExecutor;
+import org.ldaptive.SearchScope;
+import org.ldaptive.SortBehavior;
 import org.ldaptive.auth.AuthenticationHandler;
 import org.ldaptive.auth.Authenticator;
 import org.ldaptive.auth.DnResolver;
@@ -126,6 +129,10 @@ public void testSpringWiring()
       DefaultConnectionFactory.class);
     AssertJUnit.assertNotNull(connectionFactory);
     testConnectionConfig(connectionFactory.getConnectionConfig());
+
+    final SearchExecutor executor = context.getBean("search-executor", SearchExecutor.class);
+    AssertJUnit.assertNotNull(executor);
+    testSearchExecutor(executor);
   }
 
 
@@ -210,4 +217,22 @@ private void testConnectionConfig(final ConnectionConfig connectionConfig)
       AssertJUnit.assertNotNull(((KeyStoreCredentialConfig) credentialConfig).getTrustStore());
     }
   }
+
+
+  /**
+   * Runs asserts against the search executor.
+   *
+   * @param  executor  to test
+   */
+  private void testSearchExecutor(final SearchExecutor executor)
+  {
+    AssertJUnit.assertTrue(executor.getBaseDn().length() > 0);
+    AssertJUnit.assertNotNull(executor.getSearchFilter());
+    AssertJUnit.assertTrue(executor.getReturnAttributes().length > 0);
+    AssertJUnit.assertEquals(SearchScope.ONELEVEL, executor.getSearchScope());
+    AssertJUnit.assertEquals(5000, executor.getTimeLimit());
+    AssertJUnit.assertEquals(10, executor.getSizeLimit());
+    AssertJUnit.assertTrue(executor.getBinaryAttributes().length > 0);
+    AssertJUnit.assertEquals(SortBehavior.ORDERED, executor.getSortBehavior());
+  }
 }
diff --git a/integration/src/test/resources/spring-ext-context.xml b/integration/src/test/resources/spring-ext-context.xml
@@ -75,4 +75,15 @@
     trustCertificates="classpath:/ldaptive.trust.crt"
   />
 
+  <ldaptive:search-executor
+    baseDn="${ldap.baseDn}"
+    searchFilter="(mail=*)"
+    returnAttributes="cn,givenName,sn"
+    searchScope="ONELEVEL"
+    timeLimit="${ldap.timeLimit}"
+    sizeLimit="${ldap.sizeLimit}"
+    binaryAttributes="jpegPhoto,userCertificate"
+    sortBehavior="ORDERED"
+  />
+
 </beans>
diff --git a/integration/src/test/resources/spring-ext.properties b/integration/src/test/resources/spring-ext.properties
@@ -11,4 +11,8 @@ ldap.ppolicy=true
 ldap.trustCertificates=classpath:/ldaptive.trust.crt
 ldap.trustStore=classpath:/ldaptive.truststore
 ldap.trustStorePassword=changeit
-ldap.trustStoreType=BKS
+ldap.trustStoreType=BKS
+
+# search executor
+ldap.timeLimit=5000
+ldap.sizeLimit=10