Package org.openidentityplatform.opendj.embedded

Class EmbeddedOpenDJ

java.lang.Object

org.openidentityplatform.opendj.embedded.EmbeddedOpenDJ

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable

public class EmbeddedOpenDJ
extends Object
implements Runnable, Closeable

Constructor Summary

Constructors

Constructor	Description
EmbeddedOpenDJ()
EmbeddedOpenDJ(Config config)

Method Summary

Modifier and Type	Method	Description
void	close()	Stops this instance, if it is still running, and deletes its temporary directory.
void	getData(String baseDN, OutputStream out)	Writes the entries below the given base DN to the given stream, as LDIF.
File	getServerRootDirectory()	Returns the server root directory of this embedded instance.
void	importData(InputStream inputStream)	Imports the LDIF read from the given stream.
boolean	isRunning()
void	run()

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbeddedOpenDJ

public EmbeddedOpenDJ()

EmbeddedOpenDJ

public EmbeddedOpenDJ(Config config)

Method Detail

getServerRootDirectory

public File getServerRootDirectory()

Returns the server root directory of this embedded instance.

Returns:

the server root directory

Throws:

IllegalStateException - If this instance has been closed, and the directory therefore deleted.

run

public void run()

Specified by:

run in interface Runnable

close

public void close()

Stops this instance, if it is still running, and deletes its temporary directory.

This method is idempotent: it is also registered as a JVM shutdown hook.

When the server cannot be stopped, this instance stays open and keeps its shutdown hook registered, so that a later call - or the hook at JVM exit - retries the stop.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

importData

public void importData(InputStream inputStream)
                throws EmbeddedDirectoryServerException,
                       IOException

Imports the LDIF read from the given stream.

The stream is closed by this method, whether the import succeeds or not.

Parameters:

inputStream - the LDIF to import

Throws:

IllegalStateException - If this instance has been closed.

EmbeddedDirectoryServerException

IOException

getData

public void getData(String baseDN,
                    OutputStream out)
             throws IOException,
                    EmbeddedDirectoryServerException

Writes the entries below the given base DN to the given stream, as LDIF.

The stream is flushed and closed by this method, whether the export succeeds or not.

Parameters:

baseDN - the base DN of the subtree to export

out - where the LDIF is written

Throws:

IllegalStateException - If this instance has been closed.

IOException

EmbeddedDirectoryServerException

isRunning

public boolean isRunning()