IKaaClient.hpp

Go to the documentation of this file.

/*
 * Copyright 2014-2016 CyberVision, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef IKAACLIENT_HPP_
#define IKAACLIENT_HPP_

#include <future>

#include "kaa/profile/IProfileContainer.hpp"
#include "kaa/notification/INotificationTopicListListener.hpp"
#include "kaa/notification/gen/NotificationDefinitions.hpp"
#include "kaa/notification/INotificationListener.hpp"
#include "kaa/configuration/storage/IConfigurationStorage.hpp"
#include "kaa/configuration/gen/ConfigurationDefinitions.hpp"
#include "kaa/event/registration/IAttachEndpointCallback.hpp"
#include "kaa/event/registration/IDetachEndpointCallback.hpp"
#include "kaa/event/registration/IUserAttachCallback.hpp"
#include "kaa/event/registration/IAttachStatusListener.hpp"
#include "kaa/event/IFetchEventListeners.hpp"
#include "kaa/log/ILogCollector.hpp"
#include "kaa/failover/IFailoverStrategy.hpp"
#include "kaa/log/ILogDeliveryListener.hpp"
#include "kaa/log/RecordFuture.hpp"
#include "kaa/IKaaClientContext.hpp"


namespace kaa {

class EventFamilyFactory;
class IKaaChannelManager;
class IKaaDataMultiplexer;
class IKaaDataDemultiplexer;
class IConfigurationReceiver;
class KeyPair;

class IKaaClient {
public:
    virtual void start() = 0;

    virtual void stop() = 0;

    virtual void pause() = 0;

    virtual void resume() = 0;

    virtual void setProfileContainer(IProfileContainerPtr container) = 0;

    virtual void updateProfile() = 0;

    virtual EventFamilyFactory& getEventFamilyFactory() = 0;

    virtual void addTopicListListener(INotificationTopicListListener& listener) = 0;

    virtual void removeTopicListListener(INotificationTopicListListener& listener) = 0;

    virtual Topics getTopics() = 0;

    virtual void addNotificationListener(INotificationListener& listener) = 0;

    virtual void addNotificationListener(std::int64_t topicId, INotificationListener& listener) = 0;

    virtual void removeNotificationListener(INotificationListener& listener) = 0;

    virtual void removeNotificationListener(std::int64_t topicId, INotificationListener& listener) = 0;

    virtual void subscribeToTopic(std::int64_t id, bool forceSync = true) = 0;

    virtual void subscribeToTopics(const std::list<std::int64_t>& idList, bool forceSync = true) = 0;

    virtual void unsubscribeFromTopic(std::int64_t id, bool forceSync = true) = 0;

    virtual void unsubscribeFromTopics(const std::list<std::int64_t>& idList, bool forceSync = true) = 0;

    virtual void syncTopicSubscriptions() = 0;

    virtual void addConfigurationListener(IConfigurationReceiver &receiver) = 0;

    virtual void removeConfigurationListener(IConfigurationReceiver &receiver) = 0;
    virtual const KaaRootConfiguration& getConfiguration() = 0;

    virtual void setConfigurationStorage(IConfigurationStoragePtr storage) = 0;

    virtual void attachEndpoint(const std::string&  endpointAccessToken
                               , IAttachEndpointCallbackPtr listener = IAttachEndpointCallbackPtr()) = 0;

    virtual void detachEndpoint(const std::string&  endpointKeyHash
                               , IDetachEndpointCallbackPtr listener = IDetachEndpointCallbackPtr()) = 0;

    virtual void attachUser(const std::string& userExternalId, const std::string& userAccessToken
                           , IUserAttachCallbackPtr listener = IUserAttachCallbackPtr()) = 0;

    virtual void attachUser(const std::string& userExternalId, const std::string& userAccessToken
                           , const std::string& userVerifierToken, IUserAttachCallbackPtr listener = IUserAttachCallbackPtr()) = 0;

    virtual void setAttachStatusListener(IAttachStatusListenerPtr listener) = 0;

    virtual bool isAttachedToUser() = 0;

    virtual std::int32_t findEventListeners(const std::list<std::string>& eventFQNs, IFetchEventListenersPtr listener) = 0;

    virtual RecordFuture addLogRecord(const KaaUserLogRecord& record) = 0;

    virtual void setLogDeliveryListener(ILogDeliveryListenerPtr listener) = 0;

    virtual void setLogStorage(ILogStoragePtr storage) = 0;

    virtual void setLogUploadStrategy(ILogUploadStrategyPtr strategy) = 0;


    virtual void setFailoverStrategy(IFailoverStrategyPtr strategy) = 0;

    virtual IKaaChannelManager&                 getChannelManager() = 0;

    virtual const KeyPair&                    getClientKeyPair() = 0;

    virtual void                              setEndpointAccessToken(const std::string& token) = 0;

    virtual std::string                       refreshEndpointAccessToken() = 0;

    virtual std::string                       getEndpointAccessToken() const = 0;

    virtual std::string                       getEndpointKeyHash() const = 0;

    virtual IKaaDataMultiplexer&              getOperationMultiplexer() = 0;

    virtual IKaaDataDemultiplexer&            getOperationDemultiplexer() = 0;

    virtual IKaaDataMultiplexer&              getBootstrapMultiplexer() = 0;

    virtual IKaaDataDemultiplexer&            getBootstrapDemultiplexer() = 0;

    virtual IKaaClientContext&                getKaaClientContext() = 0;

    virtual ~IKaaClient() { }
};

}


#endif /* IKAACLIENT_HPP_ */