server/tools/StopWindowsService.java

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
 * or http://forgerock.org/license/CDDLv1.0.html.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at legal-notices/CDDLv1_0.txt.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Copyright 2008-2009 Sun Microsystems, Inc.
 *      Portions Copyright 2012-2014 ForgeRock AS
 */
package org.opends.server.tools;
import static org.opends.messages.ToolMessages.*;

import static com.forgerock.opendj.cli.Utils.*;
import static com.forgerock.opendj.util.OperatingSystem.*;

import java.io.OutputStream;
import java.io.PrintStream;

import org.opends.server.loggers.JDKLogging;
import org.opends.server.types.NullOutputStream;

/**
  * This class is used to stop the Windows service associated with this
  * instance on this machine.
  * This tool allows to stop OpenDS as a Windows service.
  */
public class StopWindowsService
{
  /** The service was successfully stopped. */
  public static final int SERVICE_STOP_SUCCESSFUL = 0;
  /** The service could not be found. */
  public static final int SERVICE_NOT_FOUND = 1;
  /** The service could not be stopped. */
  public static final int SERVICE_STOP_ERROR = 3;

  /**
   * Invokes the net stop on the service corresponding to this server.
   *
   * @param  args  The command-line arguments provided to this program.
   */
  public static void main(String[] args)
  {
    System.exit(filterExitCode(stopWindowsService(System.out, System.err)));
  }

  /**
   * Invokes the net stop on the service corresponding to this server, it writes
   * information and error messages in the provided streams.
   *
   * @return <CODE>SERVICE_STOP_SUCCESSFUL</CODE>,
   *         <CODE>SERVICE_NOT_FOUND</CODE> or <CODE>SERVICE_STOP_ERROR</CODE>
   *         depending on whether the service could be stopped or not.
   * @param outStream
   *          The stream to write standard output messages.
   * @param errStream
   *          The stream to write error messages.
   */
  public static int stopWindowsService(OutputStream outStream, OutputStream errStream)
  {
    NullOutputStream.wrapOrNullStream(outStream);
    PrintStream err = NullOutputStream.wrapOrNullStream(errStream);
    JDKLogging.disableLogging();

    String serviceName = ConfigureWindowsService.getServiceName();
    if (serviceName == null)
    {
      printWrappedText(err, ERR_WINDOWS_SERVICE_NOT_FOUND.get());
      return SERVICE_NOT_FOUND;
    }
    String[] cmd;
    if (hasUAC())
    {
      cmd= new String[] {
          ConfigureWindowsService.getLauncherBinaryFullPath(),
          ConfigureWindowsService.LAUNCHER_OPTION,
          ConfigureWindowsService.getLauncherAdministratorBinaryFullPath(),
          ConfigureWindowsService.LAUNCHER_OPTION,
          "net",
          "stop",
          serviceName
      };
    }
    else
    {
      cmd= new String[] {
          "net",
          "stop",
          serviceName
      };
    }
    /* Check if is a running service */
    try
    {
      switch (Runtime.getRuntime().exec(cmd).waitFor())
      {
      case 0:
        return SERVICE_STOP_SUCCESSFUL;
      case 2:
        return SERVICE_STOP_SUCCESSFUL;
      default:
        return SERVICE_STOP_ERROR;
      }
    }
    catch (Throwable t)
    {
      printWrappedText(err, ERR_WINDOWS_SERVICE_STOP_ERROR.get());
      printWrappedText(err, "Exception:" + t);
      return SERVICE_STOP_ERROR;
    }
  }
}