Index (LDAPUnit 3.0.1 API)

A B C D E G L R S V

A

afterTestExecution(ExtensionContext) - Method in class com.buralotech.oss.ldapunit.DirectoryServerExtension: This callback is invoked after the test method is executed and is responsible for stopping the embedded directory server.
annotation - Variable in class com.buralotech.oss.ldapunit.DirectoryServerRule: The current configuration for the in-memory LDAP directory server.
annotation - Variable in class com.buralotech.oss.ldapunit.DirectoryServerStatement: The annotation that defines the directory server configuration.
apply(Statement, Description) - Method in class com.buralotech.oss.ldapunit.DirectoryServerRule: Modifies the method-running Statement to implement this test-running rule.
arrayContains(String[], String) - Method in class com.buralotech.oss.ldapunit.DirectoryTester: Check if item is present in items ignoring case.
arrayToString(String[]) - Method in class com.buralotech.oss.ldapunit.DirectoryTester: Convert an array of strings to string.
assertDNExists(String) - Method in class com.buralotech.oss.ldapunit.DirectoryServerRule: Assert that an entry identified by dn exists.
assertDNExists(String) - Method in class com.buralotech.oss.ldapunit.DirectoryTester: Assert that an entry identified by dn exists.
assertDNHasAttribute(String, String) - Method in class com.buralotech.oss.ldapunit.DirectoryServerRule: Assert that the entry identified by dn has an attribute named attributeName.
assertDNHasAttribute(String, String) - Method in class com.buralotech.oss.ldapunit.DirectoryTester: Assert that the entry identified by dn has an attribute named attributeName.
assertDNHasAttributeValue(String, String, String...) - Method in class com.buralotech.oss.ldapunit.DirectoryServerRule: Assert that the entry identified by dn has an attribute named attributeName with the attribute value(s) attributeName.
assertDNHasAttributeValue(String, String, String...) - Method in class com.buralotech.oss.ldapunit.DirectoryTester: Assert that the entry identified by dn has an attribute named attributeName with the attribute value(s) attributeName.
assertDNIsA(String, String) - Method in class com.buralotech.oss.ldapunit.DirectoryServerRule: Assert that the entry identified by dn is of type objectclass.
assertDNIsA(String, String) - Method in class com.buralotech.oss.ldapunit.DirectoryTester: Assert that the entry identified by dn is of type objectclass.

B

base - Variable in class com.buralotech.oss.ldapunit.DirectoryServerStatement: The wrapped statement Statement.
beforeTestExecution(ExtensionContext) - Method in class com.buralotech.oss.ldapunit.DirectoryServerExtension: This callback is invoked before the test method is executed and is responsible for starting the embedded directory server.

C

close() - Method in class com.buralotech.oss.ldapunit.DirectoryTester: Close The directory tester by disconnecting from the LDAP directory server.
com.buralotech.oss.ldapunit - package com.buralotech.oss.ldapunit: The implementation of the LDAPUnit.
connection - Variable in class com.buralotech.oss.ldapunit.DirectoryTester: The connection to the LDAP directory server.

D

DEFAULT_PORT - Static variable in annotation type com.buralotech.oss.ldapunit.DirectoryServerConfiguration: The default TCP port for the directory server.
DEFAULT_RETRIES - Static variable in class com.buralotech.oss.ldapunit.DirectoryTester: The default for the maximum connection attempts.
DEFAULT_TIMEOUT - Static variable in class com.buralotech.oss.ldapunit.DirectoryTester: The default for the connection timeout.
DirectoryServerConfiguration - Annotation Type in com.buralotech.oss.ldapunit: This annotation is used to specify the parameters used to configure the LDAP directory server.
DirectoryServerExtension - Class in com.buralotech.oss.ldapunit: JUnit 5 (Jupiter) extension that will start an embedded directory server before the test method execution and stop the embedded directory server when the test method completes.
DirectoryServerExtension() - Constructor for class com.buralotech.oss.ldapunit.DirectoryServerExtension
DirectoryServerRule - Class in com.buralotech.oss.ldapunit: A JUnit test rule that starts an embedded LDAP directory server.
DirectoryServerRule() - Constructor for class com.buralotech.oss.ldapunit.DirectoryServerRule
DirectoryServerStatement - Class in com.buralotech.oss.ldapunit: A Statement wrapper that launches an embedded LDAP directory server before executing the wrapped statement.
DirectoryServerStatement(Statement, DirectoryServerConfiguration) - Constructor for class com.buralotech.oss.ldapunit.DirectoryServerStatement: Initialise the wrapper statement that starts an embedded LDAP directory server and shuts it down before and after executing the wrapped statement.
DirectoryServerUtils - Class in com.buralotech.oss.ldapunit: Helper functions to start the in-memory LDAP directory server, load LDAP directory entries from an LDIF files and shut down the in-memory LDAP directory server.
DirectoryServerUtils() - Constructor for class com.buralotech.oss.ldapunit.DirectoryServerUtils: Hidden constructor.
DirectoryTester - Class in com.buralotech.oss.ldapunit: Utility that maintains a connection to the LDAP directory server and provides assert and verify methods to test the LDAP directory contents.
DirectoryTester(LDAPConnection) - Constructor for class com.buralotech.oss.ldapunit.DirectoryTester: Initialise the LDAP directory tester using an existing LDAP connection.
DirectoryTester() - Constructor for class com.buralotech.oss.ldapunit.DirectoryTester: Initialise the LDAP directory tester using the default hostname of localhost and port number of DirectoryServerConfiguration.DEFAULT_PORT.
DirectoryTester(String, int) - Constructor for class com.buralotech.oss.ldapunit.DirectoryTester: Initialise the LDAP directory tester by connecting to the LDAP directory server using the hostname and port.
DirectoryTester(String, int, int, int) - Constructor for class com.buralotech.oss.ldapunit.DirectoryTester: Initialise the LDAP directory tester by connecting to the LDAP directory server using the hostname and port.The connection attempt is retried a maximum of retries times with a timeout of timeout for each attempt.
DirectoryTester(String, int, String, String) - Constructor for class com.buralotech.oss.ldapunit.DirectoryTester: Initialise the LDAP directory tester by connecting to the LDAP directory server using the hostname and port and bind to it using the bindDN and password.
DirectoryTester(String, int, String, String, int, int) - Constructor for class com.buralotech.oss.ldapunit.DirectoryTester: Initialise the LDAP directory tester by connecting to the LDAP directory server using the hostname and port and bind to it using the bindDN and password.
DirectoryTesterException - Exception in com.buralotech.oss.ldapunit: Runtime exception raised by DirectoryTester when there is a problem communicating with the LDAP directory server.
DirectoryTesterException() - Constructor for exception com.buralotech.oss.ldapunit.DirectoryTesterException: The default constructor.
DirectoryTesterException(String) - Constructor for exception com.buralotech.oss.ldapunit.DirectoryTesterException: Construct a DirectoryTesterException with an message describing the source of the exception.
DirectoryTesterException(Throwable) - Constructor for exception com.buralotech.oss.ldapunit.DirectoryTesterException: Construct a DirectoryTesterException with a root cause.
DirectoryTesterException(String, Throwable) - Constructor for exception com.buralotech.oss.ldapunit.DirectoryTesterException: Construct a DirectoryTesterException with an message describing the source of the exception and a root cause.
disconnect() - Method in class com.buralotech.oss.ldapunit.DirectoryTester: Disconnect from the LDAP directory server.

E

evaluate() - Method in class com.buralotech.oss.ldapunit.DirectoryServerStatement: Start an embedded LDAP directory server before executing the wrapped statement and shutdown the LDAP directory server after the wrapped statement completes.

G

getAnnotation(ExtensionContext) - Method in class com.buralotech.oss.ldapunit.DirectoryServerExtension: Locate the annotation that specifies the configuration for the embedded directory server.
getDirectoryTester() - Method in class com.buralotech.oss.ldapunit.DirectoryServerRule: Create a DirectoryTester that connects to the in-memory LDAP directory server created by this rule.
getInputStream(String) - Static method in class com.buralotech.oss.ldapunit.DirectoryServerUtils: Look for path on the classpath or file system and return an InputStream if found.
getStore(ExtensionContext) - Method in class com.buralotech.oss.ldapunit.DirectoryServerExtension: Get teh context storage for the method invocation.

L

loadData(InMemoryDirectoryServer, String) - Static method in class com.buralotech.oss.ldapunit.DirectoryServerUtils: Load LDIF records from a file to seed the LDAP directory.
loadData(LDAPConnection, InputStream) - Static method in class com.buralotech.oss.ldapunit.DirectoryServerUtils: Load LDIF records from an input stream to seed the LDAP directory.
loadSchema(InMemoryDirectoryServerConfig, String[]) - Static method in class com.buralotech.oss.ldapunit.DirectoryServerUtils: Load a custom schema.

R

resolveParameter(ParameterContext, ExtensionContext) - Method in class com.buralotech.oss.ldapunit.DirectoryServerExtension: Resolve DirectoryTester parameters.

S

SERVER - Static variable in class com.buralotech.oss.ldapunit.DirectoryServerExtension: The name of the property used to cache the reference to the embedded directory server.
startServer(DirectoryServerConfiguration) - Static method in class com.buralotech.oss.ldapunit.DirectoryServerUtils: Start the directory server using the configuration specified by the DirectoryServerConfiguration annotation.
startServer(int, String, String[], String[], String, String, String[], String[]) - Static method in class com.buralotech.oss.ldapunit.DirectoryServerUtils: Create and configure an embedded LDAP directory server, load seed data and start the server.
stopServer(InMemoryDirectoryServer) - Static method in class com.buralotech.oss.ldapunit.DirectoryServerUtils: Shutdown the embedded LDAP directory server.
supportsParameter(ParameterContext, ExtensionContext) - Method in class com.buralotech.oss.ldapunit.DirectoryServerExtension: Check the parameter type is DirectoryTester.

V

verifyDNExists(String) - Method in class com.buralotech.oss.ldapunit.DirectoryServerRule: Verify that an entry identified by dn exists.
verifyDNExists(String) - Method in class com.buralotech.oss.ldapunit.DirectoryTester: Verify that an entry identified by dn exists.
verifyDNHasAttribute(String, String) - Method in class com.buralotech.oss.ldapunit.DirectoryServerRule: Verify that the entry identified by dn has an attribute named attributeName.
verifyDNHasAttribute(String, String) - Method in class com.buralotech.oss.ldapunit.DirectoryTester: Verify that the entry identified by dn has an attribute named attributeName.
verifyDNHasAttributeValue(String, String, String...) - Method in class com.buralotech.oss.ldapunit.DirectoryServerRule: Verify that the entry identified by dn has an attribute named attributeName with the attribute value(s) attributeName.
verifyDNHasAttributeValue(String, String, String...) - Method in class com.buralotech.oss.ldapunit.DirectoryTester: Verify that the entry identified by dn has an attribute named attributeName with the attribute value(s) attributeName.
verifyDNIsA(String, String) - Method in class com.buralotech.oss.ldapunit.DirectoryServerRule: Verify that the entry identified by dn is of type objectclass.
verifyDNIsA(String, String) - Method in class com.buralotech.oss.ldapunit.DirectoryTester: Verify that the entry identified by dn is of type objectclass.

A B C D E G L R S V