arangodb/lib/Rest/EndpointList.cpp

////////////////////////////////////////////////////////////////////////////////
/// @brief connection endpoint list
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2014 ArangoDB GmbH, Cologne, Germany
/// Copyright 2004-2014 triAGENS GmbH, Cologne, Germany
///
/// 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.
///
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
///
/// @author Jan Steemann
/// @author Copyright 2014, ArangoDB GmbH, Cologne, Germany
/// @author Copyright 2012-2013, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////

#include "EndpointList.h"

#include "Basics/StringUtils.h"
#include "Basics/logging.h"

using namespace std;
using namespace triagens::basics;
using namespace triagens::rest;

// -----------------------------------------------------------------------------
// --SECTION--                                                      EndpointList
// -----------------------------------------------------------------------------

// -----------------------------------------------------------------------------
// --SECTION--                                        constructors / destructors
// -----------------------------------------------------------------------------

////////////////////////////////////////////////////////////////////////////////
/// @brief create an endpoint list
////////////////////////////////////////////////////////////////////////////////

EndpointList::EndpointList () :
   _endpoints() {
}

////////////////////////////////////////////////////////////////////////////////
/// @brief destroy an endpoint list
////////////////////////////////////////////////////////////////////////////////

EndpointList::~EndpointList () {
  map<string, pair<Endpoint*, vector<string> > >::iterator it;

  for (it = _endpoints.begin(); it != _endpoints.end(); ++it) {
    Endpoint* ep = (*it).second.first;

    delete ep;
  }

  _endpoints.clear();
}

// -----------------------------------------------------------------------------
// --SECTION--                                                    public methods
// -----------------------------------------------------------------------------

////////////////////////////////////////////////////////////////////////////////
/// @brief add a new endpoint
////////////////////////////////////////////////////////////////////////////////

bool EndpointList::add (const std::string& specification,
                        const std::vector<std::string>& dbNames,
                        int backLogSize,
                        bool reuseAddress,
                        Endpoint** dst) {
  const string key = Endpoint::getUnifiedForm(specification);

  if (key.empty()) {
    return false;
  }

  map<string, pair<Endpoint*, vector<string> > >::iterator it = _endpoints.find(key);

  if (it != _endpoints.end()) {
    // already in list, just update
   (*it).second.second = dbNames;
   if (dst != nullptr) {
     *dst = nullptr;
   }
    return true;
  }

  Endpoint* ep = Endpoint::serverFactory(key, backLogSize, reuseAddress);

  if (ep == nullptr) {
    return false;
  }

  _endpoints[key] = pair<Endpoint*, vector<string> >(ep, dbNames);

  if (dst != nullptr) {
    *dst = ep;
  }

  return true;
}

////////////////////////////////////////////////////////////////////////////////
/// @brief remove a specific endpoint
////////////////////////////////////////////////////////////////////////////////

bool EndpointList::remove (const std::string& specification,
                           Endpoint** dst) {
  const string key = Endpoint::getUnifiedForm(specification);

  if (key.empty()) {
    return false;
  }

  if (_endpoints.size() <= 1) {
    // must not remove last endpoint
    return false;
  }

  map<string, pair<Endpoint*, vector<string> > >::const_iterator it = _endpoints.find(key);

  if (it == _endpoints.end()) {
    // not in list
    return false;
  }

  *dst = (*it).second.first;
  _endpoints.erase(key);

  return true;
}

////////////////////////////////////////////////////////////////////////////////
/// @brief return all databases for an endpoint
////////////////////////////////////////////////////////////////////////////////

std::vector<std::string> EndpointList::getMapping (const std::string& endpoint) const {
  vector<string> result;

  map<string, pair<Endpoint*, vector<string> > >::const_iterator it = _endpoints.find(endpoint);

  if (it != _endpoints.end()) {
    result = (*it).second.second;
  }

  return result;
}

////////////////////////////////////////////////////////////////////////////////
/// @brief return all endpoints
////////////////////////////////////////////////////////////////////////////////

std::map<std::string, std::vector<std::string> > EndpointList::getAll () const {
  map<string, vector<string> > result;
  map<string, pair<Endpoint*, vector<string> > >::const_iterator it;

  for (it = _endpoints.begin(); it != _endpoints.end(); ++it) {
    result[(*it).first] = (*it).second.second;
  }

  return result;
}

////////////////////////////////////////////////////////////////////////////////
/// @brief return all endpoints with a certain prefix
////////////////////////////////////////////////////////////////////////////////

std::map<std::string, Endpoint*> EndpointList::getByPrefix (const std::string& prefix) const {
  map<string, Endpoint*> result;
  map<string, pair<Endpoint*, vector<string> > >::const_iterator it;

  for (it = _endpoints.begin(); it != _endpoints.end(); ++it) {
    const string& key = (*it).first;

    if (StringUtils::isPrefix(key, prefix)) {
      result[key] = (*it).second.first;
    }
  }

  return result;
}

////////////////////////////////////////////////////////////////////////////////
/// @brief return all endpoints with a certain encryption type
////////////////////////////////////////////////////////////////////////////////

std::map<std::string, Endpoint*> EndpointList::getByPrefix (const Endpoint::EncryptionType encryption) const {
  map<string, Endpoint*> result;
  map<string, pair<Endpoint*, vector<string> > >::const_iterator it;

  for (it = _endpoints.begin(); it != _endpoints.end(); ++it) {
    const string& key = (*it).first;

    if (encryption == Endpoint::ENCRYPTION_SSL) {
      if (StringUtils::isPrefix(key, "ssl://")) {
        result[key] = (*it).second.first;
      }
    }
    else {
      if (StringUtils::isPrefix(key, "tcp://") || StringUtils::isPrefix(key, "unix://")) {
        result[key] = (*it).second.first;
      }
    }
  }

  return result;
}

////////////////////////////////////////////////////////////////////////////////
/// @brief return if there is an endpoint with a certain encryption type
////////////////////////////////////////////////////////////////////////////////

bool EndpointList::has (const Endpoint::EncryptionType encryption) const {
  map<string, pair<Endpoint*, vector<string> > >::const_iterator it;

  for (it = _endpoints.begin(); it != _endpoints.end(); ++it) {
    const string& key = (*it).first;

    if (encryption == Endpoint::ENCRYPTION_SSL) {
      if (StringUtils::isPrefix(key, "ssl://")) {
        return true;
      }
    }
    else {
      if (StringUtils::isPrefix(key, "tcp://") || StringUtils::isPrefix(key, "unix://")) {
        return true;
      }
    }
  }

  return false;
}

////////////////////////////////////////////////////////////////////////////////
/// @brief dump all endpoints used
////////////////////////////////////////////////////////////////////////////////

void EndpointList::dump () const {
  for (map<string, pair<Endpoint*, vector<string> > >::const_iterator it = _endpoints.begin(); it != _endpoints.end(); ++it) {
    Endpoint const* ep = (*it).second.first;

    LOG_INFO("using endpoint '%s' for %s requests",
             (*it).first.c_str(),
             getEncryptionName(ep->getEncryption()).c_str());
  }
}

////////////////////////////////////////////////////////////////////////////////
/// @brief return an encryption name
////////////////////////////////////////////////////////////////////////////////

std::string EndpointList::getEncryptionName (const Endpoint::EncryptionType encryption) {
  switch (encryption) {
    case Endpoint::ENCRYPTION_SSL:
      return "ssl-encrypted";
    case Endpoint::ENCRYPTION_NONE:
    default:
      return "non-encrypted";
  }
}

// -----------------------------------------------------------------------------
// --SECTION--                                                       END-OF-FILE
// -----------------------------------------------------------------------------

// Local Variables:
// mode: outline-minor
// outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @page\\|// --SECTION--\\|/// @\\}"
// End: