|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.util.EmbeddedUtils
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class EmbeddedUtils
This class provides a number of utility methods for using OpenDS in an embedded manner (i.e., running within the same JVM as another application and controlled by that application).
Constructor Summary | |
---|---|
EmbeddedUtils()
|
Method Summary | |
---|---|
static void |
initializeForClientUse()
Sets up a number of internal server data structures to ensure that they are properly initialized for use. |
static boolean |
isRunning()
Indicates whether the Directory Server is currently running. |
static void |
restartServer(java.lang.String className,
Message reason,
DirectoryEnvironmentConfig config)
Attempts to restart the Directory Server. |
static void |
startServer(DirectoryEnvironmentConfig config)
Attempts to start the Directory Server. |
static void |
stopServer(java.lang.String className,
Message reason)
Attempts to stop the Directory Server. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EmbeddedUtils()
Method Detail |
---|
public static boolean isRunning()
true
if the server is currently running, or false
if not.public static void startServer(DirectoryEnvironmentConfig config) throws ConfigException, InitializationException
config
- The environment configuration to use for the server.
ConfigException
- If a configuration problem is detected during
the server initialization or startup process.
InitializationException
- If the Directory Server is already
running, or if an error occurs during
server initialization or startup.public static void stopServer(java.lang.String className, Message reason)
className
- The name of the class that initiated the shutdown.reason
- A message explaining the reason for the shutdown.public static void restartServer(java.lang.String className, Message reason, DirectoryEnvironmentConfig config)
className
- The name of the class that initiated the restart.reason
- A message explaining the reason for the retart.config
- The environment configuration to use for the new server
instance.public static void initializeForClientUse()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |