org.apache.directory.server.core.integ

Class IntegrationUtils

java.lang.Object

org.apache.directory.server.core.integ.IntegrationUtils

Direct Known Subclasses:

ServerIntegrationUtils

public class IntegrationUtils
extends java.lang.Object

Integration test utility methods.

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG The class logger
private static java.util.List<org.apache.directory.ldap.client.api.LdapConnection>	OPEN_CONNECTIONS

Constructor Summary

Constructors

Constructor and Description
IntegrationUtils()

Method Summary

Modifier and Type	Method and Description
static void	apply(DirectoryService service, org.apache.directory.api.ldap.model.ldif.LdifEntry entry)
static void	closeConnections()
static void	disableSchema(DirectoryService service, java.lang.String schemaName)
static void	doDelete(java.io.File wkdir) Deletes the working directory.
static void	enableSchema(DirectoryService service, java.lang.String schemaName)
static org.apache.directory.ldap.client.api.LdapConnection	getAdminConnection(DirectoryService dirService) Gets a LdapCoreSessionConnection bound using the default admin Dn uid=admin,ou=system and password "secret"
static org.apache.directory.ldap.client.api.LdapConnection	getAdminNetworkConnection(LdapServer ldapServer) Gets a LdapNetworkConnection bound to the Admin user (uid=admin,ou=system).
static org.apache.directory.ldap.client.api.LdapConnection	getAnonymousNetworkConnection(LdapServer ldapServer) Gets an anonymous LdapNetworkConnection
static org.apache.directory.ldap.client.api.LdapConnection	getAnonymousNetworkConnection(java.lang.String host, int port) Gets an anonymous LdapNetworkConnection
static org.apache.directory.ldap.client.api.LdapConnection	getConnectionAs(DirectoryService dirService, org.apache.directory.api.ldap.model.name.Dn dn, java.lang.String password) Gets a LdapCoreSessionConnection bound using a user's DN and a password.
static org.apache.directory.ldap.client.api.LdapConnection	getConnectionAs(DirectoryService dirService, java.lang.String dn, java.lang.String password) Gets a LdapCoreSessionConnection bound using a user's DN and a password.
static javax.naming.ldap.LdapContext	getContext(java.lang.String principalDn, DirectoryService service, java.lang.String dn)
static CoreSession	getCoreSession(java.lang.String principalDn, DirectoryService service, java.lang.String dn)
static org.apache.directory.ldap.client.api.LdapConnection	getNetworkConnectionAs(LdapServer ldapServer, java.lang.String userDn, java.lang.String password) Gets a LdapNetworkConnection bound using a user's DN and a password.
static org.apache.directory.ldap.client.api.LdapConnection	getNetworkConnectionAs(java.lang.String host, int port, java.lang.String dn, java.lang.String password) Gets a LdapNetworkConnection bound using a user's DN and a password.
static javax.naming.ldap.LdapContext	getRootContext(DirectoryService service)
static javax.naming.ldap.LdapContext	getSchemaContext(DirectoryService service)
static javax.naming.ldap.LdapContext	getSystemContext(DirectoryService service)
static org.apache.directory.api.ldap.model.ldif.LdifEntry	getUserAddLdif()
static org.apache.directory.api.ldap.model.ldif.LdifEntry	getUserAddLdif(java.lang.String dnstr, byte[] password, java.lang.String cn, java.lang.String sn)
static void	injectEntries(DirectoryService service, java.lang.String ldif) Inject an ldif String into the server.
static boolean	isDisabled(DirectoryService service, java.lang.String schemaName) A helper method which tells if a schema is disabled.
static boolean	isEnabled(DirectoryService service, java.lang.String schemaName) A helper method which tells if a schema is enabled.
static boolean	isLoaded(DirectoryService service, java.lang.String schemaName) A helper method which tells if a schema is loaded.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

The class logger

OPEN_CONNECTIONS

private static final java.util.List<org.apache.directory.ldap.client.api.LdapConnection> OPEN_CONNECTIONS

Constructor Detail

IntegrationUtils

public IntegrationUtils()

Method Detail

doDelete

public static void doDelete(java.io.File wkdir)
                     throws java.io.IOException

Deletes the working directory.

Parameters:

wkdir - the working directory to delete

Throws:

java.io.IOException - if the working directory cannot be deleted

injectEntries

public static void injectEntries(DirectoryService service,
                                 java.lang.String ldif)
                          throws java.lang.Exception

Inject an ldif String into the server. Dn must be relative to the root.

Parameters:

service - the directory service to use

ldif - the ldif containing entries to add to the server.

Throws:

javax.naming.NamingException - if there is a problem adding the entries from the LDIF

java.lang.Exception

getUserAddLdif

public static org.apache.directory.api.ldap.model.ldif.LdifEntry getUserAddLdif()
                                                                         throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getContext

public static javax.naming.ldap.LdapContext getContext(java.lang.String principalDn,
                                                       DirectoryService service,
                                                       java.lang.String dn)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

getCoreSession

public static CoreSession getCoreSession(java.lang.String principalDn,
                                         DirectoryService service,
                                         java.lang.String dn)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getSystemContext

public static javax.naming.ldap.LdapContext getSystemContext(DirectoryService service)
                                                      throws java.lang.Exception

Throws:

java.lang.Exception

getSchemaContext

public static javax.naming.ldap.LdapContext getSchemaContext(DirectoryService service)
                                                      throws java.lang.Exception

Throws:

java.lang.Exception

getRootContext

public static javax.naming.ldap.LdapContext getRootContext(DirectoryService service)
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

apply

public static void apply(DirectoryService service,
                         org.apache.directory.api.ldap.model.ldif.LdifEntry entry)
                  throws java.lang.Exception

Throws:

java.lang.Exception

getUserAddLdif

public static org.apache.directory.api.ldap.model.ldif.LdifEntry getUserAddLdif(java.lang.String dnstr,
                                                                                byte[] password,
                                                                                java.lang.String cn,
                                                                                java.lang.String sn)
                                                                         throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

enableSchema

public static void enableSchema(DirectoryService service,
                                java.lang.String schemaName)
                         throws java.lang.Exception

Throws:

java.lang.Exception

disableSchema

public static void disableSchema(DirectoryService service,
                                 java.lang.String schemaName)
                          throws java.lang.Exception

Throws:

java.lang.Exception

isDisabled

public static boolean isDisabled(DirectoryService service,
                                 java.lang.String schemaName)

A helper method which tells if a schema is disabled.

isLoaded

public static boolean isLoaded(DirectoryService service,
                               java.lang.String schemaName)

A helper method which tells if a schema is loaded.

isEnabled

public static boolean isEnabled(DirectoryService service,
                                java.lang.String schemaName)

A helper method which tells if a schema is enabled. A shema must be loaded and enabled.

getAdminConnection

public static org.apache.directory.ldap.client.api.LdapConnection getAdminConnection(DirectoryService dirService)
                                                                              throws java.lang.Exception

Gets a LdapCoreSessionConnection bound using the default admin Dn uid=admin,ou=system and password "secret"

Parameters:

dirService - The Directory Service to be connected to

Returns:

A LdapCoreSessionConnection instance

Throws:

If - the connection could not be established.

java.lang.Exception

getConnectionAs

public static org.apache.directory.ldap.client.api.LdapConnection getConnectionAs(DirectoryService dirService,
                                                                                  java.lang.String dn,
                                                                                  java.lang.String password)
                                                                           throws java.lang.Exception

Gets a LdapCoreSessionConnection bound using a user's DN and a password. We will bind using those credentials.

Parameters:

dirService - The Directory Service to be connected to

dn - The User's DN as a String

password - The User's password as a String

Returns:

A LdapCoreSessionConnection instance

Throws:

If - the connection could not be established.

java.lang.Exception

getConnectionAs

public static org.apache.directory.ldap.client.api.LdapConnection getConnectionAs(DirectoryService dirService,
                                                                                  org.apache.directory.api.ldap.model.name.Dn dn,
                                                                                  java.lang.String password)
                                                                           throws java.lang.Exception

Gets a LdapCoreSessionConnection bound using a user's DN and a password. We will bind using those credentials.

Parameters:

dirService - The Directory Service to be connected to

dn - The User's DN

password - The User's password as a String

Returns:

A LdapCoreSessionConnection instance

Throws:

If - the connection could not be established.

java.lang.Exception

getNetworkConnectionAs

public static org.apache.directory.ldap.client.api.LdapConnection getNetworkConnectionAs(java.lang.String host,
                                                                                         int port,
                                                                                         java.lang.String dn,
                                                                                         java.lang.String password)
                                                                                  throws java.lang.Exception

Gets a LdapNetworkConnection bound using a user's DN and a password. We will bind using those credentials.

Parameters:

dirService - The Directory Service to be connected to

dn - The User's DN as a String

password - The User's password as a String

Returns:

A LdapNetworkConnection instance

Throws:

If - the connection could not be established.

java.lang.Exception

getAnonymousNetworkConnection

public static org.apache.directory.ldap.client.api.LdapConnection getAnonymousNetworkConnection(LdapServer ldapServer)
                                                                                         throws java.lang.Exception

Gets an anonymous LdapNetworkConnection

Parameters:

dirService - The Directory Service to be connected to

Returns:

A LdapNetworkConnection instance

Throws:

If - the connection could not be established.

java.lang.Exception

getAnonymousNetworkConnection

public static org.apache.directory.ldap.client.api.LdapConnection getAnonymousNetworkConnection(java.lang.String host,
                                                                                                int port)
                                                                                         throws java.lang.Exception

Gets an anonymous LdapNetworkConnection

Parameters:

dirService - The Directory Service to be connected to

Returns:

A LdapNetworkConnection instance

Throws:

If - the connection could not be established.

java.lang.Exception

getAdminNetworkConnection

public static org.apache.directory.ldap.client.api.LdapConnection getAdminNetworkConnection(LdapServer ldapServer)
                                                                                     throws java.lang.Exception

Gets a LdapNetworkConnection bound to the Admin user (uid=admin,ou=system).

Parameters:

dirService - The Directory Service to be connected to

Returns:

A LdapNetworkConnection instance

Throws:

If - the connection could not be established.

java.lang.Exception

getNetworkConnectionAs

public static org.apache.directory.ldap.client.api.LdapConnection getNetworkConnectionAs(LdapServer ldapServer,
                                                                                         java.lang.String userDn,
                                                                                         java.lang.String password)
                                                                                  throws java.lang.Exception

Gets a LdapNetworkConnection bound using a user's DN and a password. We will bind using those credentials. We specify a LdapServer instance too.

Parameters:

ldapServer - The LdapServer to be connected to

dn - The User's DN as a String

password - The User's password as a String

Returns:

A LdapNetworkConnection instance

Throws:

If - the connection could not be established.

java.lang.Exception

closeConnections

public static void closeConnections()