BgwCredentialsProvider.h

Go to the documentation of this file.

/*
 * Copyright Onix Solutions Limited [OnixS]. All rights reserved.
 *
 * This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
 * and international copyright treaties.
 *
 * Access to and use of the software is governed by the terms of the applicable OnixS Software
 * Services Agreement (the Agreement) and Customer end user license agreements granting
 * a non-assignable, non-transferable and non-exclusive license to use the software
 * for it's own data processing purposes under the terms defined in the Agreement.
 *
 * Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
 * of this source code or associated reference material to any other location for further reproduction
 * or redistribution, and any amendments to this copyright notice, are expressly prohibited.
 *
 * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
 * the terms of the Agreement is a violation of copyright law.
 */
 
#pragma once
 
#include <OnixS/ICE/BOE/messaging/Messages.h>
#include <OnixS/ICE/BOE/scheduling/SessionConnectionSettings.h>
#include <OnixS/ICE/BOE/threading/Future.h>
 
ONIXS_ICEBOE_NAMESPACE_BEGIN

class BgwCredentials : public Scheduling::Counterparty
{
public:
    BgwCredentials() = default;

    BgwCredentials(std::string host, unsigned short port, std::string ipSessionToken)
        : Scheduling::Counterparty(std::move(host), port, std::move(ipSessionToken))
    {
    }

    bool valid() const noexcept
    {
        return !host().empty() && !ipSessionToken().empty() && port() != 0;
    }

    explicit operator bool() const noexcept
    {
        return valid();
    }
};

struct IBgwCredentialsProvider
{
    virtual Threading::SharedFuture<BgwCredentials> getBgwCredentialsAsync(const std::string& userId, bool forceRequest) = 0;

    virtual ~IBgwCredentialsProvider() = default;
};
 
ONIXS_ICEBOE_NAMESPACE_END