/*
|
* The contents of this file are subject to the terms of the Common Development and
|
* Distribution License (the License). You may not use this file except in compliance with the
|
* License.
|
*
|
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
|
* specific language governing permission and limitations under the License.
|
*
|
* When distributing Covered Software, include this CDDL Header Notice in each file and include
|
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
|
* Header, with the fields enclosed by brackets [] replaced by your own identifying
|
* information: "Portions Copyright [year] [name of copyright owner]".
|
*
|
* Copyright 2008 Sun Microsystems, Inc.
|
* Portions Copyright 2014 ForgeRock AS.
|
*/
|
package org.opends.server.util;
|
|
|
|
import org.forgerock.opendj.config.server.ConfigException;
|
import org.opends.server.core.DirectoryServer;
|
import org.opends.server.types.DirectoryEnvironmentConfig;
|
import org.opends.server.types.InitializationException;
|
|
import static org.opends.messages.UtilityMessages.*;
|
|
import org.forgerock.i18n.LocalizableMessage;
|
|
|
|
/**
|
* 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).
|
*/
|
@org.opends.server.types.PublicAPI(
|
stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
|
mayInstantiate=false,
|
mayExtend=false,
|
mayInvoke=true)
|
public final class EmbeddedUtils
|
{
|
/**
|
* Indicates whether the Directory Server is currently running.
|
*
|
* @return {@code true} if the server is currently running, or {@code false}
|
* if not.
|
*/
|
public static boolean isRunning()
|
{
|
return DirectoryServer.isRunning();
|
}
|
|
|
|
/**
|
* Attempts to start the Directory Server.
|
*
|
* @param config The environment configuration to use for the server.
|
*
|
* @throws InitializationException If the Directory Server is already
|
* running, or if an error occurs during
|
* server initialization or startup.
|
*/
|
public static void startServer(DirectoryEnvironmentConfig config)
|
throws InitializationException
|
{
|
if (DirectoryServer.isRunning())
|
{
|
throw new InitializationException(
|
ERR_EMBEDUTILS_SERVER_ALREADY_RUNNING.get());
|
}
|
|
DirectoryServer directoryServer = DirectoryServer.reinitialize(config);
|
try
|
{
|
directoryServer.startServer();
|
}
|
catch (ConfigException e)
|
{
|
throw new InitializationException(e.getMessageObject(), e);
|
}
|
}
|
|
|
|
/**
|
* Attempts to stop the Directory Server.
|
*
|
* @param className The name of the class that initiated the shutdown.
|
* @param reason A message explaining the reason for the shutdown.
|
*/
|
public static void stopServer(String className, LocalizableMessage reason)
|
{
|
DirectoryServer.shutDown(className, reason);
|
}
|
|
|
|
/**
|
* Attempts to restart the Directory Server. This will perform an in-core
|
* restart in which the existing server instance will be shut down, a new
|
* instance will be created, and it will be reinitialized and restarted.
|
*
|
* @param className The name of the class that initiated the restart.
|
* @param reason A message explaining the reason for the retart.
|
* @param config The environment configuration to use for the new server
|
* instance.
|
*/
|
public static void restartServer(String className, LocalizableMessage reason,
|
DirectoryEnvironmentConfig config)
|
{
|
DirectoryServer.restart(className, reason, config);
|
}
|
|
|
|
/**
|
* Sets up a number of internal server data structures to ensure that they are
|
* properly initialized for use. This is necessary if server libraries are
|
* going to be used without the server running (e.g., to facilitate use in an
|
* LDAP client API, for DN processing, etc.). This will have no effect if the
|
* server has already been initialized for client use.
|
*/
|
public static void initializeForClientUse()
|
{
|
DirectoryServer.getInstance();
|
DirectoryServer.bootstrapClient();
|
}
|
}
|
