servermanager.h

/*
    Copyright (c) 2008 Volker Krause <[email protected]>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 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 Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#ifndef AKONADI_SERVERMANAGER_H
#define AKONADI_SERVERMANAGER_H

#include "akonadicore_export.h"

#include <QObject>
#include <QMetaType>

namespace Akonadi
{

class ServerManagerPrivate;

class AKONADICORE_EXPORT ServerManager : public QObject
{
    Q_OBJECT
public:
    enum State {
        NotRunning, 
        Starting, 
        Running, 
        Stopping, 
        Broken, 
        Upgrading 
    };

    static bool start();

    static bool stop();

    static void showSelfTestDialog(QWidget *parent);

    Q_REQUIRED_RESULT static bool isRunning();

    Q_REQUIRED_RESULT static State state();

    Q_REQUIRED_RESULT static QString brokenReason();

    Q_REQUIRED_RESULT static QString instanceIdentifier();

    Q_REQUIRED_RESULT static bool hasInstanceIdentifier();

    enum ServiceType {
        Server,
        Control,
        ControlLock,
        UpgradeIndicator
    };

    static QString serviceName(ServiceType serviceType);

    enum ServiceAgentType {
        Agent,
        Resource,
        Preprocessor
    };

    Q_REQUIRED_RESULT static QString agentServiceName(ServiceAgentType agentType, const QString &identifier);

    Q_REQUIRED_RESULT static QString addNamespace(const QString &string);

    static ServerManager *self();

    enum OpenMode {
        ReadOnly,
        ReadWrite
    };
    Q_REQUIRED_RESULT static QString serverConfigFilePath(OpenMode openMode);

    Q_REQUIRED_RESULT static QString agentConfigFilePath(const QString &identifier);

    Q_REQUIRED_RESULT static uint generation();

Q_SIGNALS:
    void started();

    void stopped();

    void stateChanged(Akonadi::ServerManager::State state);

private:
    //@cond PRIVATE
    friend class ServerManagerPrivate;
    ServerManager(ServerManagerPrivate *dd);
    ServerManagerPrivate *const d;
    //@endcond
};

}

Q_DECLARE_METATYPE(Akonadi::ServerManager::State)

#endif