org.apache.directory.server.core.factory

Class DSAnnotationProcessor

java.lang.Object

org.apache.directory.server.core.factory.DSAnnotationProcessor

public final class DSAnnotationProcessor
extends java.lang.Object

A Helper class used to create a DS from the annotations

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG A logger for this class

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DSAnnotationProcessor()

Method Summary

Modifier and Type	Method and Description
static void	applyLdifs(org.junit.runner.Description desc, DirectoryService service) Apply the LDIF entries to the given service
static DirectoryService	createDS(CreateDS dsBuilder) Create the DirectoryService
static DirectoryService	getDirectoryService() Create a DirectoryService from an annotation.
static DirectoryService	getDirectoryService(org.junit.runner.Description description) Create a DirectoryService from a Unit test annotation
static void	injectEntries(DirectoryService service, java.lang.String ldif) Inject an ldif String into the server.
private static void	injectEntry(org.apache.directory.api.ldap.model.ldif.LdifEntry entry, DirectoryService service) injects an LDIF entry in the given DirectoryService
static void	injectLdifFiles(java.lang.Class<?> clazz, DirectoryService service, java.lang.String[] ldifFiles) injects the LDIF entries present in a LDIF file
static void	loadSchemas(org.junit.runner.Description desc, DirectoryService service) Load the schemas, and enable/disable them.

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

A logger for this class

Constructor Detail

DSAnnotationProcessor

private DSAnnotationProcessor()

Method Detail

createDS

public static DirectoryService createDS(CreateDS dsBuilder)
                                 throws java.lang.Exception

Create the DirectoryService

Throws:

java.lang.Exception

getDirectoryService

public static DirectoryService getDirectoryService(org.junit.runner.Description description)
                                            throws java.lang.Exception

Create a DirectoryService from a Unit test annotation

Parameters:

description - The annotations containing the info from which we will create the DS

Returns:

A valid DS

Throws:

java.lang.Exception

getDirectoryService

public static DirectoryService getDirectoryService()
                                            throws java.lang.Exception

Create a DirectoryService from an annotation. The @CreateDS annotation must be associated with either the method or the encapsulating class. We will first try to get the annotation from the method, and if there is none, then we try at the class level.

Returns:

A valid DS

Throws:

java.lang.Exception

injectEntry

private static void injectEntry(org.apache.directory.api.ldap.model.ldif.LdifEntry entry,
                                DirectoryService service)
                         throws org.apache.directory.api.ldap.model.exception.LdapException

injects an LDIF entry in the given DirectoryService

Parameters:

entry - the LdifEntry to be injected

service - the DirectoryService

Throws:

java.lang.Exception

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

injectLdifFiles

public static void injectLdifFiles(java.lang.Class<?> clazz,
                                   DirectoryService service,
                                   java.lang.String[] ldifFiles)
                            throws java.lang.Exception

injects the LDIF entries present in a LDIF file

Parameters:

service - the DirectoryService

ldifFiles - the array of LDIF file names (only )

Throws:

java.lang.Exception

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:

java.lang.Exception - if there is a problem adding the entries from the LDIF

loadSchemas

public static void loadSchemas(org.junit.runner.Description desc,
                               DirectoryService service)

Load the schemas, and enable/disable them.

applyLdifs

public static void applyLdifs(org.junit.runner.Description desc,
                              DirectoryService service)
                       throws java.lang.Exception

Apply the LDIF entries to the given service

Throws:

java.lang.Exception