Simias::Server::CatalogEntry Class Reference

Catalog Entry A catalog entry is a node that belongs to the system catalog collection that replicates across all servers in a multi-server ifolder system. There should be one catalog entry for each collection in the system which makes it possible to find any collection from any host in the system. The three distinguishing properties on a CatalogEntry are: HostID - Host where the associated collection lives CollectionID - Associated Collection ID UserIDs - List of members for the associated collection. More...

Inheritance diagram for Simias::Server::CatalogEntry:

[legend]

Collaboration diagram for Simias::Server::CatalogEntry:

[legend]

List of all members.

Public Member Functions
bool	isSharedWithUser (string UserID)
	Is this catalog entry shared with this user.
bool	RemoveMember (string NodeID)
	Remove a member from the catalog entry. Note: called when a member is removed from the collection. See above explanation for kludgy format.
void	AddOrphanedOwner (string UserDN)
	Add previous owner as orphaned owner in the catalog entry. Note: called when ownership is transferred and collection is made orphaned .
void	RemoveOrphanedOwner ()
	remove orphaned owner property when iFolder is adopted, i.e. assigned an owner. Note: called when ownership is transferred and collection is made orphaned .
Properties
string	CollectionID [get]
	Returns the actual collection this entry relates to.
string	HostID [get, set]
	Returns the HostID where this collection is located.
long	CollectionSize [get]
	Returns the size of the data in this collection.
string	OwnerID [get]
	Returns the size of the data in this collection.
string	OrphanedOwnerDN [get]
	Returns Dn of orphaned owner.
bool	Disabled [get]
	Returns the collection enabled / disabled status.
string[]	UserIDs [get]
	Returns an array of UserIDs which are members of the collection.

---

Detailed Description

Catalog Entry A catalog entry is a node that belongs to the system catalog collection that replicates across all servers in a multi-server ifolder system. There should be one catalog entry for each collection in the system which makes it possible to find any collection from any host in the system. The three distinguishing properties on a CatalogEntry are: HostID - Host where the associated collection lives CollectionID - Associated Collection ID UserIDs - List of members for the associated collection.

---

Member Function Documentation

bool Simias::Server::CatalogEntry::isSharedWithUser

(

string

UserID

)

[inline]

Is this catalog entry shared with this user.

Parameters:

UserID

userid

Returns:

true if shared

bool Simias::Server::CatalogEntry::RemoveMember

(

string

NodeID

)

[inline]

Remove a member from the catalog entry. Note: called when a member is removed from the collection. See above explanation for kludgy format.

void Simias::Server::CatalogEntry::AddOrphanedOwner

(

string

UserDN

)

[inline]

Add previous owner as orphaned owner in the catalog entry. Note: called when ownership is transferred and collection is made orphaned .

Parameters:

UserDN

user DN which will be added as Orphaned Owner

void Simias::Server::CatalogEntry::RemoveOrphanedOwner

(

)

[inline]

remove orphaned owner property when iFolder is adopted, i.e. assigned an owner. Note: called when ownership is transferred and collection is made orphaned .

---

Property Documentation

string Simias::Server::CatalogEntry::CollectionID [get]

Returns the actual collection this entry relates to.

string Simias::Server::CatalogEntry::HostID [get, set]

Returns the HostID where this collection is located.

long Simias::Server::CatalogEntry::CollectionSize [get]

Returns the size of the data in this collection.

string Simias::Server::CatalogEntry::OwnerID [get]

Returns the size of the data in this collection.

string Simias::Server::CatalogEntry::OrphanedOwnerDN [get]

Returns Dn of orphaned owner.

bool Simias::Server::CatalogEntry::Disabled [get]

Returns the collection enabled / disabled status.

string [] Simias::Server::CatalogEntry::UserIDs [get]

Returns an array of UserIDs which are members of the collection.

---

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

• src/server/Simias.Server/Catalog.cs