org.zapodot.junit.ldap

Interface EmbeddedLdapRule

All Superinterfaces:

TestRule

All Known Implementing Classes:

EmbeddedLdapRuleImpl

public interface EmbeddedLdapRule
extends TestRule

A JUnit rule that may be used as either a @Rule or a @ClassRule

Method Summary

Modifier and Type	Method and Description
Context	context() For tests depending on the standard Java JNDI API
DirContext	dirContext() Like context(), but returns a DirContext
int	embeddedServerPort() Gives access to the listening port for the currently running embedded LDAP server.
LDAPInterface	ldapConnection() For tests depending on the UnboundID LDAP SDK.
LDAPConnection	unsharedLdapConnection() For tests depending on the UnboundID LDAP SDK that needs access to an ${link LDAPConnection} object rather than the interface.

Methods inherited from interface org.junit.rules.TestRule

apply

Method Detail

ldapConnection

LDAPInterface ldapConnection()
                      throws LDAPException

For tests depending on the UnboundID LDAP SDK. Returns a proxied version of an Unboundid interface that will be closed when the test(s) have been invoked

Returns:

a shared LDAPConnection

Throws:

LDAPException - if a connection can not be opened

unsharedLdapConnection

LDAPConnection unsharedLdapConnection()
                               throws LDAPException

For tests depending on the UnboundID LDAP SDK that needs access to an ${link LDAPConnection} object rather than the interface. If your code does not close the connection for you it will be closed on teardown

Returns:

a LDAPConnection connected to the embedded LDAP server

Throws:

LDAPException - if an exception occurred while establishing the connection

context

Context context()
         throws NamingException

For tests depending on the standard Java JNDI API

Returns:

a shared Context connected to the in-memory LDAP server

Throws:

NamingException - if context can not be created

dirContext

DirContext dirContext()
               throws NamingException

Like context(), but returns a DirContext

Returns:

a DirContext connected to the in-memory LDAP server

Throws:

NamingException - if a LDAP failure happens during DirContext creation

embeddedServerPort

int embeddedServerPort()

Gives access to the listening port for the currently running embedded LDAP server. This will make it easier to use other integration mechanisms

Note: the embedded LDAP server is by default configured to listen only on the loopback address (i.e localhost/127.0.0.1) unless another address has been provided to the builder when the rule was built

Returns:

the port number that the embedded server is listening to

See Also:

EmbeddedLdapRuleBuilder.bindingToAddress(String)