com.evolveum.midpoint.test.ldap

Class OpenDJController

java.lang.Object

com.evolveum.midpoint.test.ldap.AbstractResourceController

com.evolveum.midpoint.test.ldap.OpenDJController

public class OpenDJController
extends AbstractResourceController

This class controls embedded OpenDJ instance. It is used in Unit tests. It configures and starts and stops the instance. It can even manage a "template" configuration of OpenDJ and copy it to working instance configuration.

Author:

Radovan Semancik

Field Summary

Fields

Modifier and Type	Field and Description
protected File	configFile
static String	DEFAULT_TEMPLATE_NAME
protected org.opends.server.protocols.internal.InternalClientConnection	internalConnection
static String	RI_TEMPLATE_NAME
protected File	serverRoot
protected File	templateRoot

Fields inherited from class com.evolveum.midpoint.test.ldap.AbstractResourceController

resource

Constructor Summary

Constructors

Constructor and Description
OpenDJController()
OpenDJController(String serverRoot)

Method Summary

Methods

Modifier and Type	Method and Description
List<org.opends.server.types.Entry>	addEntriesFromLdifFile(String filename)
void	addEntry(org.opends.server.types.Entry ldapEntry)
void	addEntry(String ldif)
org.opends.server.types.Entry	addEntryFromLdifFile(File file)
org.opends.server.types.Entry	addEntryFromLdifFile(String filename)
org.opends.server.util.ChangeRecordEntry	addGroupUniqueMember(String groupDn, String memberDn)
org.opends.server.util.ChangeRecordEntry	addGroupUniqueMembers(String groupDn, List<String> memberDns)
void	assertActive(org.opends.server.types.Entry response, boolean active)
static void	assertAttribute(org.opends.server.types.Entry response, String name, String... values)
static void	assertContainsDn(String message, Collection<String> actualValues, String expectedValue)
static void	assertDn(org.opends.server.types.Entry response, String expected)
static void	assertNoAttribute(org.opends.server.types.Entry response, String name)
void	assertNoEntry(String dn)
static void	assertNoObjectClass(org.opends.server.types.Entry response, String unexpected)
void	assertNoUniqueMember(org.opends.server.types.Entry groupEntry, String accountDn)
void	assertNoUniqueMember(String groupDn, String accountDn)
static void	assertObjectClass(org.opends.server.types.Entry response, String expected)
void	assertPassword(String entryDn, String password)
void	assertUniqueMember(org.opends.server.types.Entry groupEntry, String accountDn)
void	assertUniqueMember(String groupDn, String accountDn)
Set<String>	asSet(List<org.opends.server.types.Attribute> attributes)
void	assumeRunning()
void	assumeStopped()
boolean	checkPassword(String entryDn, String password)
void	delete(String entryDn)
static void	deleteDirectory(File dir) Delete a directory and its contents.
String	dumpEntries()
String	dumpTree()
org.opends.server.util.ChangeRecordEntry	executeLdifChange(File file)
org.opends.server.util.ChangeRecordEntry	executeLdifChange(String ldif)
org.opends.server.util.ChangeRecordEntry	executeRenameChange(String filename)
org.opends.server.types.Entry	fetchAndAssertEntry(String dn, String objectClass)
org.opends.server.types.Entry	fetchEntry(String dn)
static String	getAttributeValue(org.opends.server.types.Attribute attribute)
static String	getAttributeValue(org.opends.server.types.Entry response, String name)
static byte[]	getAttributeValueBinary(org.opends.server.types.Entry response, String name)
static Collection<String>	getAttributeValues(org.opends.server.types.Entry response, String name)
File	getConfigFile() Get the value of configFile File name of primary OpenDS configuration file.
static String	getDn(org.opends.server.types.Entry response)
Collection<String>	getGroupUniqueMembers(String groupDn)
org.opends.server.protocols.internal.InternalClientConnection	getInternalConnection() Get the value of internalConnection The connection to the OpenDS instance.
File	getServerRoot() Get the value of serverRoot.
String	getSuffix()
String	getSuffixPeople()
File	getTemplateServerRoot() Get the value of templateServerRoot The top directory of template OpenDS installation.
boolean	isAccountEnabled(org.opends.server.types.Entry ldapEntry)
boolean	isRunning()
org.opends.server.util.ChangeRecordEntry	modifyReplace(String entryDn, String attributeName, String value)
void	refreshFromTemplate(String templateName) Refresh working OpenDS installation from the template.
org.opends.server.util.ChangeRecordEntry	removeGroupUniqueMember(String groupDn, String memberDn)
org.opends.server.types.Entry	searchAndAssertByEntryUuid(String entryUuid)
org.opends.server.types.Entry	searchByEntryUuid(String entryUuid)
org.opends.server.types.Entry	searchByUid(String string)
org.opends.server.types.Entry	searchSingle(String filter)
void	setConfigFile(File configFile) Set the value of configFile File name of primary OpenDS configuration file.
void	setServerRoot(File serverRoot) Set the value of serverRoot The top directory of working OpenDS installation.
org.opends.server.protocols.internal.InternalClientConnection	start() Start the embedded OpenDJ directory server.
org.opends.server.protocols.internal.InternalClientConnection	startCleanServer() Start the embedded OpenDJ directory server using files copied from the default template.
org.opends.server.protocols.internal.InternalClientConnection	startCleanServer(String templateName) Start the embedded OpenDJ directory server using files copied from the specified template.
org.opends.server.protocols.internal.InternalClientConnection	startCleanServerRI() Start the embedded OpenDJ directory server using files copied from the template with referential integrity plugin turned on.
void	stop() Stop the embedded OpenDS server.
String	toHumanReadableLdifoid(org.opends.server.types.Entry entry)

Methods inherited from class com.evolveum.midpoint.test.ldap.AbstractResourceController

getAttributePath, getAttributeQName, getNamespace, getResource, setResource

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TEMPLATE_NAME

public static final String DEFAULT_TEMPLATE_NAME

See Also:

Constant Field Values

RI_TEMPLATE_NAME

public static final String RI_TEMPLATE_NAME

See Also:

Constant Field Values

serverRoot

protected File serverRoot

configFile

protected File configFile

templateRoot

protected File templateRoot

internalConnection

protected org.opends.server.protocols.internal.InternalClientConnection internalConnection

Constructor Detail

OpenDJController

public OpenDJController()

OpenDJController

public OpenDJController(String serverRoot)

Method Detail

getServerRoot

public File getServerRoot()

Get the value of serverRoot. The top directory of working OpenDS installation. The OpenDS placed in this directory will be used during the tests.

Returns:

the value of serverRoot

setServerRoot

public void setServerRoot(File serverRoot)

Set the value of serverRoot The top directory of working OpenDS installation. The OpenDS placed in this directory will be used during the tests.

Parameters:

serverRoot - new value of serverRoot

getConfigFile

public File getConfigFile()

Get the value of configFile File name of primary OpenDS configuration file. Normally /config/config.ldif

Returns:

the value of configFile

setConfigFile

public void setConfigFile(File configFile)

Set the value of configFile File name of primary OpenDS configuration file. Normally /config/config.ldif

Parameters:

configFile - new value of configFile

getTemplateServerRoot

public File getTemplateServerRoot()

Get the value of templateServerRoot The top directory of template OpenDS installation. All the files from this directory will be copied to the working OpenDS directory (serverRoot). This usually happens before the tests.

Returns:

the value of templateServerRoot

getSuffix

public String getSuffix()

getSuffixPeople

public String getSuffixPeople()

getInternalConnection

public org.opends.server.protocols.internal.InternalClientConnection getInternalConnection()

Get the value of internalConnection The connection to the OpenDS instance. It can be used to fetch and manipulate the data.

Returns:

the value of internelConnection

refreshFromTemplate

public void refreshFromTemplate(String templateName)
                         throws IOException,
                                URISyntaxException

Refresh working OpenDS installation from the template. The existing working OpenDS installation (in serverRoot) will be discarded and replaced by a fresh known-state setup (from templateServerRoot).

Throws:

IOException

URISyntaxException

startCleanServer

public org.opends.server.protocols.internal.InternalClientConnection startCleanServer()
                                                                               throws IOException,
                                                                                      URISyntaxException

Start the embedded OpenDJ directory server using files copied from the default template.

Throws:

IOException

URISyntaxException

startCleanServerRI

public org.opends.server.protocols.internal.InternalClientConnection startCleanServerRI()
                                                                                 throws IOException,
                                                                                        URISyntaxException

Start the embedded OpenDJ directory server using files copied from the template with referential integrity plugin turned on.

Throws:

IOException

URISyntaxException

startCleanServer

public org.opends.server.protocols.internal.InternalClientConnection startCleanServer(String templateName)
                                                                               throws IOException,
                                                                                      URISyntaxException

Start the embedded OpenDJ directory server using files copied from the specified template.

Throws:

IOException

URISyntaxException

start

public org.opends.server.protocols.internal.InternalClientConnection start()

Start the embedded OpenDJ directory server. Configuration and databases from serverRoot location will be used.

Returns:

stop

public void stop()

Stop the embedded OpenDS server.

isRunning

public boolean isRunning()

assumeRunning

public void assumeRunning()

assumeStopped

public void assumeStopped()

deleteDirectory

public static void deleteDirectory(File dir)
                            throws IOException

Delete a directory and its contents.

Parameters:

dir - The name of the directory to delete.

Throws:

IOException - If the directory could not be deleted.

asSet

public Set<String> asSet(List<org.opends.server.types.Attribute> attributes)

searchByEntryUuid

public org.opends.server.types.Entry searchByEntryUuid(String entryUuid)
                                                throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

searchAndAssertByEntryUuid

public org.opends.server.types.Entry searchAndAssertByEntryUuid(String entryUuid)
                                                         throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

searchSingle

public org.opends.server.types.Entry searchSingle(String filter)
                                           throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

searchByUid

public org.opends.server.types.Entry searchByUid(String string)
                                          throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

fetchEntry

public org.opends.server.types.Entry fetchEntry(String dn)
                                         throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

fetchAndAssertEntry

public org.opends.server.types.Entry fetchAndAssertEntry(String dn,
                                                String objectClass)
                                                  throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

isAccountEnabled

public boolean isAccountEnabled(org.opends.server.types.Entry ldapEntry)

getAttributeValue

public static String getAttributeValue(org.opends.server.types.Entry response,
                       String name)

getAttributeValue

public static String getAttributeValue(org.opends.server.types.Attribute attribute)

getAttributeValueBinary

public static byte[] getAttributeValueBinary(org.opends.server.types.Entry response,
                             String name)

getAttributeValues

public static Collection<String> getAttributeValues(org.opends.server.types.Entry response,
                                    String name)

getDn

public static String getDn(org.opends.server.types.Entry response)

assertDn

public static void assertDn(org.opends.server.types.Entry response,
            String expected)
                     throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

assertNoEntry

public void assertNoEntry(String dn)
                   throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

assertObjectClass

public static void assertObjectClass(org.opends.server.types.Entry response,
                     String expected)
                              throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

assertNoObjectClass

public static void assertNoObjectClass(org.opends.server.types.Entry response,
                       String unexpected)
                                throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

assertUniqueMember

public void assertUniqueMember(org.opends.server.types.Entry groupEntry,
                      String accountDn)
                        throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

assertContainsDn

public static void assertContainsDn(String message,
                    Collection<String> actualValues,
                    String expectedValue)
                             throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

assertUniqueMember

public void assertUniqueMember(String groupDn,
                      String accountDn)
                        throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

assertNoUniqueMember

public void assertNoUniqueMember(String groupDn,
                        String accountDn)
                          throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

assertNoUniqueMember

public void assertNoUniqueMember(org.opends.server.types.Entry groupEntry,
                        String accountDn)

assertAttribute

public static void assertAttribute(org.opends.server.types.Entry response,
                   String name,
                   String... values)

assertNoAttribute

public static void assertNoAttribute(org.opends.server.types.Entry response,
                     String name)

assertActive

public void assertActive(org.opends.server.types.Entry response,
                boolean active)

addEntryFromLdifFile

public org.opends.server.types.Entry addEntryFromLdifFile(File file)
                                                   throws IOException,
                                                          org.opends.server.util.LDIFException

Throws:

IOException

org.opends.server.util.LDIFException

addEntryFromLdifFile

public org.opends.server.types.Entry addEntryFromLdifFile(String filename)
                                                   throws IOException,
                                                          org.opends.server.util.LDIFException

Throws:

IOException

org.opends.server.util.LDIFException

addEntriesFromLdifFile

public List<org.opends.server.types.Entry> addEntriesFromLdifFile(String filename)
                                                           throws IOException,
                                                                  org.opends.server.util.LDIFException

Throws:

IOException

org.opends.server.util.LDIFException

addEntry

public void addEntry(org.opends.server.types.Entry ldapEntry)

addEntry

public void addEntry(String ldif)
              throws IOException,
                     org.opends.server.util.LDIFException

Throws:

IOException

org.opends.server.util.LDIFException

executeRenameChange

public org.opends.server.util.ChangeRecordEntry executeRenameChange(String filename)
                                                             throws org.opends.server.util.LDIFException,
                                                                    IOException

Throws:

org.opends.server.util.LDIFException

IOException

executeLdifChange

public org.opends.server.util.ChangeRecordEntry executeLdifChange(File file)
                                                           throws IOException,
                                                                  org.opends.server.util.LDIFException

Throws:

IOException

org.opends.server.util.LDIFException

executeLdifChange

public org.opends.server.util.ChangeRecordEntry executeLdifChange(String ldif)
                                                           throws IOException,
                                                                  org.opends.server.util.LDIFException

Throws:

IOException

org.opends.server.util.LDIFException

modifyReplace

public org.opends.server.util.ChangeRecordEntry modifyReplace(String entryDn,
                                                     String attributeName,
                                                     String value)
                                                       throws IOException,
                                                              org.opends.server.util.LDIFException

Throws:

IOException

org.opends.server.util.LDIFException

delete

public void delete(String entryDn)

dumpEntries

public String dumpEntries()
                   throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

dumpTree

public String dumpTree()
                throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

toHumanReadableLdifoid

public String toHumanReadableLdifoid(org.opends.server.types.Entry entry)

getGroupUniqueMembers

public Collection<String> getGroupUniqueMembers(String groupDn)
                                         throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

removeGroupUniqueMember

public org.opends.server.util.ChangeRecordEntry removeGroupUniqueMember(String groupDn,
                                                               String memberDn)
                                                                 throws IOException,
                                                                        org.opends.server.util.LDIFException

Throws:

IOException

org.opends.server.util.LDIFException

addGroupUniqueMember

public org.opends.server.util.ChangeRecordEntry addGroupUniqueMember(String groupDn,
                                                            String memberDn)
                                                              throws IOException,
                                                                     org.opends.server.util.LDIFException

Throws:

IOException

org.opends.server.util.LDIFException

addGroupUniqueMembers

public org.opends.server.util.ChangeRecordEntry addGroupUniqueMembers(String groupDn,
                                                             List<String> memberDns)
                                                               throws IOException,
                                                                      org.opends.server.util.LDIFException

Throws:

IOException

org.opends.server.util.LDIFException

checkPassword

public boolean checkPassword(String entryDn,
                    String password)
                      throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException

assertPassword

public void assertPassword(String entryDn,
                  String password)
                    throws org.opends.server.types.DirectoryException

Throws:

org.opends.server.types.DirectoryException