com.zeroturnaround.liverebel.api
Interface LdapDomainCreation

All Known Implementing Classes:

LdapDomainCreationImpl

public interface LdapDomainCreation

Method Summary

void	execute() Creates the domain.
LdapDomainCreation	host(String host, int port, boolean secure) Configures the address of the LDAP host (Required).
LdapDomainCreation	manager(String distinguishedName, String password) Configures the LDAP user that can be used to search for other users (Required).
LdapDomainCreation	userBase(String userBase) Sets the base distinguished name for the user search (Required). For example: dc=yourcompany,dc=com
LdapDomainCreation	userIdField(String userIdField) Sets the field name in the LDAP server that the user ID will be matched against (Required). For example: userPrincipalName, sAMAccountName or uid

Method Detail

host

LdapDomainCreation host(String host,
                        int port,
                        boolean secure)

Configures the address of the LDAP host (Required).

Parameters:

host - Host of the LDAP server

port - Port of the LDAP server (default is 389 for LDAP and 636 for LDAPS)

secure - If true, the more secure LDAPS protocol is used instead of plain LDAP (Recommended)

manager

LdapDomainCreation manager(String distinguishedName,
                           String password)

Configures the LDAP user that can be used to search for other users (Required).

Parameters:

distinguishedName - The user's distinguished name.
For example: uid=admin,ou=system
Note: Only simple bind authentication is supported.

password - The user's password.

userBase

LdapDomainCreation userBase(String userBase)

Sets the base distinguished name for the user search (Required).
For example: dc=yourcompany,dc=com

userIdField

LdapDomainCreation userIdField(String userIdField)

Sets the field name in the LDAP server that the user ID will be matched against (Required).
For example: userPrincipalName, sAMAccountName or uid

execute

void execute()

Creates the domain.