service_description.hpp

Go to the documentation of this file.

//  Copyright (c) 2009 STFC
// 
//  Distributed under the Boost Software License, Version 1.0. (See accompanying 
//  file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#ifndef SAGA_PACKAGES_SD_SERVICE_DESCRIPTION_HPP

#define SAGA_PACKAGES_SD_SERVICE_DESCRIPTION_HPP

#include <saga/saga/util.hpp>
#include <saga/saga/base.hpp>
#include <saga/saga/types.hpp>
#include <saga/saga/session.hpp>
#include <saga/saga/call.hpp>
#include <saga/saga/detail/attribute.hpp>
#include <saga/saga/exception.hpp>
#include <saga/saga/url.hpp>

#include <saga/saga/packages/sd/config.hpp>

#include <saga/saga/packages/sd/service_data.hpp>

namespace saga
{
   namespace impl
   {
      class info_provider;
      class discoverer_cpi_impl;
   }
}

// suppress warnings about dependent classes not being exported from the dll
#if defined(BOOST_MSVC)
#pragma warning(push)
#pragma warning(disable: 4251 4231 4275 4660)
#endif

namespace saga 
{
  namespace sd {
  namespace attributes 
  {
    //  attribute names for service_description

    char const* const service_description_url = "Url";
    char const* const service_description_type = "Type";
    char const* const service_description_uid = "Uid";
    char const* const service_description_site = "Site";
    char const* const service_description_name = "Name";
    char const* const service_description_relatedservices = "RelatedServices";
    char const* const service_description_vo = "VO";
    char const* const service_description_implementation_version =
       "ImplementationVersion";
    char const* const service_description_interface_version =
       "InterfaceVersion";
    char const* const service_description_capability = "Capabilities";
    char const* const service_description_information_provider_url =
       "InformationServiceUrl";
    char const* const service_description_implementor = "Implementor";
    
  }

  //  service description
  class SAGA_SD_PACKAGE_EXPORT service_description
      : public saga::object,
        public saga::detail::attribute<service_description>
  {
    protected:

       TR1::shared_ptr <saga::impl::service_description> get_impl_sp(void) const;
       saga::impl::service_description* get_impl (void) const;

       friend struct saga::detail::attribute<service_description>;
       friend class saga::impl::service_description;
       friend class saga::impl::discoverer_cpi_impl;
       friend class saga::impl::info_provider;

       explicit service_description(saga::impl::service_description *impl, saga::url loc);
       void set_session(TR1::shared_ptr<saga::session> sess);
       void set_data(std::string data_key, std::string data_value);

       using saga::detail::attribute<service_description>::set_attribute;
       using saga::detail::attribute<service_description>::set_vector_attribute;

    protected:
       service_description (saga::url loc); 
       explicit service_description (saga::object const& o);

    public:
       using saga::detail::attribute<service_description>::get_attribute;
       using saga::detail::attribute<service_description>::get_vector_attribute;

      ~service_description (void) SAGA_THROW_SPEC(throw());

      // default operator=() and copy ctor are ok
      service_description &operator= (saga::object const& o) 
          SAGA_THROW_SPEC(throw());

      // special getters 
      std::string get_url() SAGA_THROW_SPEC(throw());

      std::vector<saga::sd::service_description> get_related_services()
         SAGA_THROW_SPEC(throw(saga::authorization_failed,
               saga::authentication_failed,
               saga::timeout,
               saga::no_success));

      saga::sd::service_data &get_data() SAGA_THROW_SPEC(throw());
  }; // service_description
 } // namespace sd
} // namespace saga

// re-enable warnings about dependent classes not being exported from the dll
#if defined(BOOST_MSVC)
#pragma warning(pop)
#endif

#endif // !defined(SAGA_PACKAGES_SD_SERVICE_DESCRIPTION_HPP)