org.zapodot.junit.ldap.internal

Class EmbeddedLdapRuleImpl

java.lang.Object

org.zapodot.junit.ldap.internal.EmbeddedLdapRuleImpl

All Implemented Interfaces:

org.junit.rules.TestRule, EmbeddedLdapRule

public class EmbeddedLdapRuleImpl
extends Object
implements EmbeddedLdapRule

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)
Context	context() For tests depending on the standard Java JNDI API
static EmbeddedLdapRule	createForConfiguration(com.unboundid.ldap.listener.InMemoryDirectoryServerConfig inMemoryDirectoryServerConfig, AuthenticationConfiguration authenticationConfiguration, List<String> ldifs)
DirContext	dirContext() Like EmbeddedLdapRule.context(), but returns a DirContext
int	embeddedServerPort() Gives access to the listening port for the currently running embedded LDAP server.
com.unboundid.ldap.sdk.LDAPInterface	ldapConnection() For tests depending on the UnboundID LDAP SDK.
com.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 class java.lang.Object

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

Method Detail

createForConfiguration

public static EmbeddedLdapRule createForConfiguration(com.unboundid.ldap.listener.InMemoryDirectoryServerConfig inMemoryDirectoryServerConfig,
                                                      AuthenticationConfiguration authenticationConfiguration,
                                                      List<String> ldifs)

ldapConnection

public com.unboundid.ldap.sdk.LDAPInterface ldapConnection()
                                                    throws com.unboundid.ldap.sdk.LDAPException

Description copied from interface: EmbeddedLdapRule

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

Specified by:

ldapConnection in interface EmbeddedLdapRule

Returns:

a shared LDAPConnection

Throws:

com.unboundid.ldap.sdk.LDAPException - if a connection can not be opened

unsharedLdapConnection

public com.unboundid.ldap.sdk.LDAPConnection unsharedLdapConnection()
                                                             throws com.unboundid.ldap.sdk.LDAPException

Description copied from interface: EmbeddedLdapRule

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

Specified by:

unsharedLdapConnection in interface EmbeddedLdapRule

Returns:

a LDAPConnection connected to the embedded LDAP server

Throws:

com.unboundid.ldap.sdk.LDAPException - if an exception occurred while establishing the connection

context

public Context context()
                throws NamingException

Description copied from interface: EmbeddedLdapRule

For tests depending on the standard Java JNDI API

Specified by:

context in interface EmbeddedLdapRule

Returns:

a shared Context connected to the in-memory LDAP server

Throws:

NamingException - if context can not be created

dirContext

public DirContext dirContext()
                      throws NamingException

Description copied from interface: EmbeddedLdapRule

Like EmbeddedLdapRule.context(), but returns a DirContext

Specified by:

dirContext in interface EmbeddedLdapRule

Returns:

a DirContext connected to the in-memory LDAP server

Throws:

NamingException - if a LDAP failure happens during DirContext creation

embeddedServerPort

public int embeddedServerPort()

Description copied from interface: EmbeddedLdapRule

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

Specified by:

embeddedServerPort in interface EmbeddedLdapRule

Returns:

the port number that the embedded server is listening to

See Also:

EmbeddedLdapRuleBuilder.bindingToAddress(String)

apply

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

Specified by:

apply in interface org.junit.rules.TestRule