org.zapodot.junit.ldap

Class EmbeddedLdapRuleBuilder

java.lang.Object

org.zapodot.junit.ldap.EmbeddedLdapRuleBuilder

public class EmbeddedLdapRuleBuilder
extends Object

A builder providing a fluent way of defining EmbeddedLdapRule instances

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BIND_CREDENTIALS
static String	DEFAULT_BIND_DSN
static String	DEFAULT_DOMAIN
static String	LDAP_SERVER_LISTENER_NAME
static int	MAX_PORT_EXCLUSIVE
static int	MIN_PORT_EXCLUSIVE

Constructor Summary

Constructors

Constructor and Description
EmbeddedLdapRuleBuilder()

Method Summary

Modifier and Type	Method and Description
EmbeddedLdapRuleBuilder	bindingToAddress(String address) Allows the listening address for the embedded LDAP server to be set.
EmbeddedLdapRuleBuilder	bindingToPort(int port) Sets the port that the in-memory LDAP server will bind to.
EmbeddedLdapRule	build() Creates a new rule based on the information that was previously provided
EmbeddedLdapRuleBuilder	importingLdifs(String... ldifFiles) Specify one or more LDIF resources to be imported on startup.
static EmbeddedLdapRuleBuilder	newInstance() Creates a new builder
EmbeddedLdapRuleBuilder	usingBindCredentials(String bindCredentials) Sets the credentials to be used to authenticate.
EmbeddedLdapRuleBuilder	usingBindDSN(String bindDSN) Sets the DSN to bind to when authenticating.
EmbeddedLdapRuleBuilder	usingDomainDsn(String domainDsn) Sets a domainDsn to be used.
EmbeddedLdapRuleBuilder	withoutDefaultSchema() Avoid adding UnboundID's default schema that contains the most common LDAP elements defined through various RFC's.
EmbeddedLdapRuleBuilder	withSchema(String... ldifSchemaFiles) Define schemas to be used for the server.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DOMAIN

public static final String DEFAULT_DOMAIN

See Also:

Constant Field Values

DEFAULT_BIND_DSN

public static final String DEFAULT_BIND_DSN

See Also:

Constant Field Values

DEFAULT_BIND_CREDENTIALS

public static final String DEFAULT_BIND_CREDENTIALS

See Also:

Constant Field Values

LDAP_SERVER_LISTENER_NAME

public static final String LDAP_SERVER_LISTENER_NAME

See Also:

Constant Field Values

MIN_PORT_EXCLUSIVE

public static final int MIN_PORT_EXCLUSIVE

See Also:

Constant Field Values

MAX_PORT_EXCLUSIVE

public static final int MAX_PORT_EXCLUSIVE

See Also:

Constant Field Values

Constructor Detail

EmbeddedLdapRuleBuilder

public EmbeddedLdapRuleBuilder()

Method Detail

newInstance

public static EmbeddedLdapRuleBuilder newInstance()

Creates a new builder

Returns:

a new EmbeddedLdapRuleBuilder instance

usingDomainDsn

public EmbeddedLdapRuleBuilder usingDomainDsn(String domainDsn)

Sets a domainDsn to be used. May be multiple values. If not set, it will default to the value of the DEFAULT_DOMAIN field

Parameters:

domainDsn - a valid DSN string

Returns:

same EmbeddedLdapRuleBuilder instance with the domainDsn field set

usingBindDSN

public EmbeddedLdapRuleBuilder usingBindDSN(String bindDSN)

Sets the DSN to bind to when authenticating. If not set, it will default to the value of the DEFAULT_BIND_DSN field

Parameters:

bindDSN - a valid DSN string

Returns:

same EmbeddedLdapRuleBuilder instance with the bindDSN field set

usingBindCredentials

public EmbeddedLdapRuleBuilder usingBindCredentials(String bindCredentials)

Sets the credentials to be used to authenticate. If not set, it will default to the value of the DEFAULT_BIND_CREDENTIALS field

Parameters:

bindCredentials - a password string

Returns:

same EmbeddedLdapRuleBuilder instance with the bindCredentials field set

bindingToPort

public EmbeddedLdapRuleBuilder bindingToPort(int port)

Sets the port that the in-memory LDAP server will bind to. If not set, an available port will be picked automatically

Parameters:

port - a port number

Returns:

same EmbeddedLdapRuleBuilder instance with the port field set

Throws:

IllegalArgumentException - if the provided value for port is not between @{link MIN_PORT_EXCLUSIVE} and @{MAX_PORT_EXCLUSIVE} (exclusive)

bindingToAddress

public EmbeddedLdapRuleBuilder bindingToAddress(String address)

Allows the listening address for the embedded LDAP server to be set. If not set it will bind to localhost/127.0.0.1.

Parameters:

address - a valid hostname or textual representation of an IP address

Returns:

same EmbeddedLdapRuleBuilder instance with the bindAddress field set

Throws:

IllegalArgumentException - if the value provided for \"address\" is invalid

withoutDefaultSchema

public EmbeddedLdapRuleBuilder withoutDefaultSchema()

Avoid adding UnboundID's default schema that contains the most common LDAP elements defined through various RFC's.

Returns:

same EmbeddedLdapRuleBuilder instance with the withoutDefaultSchema field set to FALSE

withSchema

public EmbeddedLdapRuleBuilder withSchema(String... ldifSchemaFiles)

Define schemas to be used for the server. If not defined, UnboundID will set up a default schema.

Parameters:

ldifSchemaFiles - LDIF-files containing schema element definitions

Returns:

same EmbeddedLdapRuleBuilder with the given LDIF-files added to the internal schema file collection.

importingLdifs

public EmbeddedLdapRuleBuilder importingLdifs(String... ldifFiles)

Specify one or more LDIF resources to be imported on startup.

Parameters:

ldifFiles - LDIF-files to import

Returns:

same EmbeddedLdapRuleBuilder instance with the provided ldifFiles added to the list of LDIF files to import

build

public EmbeddedLdapRule build()

Creates a new rule based on the information that was previously provided

Returns:

a new EmbeddedLdapRule instance