blpapi_identity.h

Go to the documentation of this file.

/* Copyright 2012. Bloomberg Finance L.P.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:  The above
 * copyright notice and this permission notice shall be included in all copies
 * or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

 
#ifndef INCLUDED_BLPAPI_IDENTITY
#define INCLUDED_BLPAPI_IDENTITY

 
#include <blpapi_defs.h>
#include <blpapi_exception.h>
#include <blpapi_service.h>
#include <blpapi_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif



BLPAPI_EXPORT
void blpapi_Identity_release(blpapi_Identity_t *handle);

BLPAPI_EXPORT
int blpapi_Identity_addRef(blpapi_Identity_t *handle);

BLPAPI_EXPORT
int blpapi_Identity_hasEntitlements(const blpapi_Identity_t *handle,
        const blpapi_Service_t *service,
        const blpapi_Element_t *eidElement,
        const int *entitlementIds,
        size_t numEntitlements,
        int *failedEntitlements,
        int *failedEntitlementsCount);

BLPAPI_EXPORT
int blpapi_Identity_isAuthorized(
        const blpapi_Identity_t *handle, const blpapi_Service_t *service);

BLPAPI_EXPORT
int blpapi_Identity_getSeatType(
        const blpapi_Identity_t *handle, int *seatType);

 
#ifdef __cplusplus
}
 
#include <utility>
 
namespace BloombergLP {
namespace blpapi {
 
class Element;

class Identity {
 
    blpapi_Identity_t *d_handle_p;
 
    void addRef();
    void release();
 
  public:
    enum SeatType {
        INVALID_SEAT = BLPAPI_SEATTYPE_INVALID_SEAT,
 
        BPS = BLPAPI_SEATTYPE_BPS,
 
        NONBPS = BLPAPI_SEATTYPE_NONBPS
    };
 
  public:
    explicit Identity(blpapi_Identity_t *handle);
 
    Identity();
 
    Identity(const Identity& original);
 
    ~Identity();
 
    // MANIPULATORS
 
    Identity& operator=(const Identity&);
 
    // ACCESSORS
    bool hasEntitlements(const Service& service,
            const int *entitlementIds,
            size_t numEntitlements) const;
 
    bool hasEntitlements(const Service& service,
            const int *entitlementIds,
            size_t numEntitlements,
            int *failedEntitlements,
            int *failedEntitlementsCount) const;
 
    bool hasEntitlements(const Service& service,
            const Element& entitlementIds,
            int *failedEntitlements,
            int *failedEntitlementsCount) const;
 
    bool isValid() const;
 
    bool isAuthorized(const Service& service) const;
 
    SeatType getSeatType() const;

    blpapi_Identity_t *handle() const;
};

 
namespace util {

 
constexpr const char *to_string(Identity::SeatType seatType);

 
} // close namespace util
 
//=============================================================================
//                           INLINE FUNCTION DEFINITIONS
//=============================================================================
 
// --------------
// class Identity
// --------------
 
inline Identity::Identity()
    : d_handle_p(0)
{
}
 
inline Identity::Identity(blpapi_Identity_t *newHandle)
    : d_handle_p(newHandle)
{
}
 
inline Identity::Identity(const Identity& original)
    : d_handle_p(original.d_handle_p)
{
    addRef();
}
 
inline Identity::~Identity() { release(); }
 
inline Identity& Identity::operator=(const Identity& rhs)
{
    using std::swap;
 
    Identity tmp(rhs);
    swap(tmp.d_handle_p, d_handle_p);
 
    return *this;
}
 
inline void Identity::addRef()
{
    if (d_handle_p) {
        blpapi_Identity_addRef(d_handle_p);
    }
}
 
inline void Identity::release()
{
    if (d_handle_p) {
        blpapi_Identity_release(d_handle_p);
    }
}
 
inline bool Identity::hasEntitlements(const Service& service,
        const int *entitlementIds,
        size_t numEntitlements) const
{
    return blpapi_Identity_hasEntitlements(d_handle_p,
                   service.handle(),
                   0,
                   entitlementIds,
                   numEntitlements,
                   0,
                   0)
            ? true
            : false;
}
 
inline bool Identity::hasEntitlements(const Service& service,
        const int *entitlementIds,
        size_t numEntitlements,
        int *failedEntitlements,
        int *failedEntitlementsCount) const
{
    return blpapi_Identity_hasEntitlements(d_handle_p,
                   service.handle(),
                   0,
                   entitlementIds,
                   numEntitlements,
                   failedEntitlements,
                   failedEntitlementsCount)
            ? true
            : false;
}
 
inline bool Identity::hasEntitlements(const Service& service,
        const Element& entitlementIds,
        int *failedEntitlements,
        int *failedEntitlementsCount) const
{
    return blpapi_Identity_hasEntitlements(d_handle_p,
                   service.handle(),
                   entitlementIds.handle(),
                   0,
                   0,
                   failedEntitlements,
                   failedEntitlementsCount)
            ? true
            : false;
}
 
inline bool Identity::isValid() const { return (d_handle_p != 0); }
 
inline bool Identity::isAuthorized(const Service& service) const
{
    return blpapi_Identity_isAuthorized(d_handle_p, service.handle()) ? true
                                                                      : false;
}
 
inline Identity::SeatType Identity::getSeatType() const
{
    int seatType = BLPAPI_SEATTYPE_INVALID_SEAT;
    ExceptionUtil::throwOnError(
            blpapi_Identity_getSeatType(d_handle_p, &seatType));
    return static_cast<SeatType>(seatType);
}

inline blpapi_Identity_t *Identity::handle() const { return d_handle_p; }
 
// --------------
// namespace util
// --------------
constexpr const char *util::to_string(Identity::SeatType seatType)
{
    switch (seatType) {
    case Identity::INVALID_SEAT:
        return "INVALID_SEAT";
    case Identity::BPS:
        return "BPS";
    case Identity::NONBPS:
        return "NONBPS";
    }
    // Silence warnings on some compilers
    return "UNDEFINED";
}
 
} // close namespace blpapi
} // close namespace BloombergLP
 
#endif // #ifdef __cplusplus
#endif // #ifndef INCLUDED_BLPAPI_IDENTITY