1
0
mirror of https://github.com/OpenNebula/one.git synced 2025-02-01 05:47:01 +03:00
one/include/VdcPool.h
Ruben S. Montero cdd5222e86 F #2183: Use pager for list commands (e.g. onevm list). Support for
custom ordering (by ID) in list API calls, this can be set per user,
group and default in oned.conf

(cherry picked from commit 21fe3116818cfceda4cb84b02662b3f475eb8ce9)
2018-08-06 14:20:01 +02:00

138 lines
4.3 KiB
C++

/* -------------------------------------------------------------------------- */
/* Copyright 2002-2018, OpenNebula Project, OpenNebula Systems */
/* */
/* 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 VDC_POOL_H_
#define VDC_POOL_H_
#include "PoolSQL.h"
#include "Vdc.h"
using namespace std;
class VdcPool : public PoolSQL
{
public:
VdcPool(SqlDB * db,
bool is_federation_slave);
~VdcPool(){};
/* ---------------------------------------------------------------------- */
/* Methods for DB management */
/* ---------------------------------------------------------------------- */
/**
* Allocates a new Vdc, writing it in the pool database. No memory is
* allocated for the object.
* @param vdc_template a Template object
* @param oid the id assigned to the Vdc
* @param error_str Returns the error reason, if any
*
* @return the oid assigned to the object, -1 in case of failure
*/
int allocate(Template * vdc_template,
int * oid,
string& error_str);
/**
* Function to get a Vdc from the pool, if the object is not in memory
* it is loaded from the DB
* @param oid Vdc unique id
* @param lock locks the Vdc mutex
* @return a pointer to the Vdc, 0 if the Vdc could not be loaded
*/
Vdc * get(int oid)
{
return static_cast<Vdc *>(PoolSQL::get(oid));
};
/** Update a particular Vdc
* @param vdc pointer to Vdc
* @return 0 on success
*/
int update(PoolObjectSQL * objsql);
/**
* Drops the Vdc from the data base. The object mutex SHOULD be
* locked.
* @param objsql a pointer to a Vdc object
* @param error_msg Error reason, if any
* @return 0 on success,
* -1 DB error,
* -2 object is a default Vdc (ID < 100)
*/
int drop(PoolObjectSQL * objsql, string& error_msg);
/**
* Bootstraps the database table(s) associated to the Vdc pool
* @return 0 on success
*/
static int bootstrap(SqlDB * _db)
{
return Vdc::bootstrap(_db);
};
/**
* Dumps the Vdc pool in XML format. A filter can be also added to the
* query
* @param oss the output stream to dump the pool contents
* @param where filter for the objects, defaults to all
* @param limit parameters used for pagination
* @param desc descending order of pool elements
*
* @return 0 on success
*/
int dump(ostringstream& oss, const string& where, const string& limit,
bool desc)
{
return PoolSQL::dump(oss, "VDC_POOL", Vdc::table, where, limit, desc);
};
/**
* Lists the VDC ids
* @param oids a vector with the oids of the objects.
*
* @return 0 on success
*/
int list(std::vector<int>& oids)
{
return PoolSQL::list(oids, Vdc::table);
}
/**
* Default name for the default VDC
*/
static const string DEFAULT_NAME;
/**
* Identifier for the default VDC
*/
static const int DEFAULT_ID;
private:
/**
* Factory method to produce objects
* @return a pointer to the new object
*/
PoolObjectSQL * create()
{
return new Vdc(-1,0);
};
};
#endif /*VDC_POOL_H_*/