oxy::directory::IMetadata Struct Reference

Interface for interacting with the metadata service. More...

#include <services.hpp>

Public Member Functions
virtual int64_t	count (const std::string &identifier) const =0
	Counts the number of metadata records for a given customer identifier.
virtual void	fetch (const std::string &identifier, const std::string &packName, const std::vector< std::string > &oids) const =0
	Fetches metadata records associated with the specified customer identifiers into a pack.
virtual void	fetch_all (const std::string &identifier, const std::string &packName) const =0
	Fetches all metadata records associated with the specified customer identifier.
virtual void	fetch_since (const std::string &identifier, const std::string &packName, const std::string &since) const =0
	Fetches metadata records associated with the specified customer identifier since a specific timestamp.
virtual void	open (const IConnectionPtr &conn)=0
	Opens a connection to the metadata service.
virtual void	post (std::string const &packName, std::string const &identifier) const =0
	Posts metadata records associated with the specified customer identifier.

Detailed Description

Interface for interacting with the metadata service.

This interface provides methods for opening a connection to the metadata service, counting metadata records, and fetching metadata records based on a customer identifier and timestamps. Implementations of this interface should handle the specifics of communicating with the metadata service and retrieving the requested data.

Member Function Documentation

count()

virtual int64_t oxy::directory::IMetadata::count ( const std::string & identifier ) const

pure virtual

Counts the number of metadata records for a given customer identifier.

Parameters

identifier

The customer identifier to count records for

Returns

The number of metadata records for the specified customer identifier

fetch()

virtual void oxy::directory::IMetadata::fetch ( const std::string & identifier, const std::string & packName, const std::vector< std::string > & oids ) const

pure virtual

Fetches metadata records associated with the specified customer identifiers into a pack.

Parameters

identifier	The customer identifier used to locate the records to fetch.
packName	The name of the pack where to fetch the datas.
oids	A collection of metadata identifiers (OIDs) to fetch.

fetch_all()

virtual void oxy::directory::IMetadata::fetch_all ( const std::string & identifier, const std::string & packName ) const

pure virtual

Fetches all metadata records associated with the specified customer identifier.

Parameters

identifier	The customer identifier used to locate the records to fetch.
packName	The name of the pack where to fetch the datas.

fetch_since()

virtual void oxy::directory::IMetadata::fetch_since ( const std::string & identifier, const std::string & packName, const std::string & since ) const

pure virtual

Fetches metadata records associated with the specified customer identifier since a specific timestamp.

Parameters

identifier	The customer identifier used to locate the records to fetch.
packName	The name of the pack where to fetch the datas.
since	The timestamp to fetch records since.

open()

virtual void oxy::directory::IMetadata::open ( const IConnectionPtr & conn )

pure virtual

Opens a connection to the metadata service.

Parameters

conn	A shared pointer to an IConnection interface

post()

virtual void oxy::directory::IMetadata::post ( std::string const & packName, std::string const & identifier ) const

pure virtual

Posts metadata records associated with the specified customer identifier.

Parameters

packName	The name of the pack containing the data to post.
identifier	The customer identifier used to locate the records to post.