The CommonStorage class provides an interface to MongoDB. More...

#include <MemoryX/components/CommonStorage/CommonStorage.h>

Inheritance diagram for CommonStorage:

Public Member Functions
bool	authDB (const ::std::string &dbName, const ::std::string &userName, const ::std::string &password, const ::Ice::Current &=Ice::emptyCurrent) override

bool	clearCollection (const std::string &ns)

Ice::Int	count (const std::string &ns)

armarx::PropertyDefinitionsPtr	createPropertyDefinitions () override

void	dropCollection (const std::string &collectionNS, const ::Ice::Current &c=Ice::emptyCurrent) override

bool	ensureIndex (const std::string &ns, const std::string &fieldName, bool unique)

DBStorableDataList	findAll (const std::string &ns)

NameList	findAllFieldValues (const std::string &ns, const std::string &fieldName)

EntityIdList	findAllIds (const std::string &ns)

DBStorableData	findAllUniqueByFieldName (const std::string &ns, const ::std::string &fieldName)

DBStorableDataList	findByFieldValue (const std::string &ns, const std::string &fieldName, const ::std::string &fieldValue)

DBStorableDataList	findByFieldValueList (const std::string &ns, const std::string &fieldName, const NameList &fieldValueList)

DBStorableData	findByMongoId (const std::string &ns, const std::string &id)

DBStorableDataList	findByQuery (const std::string &ns, const std::string &query, const std::string &where="")

DBStorableData	findOneByFieldValue (const std::string &ns, const std::string &fieldName, const ::std::string &fieldValue)

DBStorableData	findOneByQuery (const std::string &ns, const std::string &query)

bool	getBinaryFileById (const ::std::string &dbName, const ::std::string &fileId, memoryx::Blob &buffer, const ::Ice::Current &c=Ice::emptyCurrent) override

bool	getBinaryFileByName (const ::std::string &dbName, const ::std::string &gridFSName, memoryx::Blob &buffer, const ::Ice::Current &c=Ice::emptyCurrent) override

NameList	getCollectionNames (const ::std::string &dbName, const ::Ice::Current &=Ice::emptyCurrent) override

NameList	getDBNames (const ::Ice::Current &=Ice::emptyCurrent) override

std::string	getDefaultName () const override
	Retrieve default name of component. More...

NameList	getFileIdList (const std::string &dbName, const Ice::Current &c=Ice::emptyCurrent) override

NameList	getFileNameList (const std::string &dbName, const Ice::Current &c=Ice::emptyCurrent) override

GridFileInterfacePrx	getFileProxyById (const ::std::string &dbName, const ::std::string &fileId, const ::Ice::Current &c=Ice::emptyCurrent) override

GridFileInterfacePrx	getFileProxyByName (const ::std::string &dbName, const ::std::string &gridFSName, const ::Ice::Current &c=Ice::emptyCurrent) override

std::string	getMongoHostAndPort (const ::Ice::Current &c=Ice::emptyCurrent) override

bool	getTextFileById (const ::std::string &dbName, const ::std::string &fileId, ::std::string &buffer, const ::Ice::Current &c=Ice::emptyCurrent) override

bool	getTextFileByName (const ::std::string &dbName, const ::std::string &gridFSName, ::std::string &buffer, const ::Ice::Current &c=Ice::emptyCurrent) override

std::string	insert (const std::string &ns, const DBStorableData &obj, bool upsert=false)

std::vector< std::string >	insertList (const std::string &ns, const DBStorableDataList &objectList)

bool	isConnected (const ::Ice::Current &c=Ice::emptyCurrent) override

void	onConnectComponent () override
	Pure virtual hook for the subclass. More...

void	onExitComponent () override
	Hook for subclass. More...

void	onInitComponent () override
	Pure virtual hook for the subclass. More...

bool	reconnect (const ::std::string &hostAndPort, const ::std::string &userName, const ::std::string &password, const ::Ice::Current &=Ice::emptyCurrent) override

void	releaseCollection (const CollectionInterfacePrx &coll, const ::Ice::Current &c=Ice::emptyCurrent) override

void	releaseDatabase (const DatabaseInterfacePrx &db, const ::Ice::Current &=Ice::emptyCurrent) override

void	releaseFileProxy (const GridFileInterfacePrx &fileProxy, const ::Ice::Current &c=Ice::emptyCurrent) override

bool	removeByFieldValue (const std::string &ns, const std::string &fieldName, const std::string &fieldValue)

bool	removeByMongoId (const std::string &ns, const std::string &id)

bool	removeByQuery (const std::string &ns, const std::string &query)

bool	removeFileById (const ::std::string &dbName, const ::std::string &fileId, const ::Ice::Current &c=Ice::emptyCurrent) override

bool	removeFileByName (const ::std::string &dbName, const ::std::string &gridFSName, const ::Ice::Current &c=Ice::emptyCurrent) override

void	removeFileByQuery (const std::string &dbName, const mongo::BSONObj &fileQuery)

CollectionInterfacePrx	requestCollection (const std::string &collectionNS, const ::Ice::Current &c=Ice::emptyCurrent) override

DatabaseInterfacePrx	requestDatabase (const ::std::string &dbName, const ::Ice::Current &=Ice::emptyCurrent) override

std::string	storeBinaryFile (const ::std::string &dbName, const memoryx::Blob &bufferToStore, const ::std::string &gridFSName="", const ::Ice::Current &c=Ice::emptyCurrent) override

std::string	storeFile (const ::std::string &dbName, const ::std::string &fileName, const ::std::string &gridFSName="", const ::Ice::Current &c=Ice::emptyCurrent) override

std::string	storeTextFile (const ::std::string &dbName, const ::std::string &bufferToStore, const ::std::string &gridFSName="", const ::Ice::Current &c=Ice::emptyCurrent) override

bool	update (const std::string &ns, const DBStorableData &obj, const std::string &keyField, bool upsert=false)

bool	updateByQuery (const std::string &ns, const std::string &query, const mongo::BSONObj &obj)

Public Member Functions inherited from Component
virtual void	componentPropertiesUpdated (const std::set< std::string > &changedProperties)
	Implement this function if you would like to react to changes in the properties. More...

void	forceComponentCreatedByComponentCreateFunc ()
	forces the flag to be set to true that the object instance was created by the Component::create function More...

std::vector< PropertyUserPtr >	getAdditionalPropertyUsers () const

template<typename PropertyType >
Property< PropertyType >	getProperty (const std::string &name)

template<typename PropertyType >
Property< PropertyType >	getProperty (const std::string &name) const

template<class T >
void	getProperty (std::atomic< T > &val, const std::string &name) const

template<class T >
void	getProperty (T &val, const std::string &name) const

template<class ProxyType >
ProxyType	getProxyFromProperty (const std::string &propertyName, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
	Get a proxy whose name is specified by the given property. More...

template<class ProxyType >
void	getProxyFromProperty (ProxyType &proxy, const std::string &propertyName, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)

template<class TopicProxyType >
TopicProxyType	getTopicFromProperty (const std::string &propertyName)
	Get a topic proxy whose name is specified by the given property. More...

template<class TopicProxyType >
void	getTopicFromProperty (TopicProxyType &top, const std::string &propertyName)

void	initializeProperties (const std::string &configName, Ice::PropertiesPtr const &properties, const std::string &configDomain)
	initializes the properties of this component. More...

void	injectPropertyDefinitions (PropertyDefinitionsPtr &props) override

void	offeringTopicFromProperty (const std::string &propertyName)
	Offer a topic whose name is specified by the given property. More...

virtual void	preOnConnectComponent () override

virtual void	preOnInitComponent () override

bool	usingProxyFromProperty (const std::string &propertyName, const std::string &endpoints="")
	Use a proxy whose name is specified by the given property. More...

void	usingTopicFromProperty (const std::string &propertyName, bool orderedPublishing=false)
	Use a topic whose name is specified by the given property. More...

Public Member Functions inherited from ManagedIceObject
void	enableProfiler (bool enable)
	setProfiler allows setting ManagedIceObject::profiler to a new instance (if the new instance is actually not a null pointer) More...

std::string	generateSubObjectName (const std::string &subObjectName)
	Generates a unique name for a sub object from a general name. More...

ArmarXManagerPtr	getArmarXManager () const
	Returns the ArmarX manager used to add and remove components. More...

ManagedIceObjectConnectivity	getConnectivity () const
	Retrieve connectivity of the object (topcis as well as proxies) More...

IceManagerPtr	getIceManager () const
	Returns the IceManager. More...

VariantBasePtr	getMetaInfo (const std::string &id)

StringVariantBaseMap	getMetaInfoMap () const

std::string	getName () const
	Retrieve name of object. More...

Ice::ObjectAdapterPtr	getObjectAdapter () const
	Returns object's Ice adapter. More...

ArmarXObjectSchedulerPtr	getObjectScheduler () const

PeriodicTaskPtr	getPeriodicTask (const std::string &name)

Profiler::ProfilerPtr	getProfiler () const
	getProfiler returns an instance of armarx::Profiler More...

template<class ProxyTarg , class... Args>
void	getProxy (const char *name, IceInternal::ProxyHandle< ProxyTarg > &proxy, Args &&...args)

template<class ProxyType >
ProxyType	getProxy (const std::string &name, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
	Retrieves a proxy object. More...

template<class ProxyTarg , class... Args>
void	getProxy (const std::string &name, IceInternal::ProxyHandle< ProxyTarg > &proxy, Args &&...args)

template<class ProxyTarg , class... Args>
void	getProxy (IceInternal::ProxyHandle< ProxyTarg > &proxy, const char *name, Args &&...args)

template<class ProxyTarg , class... Args>
void	getProxy (IceInternal::ProxyHandle< ProxyTarg > &proxy, const std::string &name, Args &&...args)
	Assigns a proxy to `proxy`. More...

Ice::ObjectPrx	getProxy (long timeoutMs=0, bool waitForScheduler=true) const
	Returns the proxy of this object (optionally it waits for the proxy) More...

template<class Prx >
Prx	getProxy (long timeoutMs=0, bool waitForScheduler=true) const

template<class ProxyType >
void	getProxy (ProxyType &proxy, const char *name, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
	Overload to allow using string literals as name (solve ambiguous overload). More...

template<class Prx >
void	getProxy (Prx &prx, long timeoutMs=0, bool waitForScheduler=true) const

int	getState () const
	Retrieve current state of the ManagedIceObject. More...

template<class TopicProxyType >
TopicProxyType	getTopic (const std::string &name)
	Returns a proxy of the specified topic. More...

template<class TopicProxyType >
void	getTopic (TopicProxyType &topicProxy, const std::string &name)
	Assigns a proxy of the specified topic to `topicProxy`. More...

std::vector< std::string >	getUnresolvedDependencies () const
	returns the names of all unresolved dependencies More...

	ManagedIceObject (ManagedIceObject const &other)

void	offeringTopic (const std::string &name)
	Registers a topic for retrival after initialization. More...

void	preambleGetTopic (std::string const &name)

void	setMetaInfo (const std::string &id, const VariantBasePtr &value)
	Allows to set meta information that can be queried live via Ice interface on the ArmarXManager. More...

void	startPeriodicTask (const std::string &uniqueName, std::function< void(void)> f, int periodMs, bool assureMeanInterval=false, bool forceSystemTime=true)

bool	stopPeriodicTask (const std::string &name)

bool	unsubscribeFromTopic (const std::string &name)
	Unsubscribe from a topic. More...

bool	usingProxy (const std::string &name, const std::string &endpoints="")
	Registers a proxy for retrieval after initialization and adds it to the dependency list. More...

void	usingTopic (const std::string &name, bool orderedPublishing=false)
	Registers a proxy for subscription after initialization. More...

void	waitForObjectScheduler ()
	Waits until the ObjectScheduler could resolve all dependencies. More...

void	waitForProxy (std::string const &name, bool addToDependencies)

Public Member Functions inherited from Logging
SpamFilterDataPtr	deactivateSpam (float deactivationDurationSec=10.0f, const std::string &identifier="", bool deactivate=true) const
	disables the logging for the current line for the given amount of seconds. More...

MessageTypeT	getEffectiveLoggingLevel () const

	Logging ()

void	setLocalMinimumLoggingLevel (MessageTypeT level)
	With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set. More...

void	setTag (const LogTag &tag)

void	setTag (const std::string &tagName)

virtual	~Logging ()

Public Member Functions inherited from PropertyUser
std::vector< std::string >	getComponentProxyNames ()

Ice::PropertiesPtr	getIceProperties () const
	Returns the set of Ice properties. More...

template<typename PropertyType >
Property< PropertyType >	getProperty (const std::string &name)
	Property creation and retrieval. More...

template<typename PropertyType >
Property< PropertyType >	getProperty (const std::string &name) const
	Hack to allow using getProperty in `const`-modified methods. More...

template<class T >
void	getProperty (std::atomic< T > &val, const std::string &name) const

template<class T >
void	getProperty (T &val, const std::string &name) const

template<class T >
std::vector< T >	getPropertyAsCSV (const std::string &name, const std::string &splitBy=",;", bool trimElements=true, bool removeEmptyElements=true)

template<class ContainerT >
void	getPropertyAsCSV (ContainerT &val, const std::string &name, const std::string &splitBy=",;", bool trimElements=true, bool removeEmptyElements=true)

PropertyDefinitionsPtr	getPropertyDefinitions ()
	Returns the component's property definition container. More...

std::vector< std::string >	getSubscribedTopicNames ()

std::vector< std::string >	getTopicProxyNames ()

bool	hasProperty (const std::string &name)

	PropertyUser ()

virtual void	setIceProperties (Ice::PropertiesPtr properties)
	Sets the Ice properties. More...

bool	tryAddProperty (const std::string &propertyName, const std::string &value)

virtual void	updateIceProperties (const std::map< std::string, std::string > &changes)

void	updateProperties ()

void	updateProxies (IceManagerPtr)

	~PropertyUser () override

Additional Inherited Members
Public Types inherited from ManagedIceObject
using	PeriodicTaskPtr = IceUtil::Handle< SimplePeriodicTask< std::function< void(void)> >>

Static Public Member Functions inherited from Component
template<class T , class TPtr = IceInternal::Handle<T>>
static TPtr	create (Ice::PropertiesPtr properties=Ice::createProperties(), const std::string &configName="", const std::string &configDomain="ArmarX")
	Factory method for a component. More...

Static Public Member Functions inherited from ManagedIceObject
static std::string	generateSubObjectName (const std::string &superObjectName, const std::string &subObjectName)
	Generates a unique name for a sub object from a general name and unique name. More...

static std::string	GetObjectStateAsString (int state)

Static Public Attributes inherited from ManagedIceObject
static const ManagedIceObjectPtr	NullPtr
	A nullptr to be used when a const ref to a nullptr is required. More...

Protected Member Functions inherited from Component
void	addPropertyUser (const PropertyUserPtr &subPropertyUser)
	Add additional property users here that should show up in the application help text. More...

	Component ()
	Protected default constructor. Used for virtual inheritance. Use createManagedIceObject() instead. More...

std::string	getConfigDomain ()
	Retrieve config domain for this component as set in constructor. More...

std::string	getConfigIdentifier ()
	Retrieve config identifier for this component as set in constructor. More...

std::string	getConfigName ()
	Retrieve config name for this component as set in constructor. More...

virtual void	icePropertiesInitialized ()

Protected Member Functions inherited from ManagedIceObject
template<class PluginT , class... ParamsT>
PluginT *	addPlugin (const std::string prefix="", ParamsT &&...params)

template<class PluginT , class... ParamsT>
void	addPlugin (PluginT *&targ, const std::string prefix="", ParamsT &&...params)

template<class PluginT , class... ParamsT>
void	addPlugin (std::experimental::observer_ptr< PluginT > &targ, const std::string prefix="", ParamsT &&...params)

Ice::CommunicatorPtr	getCommunicator () const

std::unique_ptr< ManagedIceObjectPlugin > &	getPluginPointer (std::type_info const &type, std::string const &prefix)

	ManagedIceObject ()
	Protected default constructor. More...

virtual void	onDisconnectComponent ()
	Hook for subclass. More...

virtual void	postOnConnectComponent ()

virtual void	postOnDisconnectComponent ()

virtual void	postOnExitComponent ()

virtual void	postOnInitComponent ()

virtual void	preOnDisconnectComponent ()

virtual void	preOnExitComponent ()

bool	removeProxyDependency (const std::string &name)
	This function removes the dependency of this object on the in parameter name specified object. More...

void	setName (std::string name)
	Override name of well-known object. More...

void	terminate ()
	Initiates termination of this IceManagedObject. More...

	~ManagedIceObject () override

Protected Member Functions inherited from Logging
bool	checkLogLevel (MessageTypeT level) const

const LogSenderPtr &	getLogSender () const
	Retrieve log sender. More...

LogSenderPtr	loghelper (const char file, int line, const char function) const

Protected Attributes inherited from Logging
MessageTypeT	minimumLoggingLevel

SpamFilterDataPtr	spamFilter

LogTag	tag

Detailed Description

The CommonStorage class provides an interface to MongoDB.

See memoryx::CommonStorage - versatile storage backed up by MongoDB

Definition at line 74 of file CommonStorage.h.

Member Function Documentation

◆ authDB()

bool authDB	(	const ::std::string &	dbName,
		const ::std::string &	userName,
		const ::std::string &	password,
		const ::Ice::Current &	= `Ice::emptyCurrent`
	)

override

Definition at line 277 of file CommonStorage.cpp.

◆ clearCollection()

bool clearCollection ( const std::string & ns )

Definition at line 1083 of file CommonStorage.cpp.

◆ count()

Ice::Int count ( const std::string & ns )

Definition at line 768 of file CommonStorage.cpp.

◆ createPropertyDefinitions()

armarx::PropertyDefinitionsPtr createPropertyDefinitions ( )

overridevirtual

See also: PropertyUser::createPropertyDefinitions()

Reimplemented from Component.

Definition at line 138 of file CommonStorage.cpp.

Here is the call graph for this function:

◆ dropCollection()

void dropCollection	(	const std::string &	collectionNS,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 375 of file CommonStorage.cpp.

◆ ensureIndex()

bool ensureIndex	(	const std::string &	ns,
		const std::string &	fieldName,
		bool	unique
	)

Definition at line 1105 of file CommonStorage.cpp.

◆ findAll()

DBStorableDataList findAll ( const std::string & ns )

Definition at line 849 of file CommonStorage.cpp.

◆ findAllFieldValues()

NameList findAllFieldValues	(	const std::string &	ns,
		const std::string &	fieldName
	)

Definition at line 875 of file CommonStorage.cpp.

◆ findAllIds()

EntityIdList findAllIds ( const std::string & ns )

Definition at line 869 of file CommonStorage.cpp.

◆ findAllUniqueByFieldName()

DBStorableData findAllUniqueByFieldName	(	const std::string &	ns,
		const ::std::string &	fieldName
	)

Definition at line 855 of file CommonStorage.cpp.

◆ findByFieldValue()

DBStorableDataList findByFieldValue	(	const std::string &	ns,
		const std::string &	fieldName,
		const ::std::string &	fieldValue
	)

Definition at line 805 of file CommonStorage.cpp.

◆ findByFieldValueList()

DBStorableDataList findByFieldValueList	(	const std::string &	ns,
		const std::string &	fieldName,
		const NameList &	fieldValueList
	)

Definition at line 811 of file CommonStorage.cpp.

◆ findByMongoId()

DBStorableData findByMongoId	(	const std::string &	ns,
		const std::string &	id
	)

Definition at line 784 of file CommonStorage.cpp.

◆ findByQuery()

DBStorableDataList findByQuery	(	const std::string &	ns,
		const std::string &	query,
		const std::string &	where = `""`
	)

Definition at line 831 of file CommonStorage.cpp.

◆ findOneByFieldValue()

DBStorableData findOneByFieldValue	(	const std::string &	ns,
		const std::string &	fieldName,
		const ::std::string &	fieldValue
	)

Definition at line 824 of file CommonStorage.cpp.

◆ findOneByQuery()

DBStorableData findOneByQuery	(	const std::string &	ns,
		const std::string &	query
	)

Definition at line 843 of file CommonStorage.cpp.

◆ getBinaryFileById()

bool getBinaryFileById	(	const ::std::string &	dbName,
		const ::std::string &	fileId,
		memoryx::Blob &	buffer,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 648 of file CommonStorage.cpp.

◆ getBinaryFileByName()

bool getBinaryFileByName	(	const ::std::string &	dbName,
		const ::std::string &	gridFSName,
		memoryx::Blob &	buffer,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 666 of file CommonStorage.cpp.

◆ getCollectionNames()

NameList getCollectionNames	(	const ::std::string &	dbName,
		const ::Ice::Current &	= `Ice::emptyCurrent`
	)

override

Definition at line 300 of file CommonStorage.cpp.

◆ getDBNames()

NameList getDBNames ( const ::Ice::Current & = Ice::emptyCurrent )

override

Definition at line 290 of file CommonStorage.cpp.

◆ getDefaultName()

std::string getDefaultName ( ) const

overridevirtual

Retrieve default name of component.

Implement this method in each IceManagedObject. The default name of a is used if no name is specified in the factory method.

Returns: default name of the component (e.g. "KinematicUnit")

Implements ManagedIceObject.

Definition at line 49 of file CommonStorage.cpp.

◆ getFileIdList()

NameList getFileIdList	(	const std::string &	dbName,
		const Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 718 of file CommonStorage.cpp.

Here is the call graph for this function:

◆ getFileNameList()

NameList getFileNameList	(	const std::string &	dbName,
		const Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 701 of file CommonStorage.cpp.

Here is the call graph for this function:

◆ getFileProxyById()

GridFileInterfacePrx getFileProxyById	(	const ::std::string &	dbName,
		const ::std::string &	fileId,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 577 of file CommonStorage.cpp.

◆ getFileProxyByName()

GridFileInterfacePrx getFileProxyByName	(	const ::std::string &	dbName,
		const ::std::string &	gridFSName,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 585 of file CommonStorage.cpp.

◆ getMongoHostAndPort()

std::string getMongoHostAndPort ( const ::Ice::Current & c = Ice::emptyCurrent )

override

Definition at line 285 of file CommonStorage.cpp.

◆ getTextFileById()

bool getTextFileById	(	const ::std::string &	dbName,
		const ::std::string &	fileId,
		::std::string &	buffer,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 640 of file CommonStorage.cpp.

◆ getTextFileByName()

bool getTextFileByName	(	const ::std::string &	dbName,
		const ::std::string &	gridFSName,
		::std::string &	buffer,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 657 of file CommonStorage.cpp.

◆ insert()

std::string insert	(	const std::string &	ns,
		const DBStorableData &	obj,
		bool	upsert = `false`
	)

Definition at line 927 of file CommonStorage.cpp.

◆ insertList()

std::vector< std::string > insertList	(	const std::string &	ns,
		const DBStorableDataList &	objectList
	)

Definition at line 971 of file CommonStorage.cpp.

◆ isConnected()

bool isConnected ( const ::Ice::Current & c = Ice::emptyCurrent )

override

Definition at line 306 of file CommonStorage.cpp.

◆ onConnectComponent()

void onConnectComponent ( )

overridevirtual

Pure virtual hook for the subclass.

Is called once all dependencies of the object have been resolved and Ice connection is established. This hook is called whenever the dependencies are found. That means if the a depedency crashes or shuts down, the ManagedIceObject goes into disconnected state. When the dependencies are found again, this hook is called again.

See also: onDisconnectComponent()

Implements ManagedIceObject.

Definition at line 101 of file CommonStorage.cpp.

Here is the call graph for this function:

◆ onExitComponent()

void onExitComponent ( )

overridevirtual

Hook for subclass.

Is called once the component terminates. Use for cleanup. Only called once.

Reimplemented from ManagedIceObject.

Definition at line 115 of file CommonStorage.cpp.

◆ onInitComponent()

void onInitComponent ( )

overridevirtual

Pure virtual hook for the subclass.

Is called once initialization of the ManagedIceObject is done. This hook is called in the implenting class once and never again during the lifecyle of the object. This function is called as soon as the ManagedIceObject was added to the ArmarXManager. Called in an own thread and not the thread it was created in.

Implements ManagedIceObject.

Definition at line 54 of file CommonStorage.cpp.

Here is the call graph for this function:

◆ reconnect()

bool reconnect	(	const ::std::string &	hostAndPort,
		const ::std::string &	userName,
		const ::std::string &	password,
		const ::Ice::Current &	= `Ice::emptyCurrent`
	)

override

Definition at line 311 of file CommonStorage.cpp.

◆ releaseCollection()

void releaseCollection	(	const CollectionInterfacePrx &	coll,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 369 of file CommonStorage.cpp.

◆ releaseDatabase()

void releaseDatabase	(	const DatabaseInterfacePrx &	db,
		const ::Ice::Current &	= `Ice::emptyCurrent`
	)

override

Definition at line 342 of file CommonStorage.cpp.

◆ releaseFileProxy()

void releaseFileProxy	(	const GridFileInterfacePrx &	fileProxy,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 593 of file CommonStorage.cpp.

◆ removeByFieldValue()

bool removeByFieldValue	(	const std::string &	ns,
		const std::string &	fieldName,
		const std::string &	fieldValue
	)

Definition at line 1072 of file CommonStorage.cpp.

◆ removeByMongoId()

bool removeByMongoId	(	const std::string &	ns,
		const std::string &	id
	)

Definition at line 1054 of file CommonStorage.cpp.

◆ removeByQuery()

bool removeByQuery	(	const std::string &	ns,
		const std::string &	query
	)

Definition at line 1078 of file CommonStorage.cpp.

◆ removeFileById()

bool removeFileById	(	const ::std::string &	dbName,
		const ::std::string &	fileId,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 737 of file CommonStorage.cpp.

Here is the call graph for this function:

◆ removeFileByName()

bool removeFileByName	(	const ::std::string &	dbName,
		const ::std::string &	gridFSName,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 756 of file CommonStorage.cpp.

◆ removeFileByQuery()

void removeFileByQuery	(	const std::string &	dbName,
		const mongo::BSONObj &	fileQuery
	)

Definition at line 676 of file CommonStorage.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ requestCollection()

CollectionInterfacePrx requestCollection	(	const std::string &	collectionNS,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 348 of file CommonStorage.cpp.

Here is the call graph for this function:

◆ requestDatabase()

DatabaseInterfacePrx requestDatabase	(	const ::std::string &	dbName,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 321 of file CommonStorage.cpp.

Here is the call graph for this function:

◆ storeBinaryFile()

std::string storeBinaryFile	(	const ::std::string &	dbName,
		const memoryx::Blob &	bufferToStore,
		const ::std::string &	gridFSName = `""`,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 485 of file CommonStorage.cpp.

◆ storeFile()

std::string storeFile	(	const ::std::string &	dbName,
		const ::std::string &	fileName,
		const ::std::string &	gridFSName = `""`,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 435 of file CommonStorage.cpp.

◆ storeTextFile()

std::string storeTextFile	(	const ::std::string &	dbName,
		const ::std::string &	bufferToStore,
		const ::std::string &	gridFSName = `""`,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)

override

Definition at line 461 of file CommonStorage.cpp.

◆ update()

bool update	(	const std::string &	ns,
		const DBStorableData &	obj,
		const std::string &	keyField,
		bool	upsert = `false`
	)

Definition at line 1009 of file CommonStorage.cpp.

◆ updateByQuery()

bool updateByQuery	(	const std::string &	ns,
		const std::string &	query,
		const mongo::BSONObj &	obj
	)

Definition at line 1037 of file CommonStorage.cpp.

The documentation for this class was generated from the following files:

MemoryX/components/CommonStorage/CommonStorage.h
MemoryX/components/CommonStorage/CommonStorage.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ authDB()

◆ clearCollection()

◆ count()

◆ createPropertyDefinitions()

◆ dropCollection()

◆ ensureIndex()

◆ findAll()

◆ findAllFieldValues()

◆ findAllIds()

◆ findAllUniqueByFieldName()

◆ findByFieldValue()

◆ findByFieldValueList()

◆ findByMongoId()

◆ findByQuery()

◆ findOneByFieldValue()

◆ findOneByQuery()

◆ getBinaryFileById()

◆ getBinaryFileByName()

◆ getCollectionNames()

◆ getDBNames()

◆ getDefaultName()

◆ getFileIdList()

◆ getFileNameList()

◆ getFileProxyById()

◆ getFileProxyByName()

◆ getMongoHostAndPort()

◆ getTextFileById()

◆ getTextFileByName()

◆ insert()

◆ insertList()

◆ isConnected()

◆ onConnectComponent()

◆ onExitComponent()

◆ onInitComponent()

◆ reconnect()

◆ releaseCollection()

◆ releaseDatabase()

◆ releaseFileProxy()

◆ removeByFieldValue()

◆ removeByMongoId()

◆ removeByQuery()

◆ removeFileById()

◆ removeFileByName()

◆ removeFileByQuery()

◆ requestCollection()

◆ requestDatabase()

◆ storeBinaryFile()

◆ storeFile()

◆ storeTextFile()

◆ update()

◆ updateByQuery()