com.buralotech.oss.ldapunit

Class DirectoryServerRule

java.lang.Object

com.buralotech.oss.ldapunit.DirectoryServerRule

All Implemented Interfaces:

org.junit.rules.TestRule

public final class DirectoryServerRule
extends Object
implements org.junit.rules.TestRule

A JUnit test rule that starts an embedded LDAP directory server. The configuration for the directory server is obtained from the DirectoryServerConfiguration annotation applied to either the test method or the test class.

Since:

1.0.0

Author:

Brian Matthews

Field Summary

Fields

Modifier and Type	Field and Description
private DirectoryServerConfiguration	annotation The current configuration for the in-memory LDAP directory server.

Constructor Summary

Constructors

Constructor and Description
DirectoryServerRule()

Method Summary

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description) Modifies the method-running Statement to implement this test-running rule.
void	assertDNExists(String dn) Assert that an entry identified by dn exists.
void	assertDNHasAttribute(String dn, String attributeName) Assert that the entry identified by dn has an attribute named attributeName.
void	assertDNHasAttributeValue(String dn, String attributeName, String... attributeValue) Assert that the entry identified by dn has an attribute named attributeName with the attribute value(s) attributeName.
void	assertDNIsA(String dn, String objectclass) Assert that the entry identified by dn is of type objectclass.
private DirectoryTester	getDirectoryTester() Create a DirectoryTester that connects to the in-memory LDAP directory server created by this rule.
boolean	verifyDNExists(String dn) Verify that an entry identified by dn exists.
boolean	verifyDNHasAttribute(String dn, String attributeName) Verify that the entry identified by dn has an attribute named attributeName.
boolean	verifyDNHasAttributeValue(String dn, String attributeName, String... attributeValue) Verify that the entry identified by dn has an attribute named attributeName with the attribute value(s) attributeName.
boolean	verifyDNIsA(String dn, String objectclass) Verify that the entry identified by dn is of type objectclass.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

annotation

private DirectoryServerConfiguration annotation

The current configuration for the in-memory LDAP directory server.

Since:

1.0.2

Constructor Detail

DirectoryServerRule

public DirectoryServerRule()

Method Detail

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runner.Description description)

Modifies the method-running Statement to implement this test-running rule. The configuration for the embedded LDAP directory server is obtained from the DirectoryServerConfiguration annotation that was applied to either the test class or test method.

Specified by:

apply in interface org.junit.rules.TestRule

Parameters:

base - The Statement to be modified

description - A Description of the test implemented in base

Returns:

If no configuration was found then base is returned. Otherwise, a new DirectoryServerStatement that wraps base is returned.

verifyDNExists

public boolean verifyDNExists(String dn)

Verify that an entry identified by dn exists.

Parameters:

dn - The distinguished name.

Returns:

true if an entry identified by dn exists. Otherwise, false is returned.

Since:

1.0.2

verifyDNIsA

public boolean verifyDNIsA(String dn,
                           String objectclass)

Verify that the entry identified by dn is of type objectclass.

Parameters:

dn - The distinguished name.

objectclass - The type name.

Returns:

true if an entry identified by dn exists and has attribute named objectclass. Otherwise, false is returned.

Since:

1.0.2

verifyDNHasAttribute

public boolean verifyDNHasAttribute(String dn,
                                    String attributeName)

Verify that the entry identified by dn has an attribute named attributeName.

Parameters:

dn - The distinguished name.

attributeName - The attribute name.

Returns:

true if an entry identified by dn exists and has an attributed named attributeName. Otherwise, false is returned.

Since:

1.0.2

verifyDNHasAttributeValue

public boolean verifyDNHasAttributeValue(String dn,
                                         String attributeName,
                                         String... attributeValue)

Verify that the entry identified by dn has an attribute named attributeName with the attribute value(s) attributeName.

Parameters:

dn - The distinguished name.

attributeName - The attribute name.

attributeValue - The attribute value(s).

Returns:

true if an antry identified by dn exists with an an attribute named attributeName that has value(s) attributeValue. Otherwise, false is returned.

Since:

1.0.2

assertDNExists

public void assertDNExists(String dn)

Assert that an entry identified by dn exists.

Parameters:

dn - The distinguished name.

Since:

1.0.2

assertDNIsA

public void assertDNIsA(String dn,
                        String objectclass)

Assert that the entry identified by dn is of type objectclass.

Parameters:

dn - The distinguished name.

objectclass - The type name.

Since:

1.0.2

assertDNHasAttribute

public void assertDNHasAttribute(String dn,
                                 String attributeName)

Assert that the entry identified by dn has an attribute named attributeName.

Parameters:

dn - The distinguished name

attributeName - The attribute name

Since:

1.0.2

assertDNHasAttributeValue

public void assertDNHasAttributeValue(String dn,
                                      String attributeName,
                                      String... attributeValue)

Assert that the entry identified by dn has an attribute named attributeName with the attribute value(s) attributeName.

Parameters:

dn - The distinguished name

attributeName - The attribute name

attributeValue - The attribute value(s)

Since:

1.0.2

getDirectoryTester

private DirectoryTester getDirectoryTester()

Create a DirectoryTester that connects to the in-memory LDAP directory server created by this rule.

Returns:

The DirectoryTester.

Since:

1.0.2