org.exist.launcher.ServiceManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of exist-core Show documentation
eXist-db NoSQL Database Core
There is a newer version: 6.3.0
/*
 * eXist-db Open Source Native XML Database
 * Copyright (C) 2001 The eXist-db Authors
 *
 * [email protected]
 * http://www.exist-db.org
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package org.exist.launcher;

import javax.annotation.Nullable;

/**
 * Interface for managing platform native Services.
 *
 * @author Adam Retter
 */
public interface ServiceManager {

    //TODO(AR) expand to support multiple services by adding a Service interface and pass that as a parameter to each function below

    /**
     * Installs the Service.
     *
     * If the service is already installed an exception is raised.
     *
     * @throws ServiceManagerException if an error occurs whilst installing the service.
     */
    void install() throws ServiceManagerException;

    /**
     * Returns true if the Service is installed.
     *
     * @return true if the service is installed, false otherwise.
     */
    boolean isInstalled();

    /**
     * Uninstalls the Service.
     *
     * If the service is already uninstalled an exception is raised.
     *
     * @throws ServiceManagerException if an error occurs whilst uninstalling the service.
     */
    void uninstall() throws ServiceManagerException;

    /**
     * Starts the Service.
     *
     * If the service is already started, this is a noop
     *
     * @throws ServiceManagerException if an error occurs whilst starting the service.
     */
    void start() throws ServiceManagerException;

    /**
     * Returns true if the Service is running
     *
     * @return true if the service is running, false otherwise.
     */
    boolean isRunning();

    /**
     * Stops the Service.
     *
     * If the service is already stopped, this is a noop
     *
     * @throws ServiceManagerException if an error occurs whilst stopping the service.
     */
    void stop() throws ServiceManagerException;

    /**
     * Show the platforms native Service Management console.
     *
     * @throws UnsupportedOperationException if the service manager
     *      does not support showing the platforms native Service
     *      ManagementConsole.
     *
     * @throws ServiceManagerException if an error occurs opening the console.
     */
    void showNativeServiceManagementConsole() throws UnsupportedOperationException, ServiceManagerException;
}