Simias::Storage::Member Class Reference

Class that represents a member that has rights to a collection. More...

Inheritance diagram for Simias::Storage::Member:

[legend]

Collaboration diagram for Simias::Storage::Member:

[legend]

List of all members.

Public Member Functions
	Member (string userName, string userGuid, Access.Rights rights)
	Constructor for creating a new Member object.
	Member (string userName, string userGuid, Access.Rights rights, RSACryptoServiceProvider publicKey)
	Constructor for creating a new Member object.
	Member (string userName, string nodeID, string userGuid, Access.Rights rights, RSACryptoServiceProvider publicKey)
	Constructor for creating a new Member object.
	Member (string userName, string userGuid, Access.Rights rights, string givenName, string familyName)
	Constructor for creating a new Member object. Parameter validation is the responsibility of the calling function.
	Member (Node node)
	Constructor that creates a Member object from a Node object.
	Member (Collection collection, ShallowNode shallowNode)
	Constructor that creates a Member object from a ShallowNode object.
bool	ServerSetDefaultAccount (string iFolderID)
	Set the passphrase(key encrypted by passphrase and SHA1 of key) and recovery agent name and key.
string	ServerGetDefaultiFolder ()
	Set the passphrase(key encrypted by passphrase and SHA1 of key) and recovery agent name and key.
void	ServerSetPassPhrase (string EncryptedCryptoKey, string CryptoKeyBlob, string RAName, string RAPublicKey)
	Set the passphrase(key encrypted by passphrase and SHA1 of key) and recovery agent name and key.
void	SetEncryptionBlobFlag (Store store)
void	SetEncryptionBlobFlagServer (Store store, string userID)
int	iFolderMoveState (string DomainID, bool set, string iFolderID, int state, long iFolderSize)
	Commits the value iFolderMoveState. Used during moving iFolder from one machine to other.
long	MovediFolderSize (string DomainID, string iFolderID)
	To get the size of iFolder that was moved from one machine to other.
void	ModifyMemberProperties (Member ModifiedMember, string DomainID)
void	ModifyProperties (ref Member MemberOnMaster, Member ModifiedMember, string PolicyID)
	This method is used to modify the properties of member with reference to master.
void	SetOnMasterEncryptionBlobFlag (string DomainID)
	Sets the master encryption blob flag.
string	ServerGetEncrypPassKey ()
	Validate the passphrase.
string	ServerGetPassKeyHash ()
	Validate the passphrase.
bool	PassPhraseSetStatus ()
	whether passphrase is set or not , returns a bool value
void	SetPassPhrase (string Passphrase, string RAName, string RAPublicKey)
	Set the passphrase(key encrypted by passphrase and SHA1 of key) and recovery agent name and key.
void	TimerFired (object collectionClient)
	Call back for timer.
bool	DefaultAccount (string iFolderID)
	Sets the default account for the user.
string	GetDefaultiFolder ()
	Gets the default iFolder name.
bool	ReSetPassPhrase (string OldPassphrase, string Passphrase, string RAName, string RAPublicKey)
	Set the passphrase(key encrypted by passphrase and SHA1 of key) and recovery agent name and key.
void	KeyCorrection (ref string RAName, ref string RAPublicKey)
	KeyCorrection.
bool	UpdateSearchContexts (bool add)
	adds or removes the members DN from the search contexts
int	GetGroupsiFolderLimitPolicy (string DomainID, string UserID)
	GetGroupsiFolderLimitPolicy gets you the user groups sharing policy.
bool	IsTransferAllowed (string DomainID, string oldownerID, string newownerID)
int	GroupsiFolderLimit (string DomainID, string UserID)
	GetGroupsiFolderLimitPolicy gets you the user groups iFolder Limit policy.
int	GetGroupsSharingPolicy (string DomainID, string UserID)
	GetGroupsSharingPolicy gets you the user groups sharing policy.
bool	IsTransferAllowed (string DomainID, string UserID)
	Is Transfer Allowed gets you the user iFolder Limit policy - transfer of Ownership.
int	GroupsSharingPolicy (string DomainID, string UserID)
	GetGroupsiFolderLimitPolicy gets you the user groups sharing policy.
int	GetGroupSecurityPolicy (string DomainID, string UserID)
	GetGroupSecurityPolicy gets you the user groups Encryption Policy .
int	GroupsSecurityPolicy (string DomainID, string UserID)
	GroupsSecurityPolicy gets you the user groups Encryption policy.
int	GetEffectiveSyncPolicy (string DomainID, string UserID, String CollectionID)
	GetEffectiveSyncPolicy gets you the essective sync interval Policy .
int	EffectiveSyncPolicy (Collection collection)
	EffectiveSyncPolicy gets you the essective sync interval Policy .
Simias.Authentication.StatusCodes	ValidatePassPhrase (string Passphrase)
	Validate the passphrase.
byte[]	HashPassPhrase (string Passphrase)
	Hash the passphrase.
bool	IsPassPhraseSet ()
	Validate the passphrase.
void	ExportiFoldersCryptoKeys (string FilePath)
	Export the crypto keys from server.
void	ImportiFoldersCryptoKeys (string FilePath, string NewPassphrase, string OneTimePassphrase)
	Import the crypto keys from server.
Properties
string	EncryptionKey [get, set]
	Get/Set the encryption key.
string	EncryptionVersion [get, set]
	Get/Set the encryption version.
string	DeleteProperty [set]
	Deletes properties.
bool	LoginAlreadyDisabled [get, set]
	Gets / sets the User already disabled status.
int	UserMoveState [get, set]
	Gets / sets the User already disabled status.
string	EncryptionType [get, set]
	Gets the encryption blob.
string	EncryptionBlob [get, set]
	Gets the encryption blob.
bool	EncryptionBlobStatus [get]
	Gets the encryption blob status , a bool value.
string	RAName [get, set]
	Gets the encryption blob.
string	RAPublicKey [get, set]
	Gets the encryption blob.
bool	IsOwner [get, set]
	Gets or sets whether this Member object is the collection owner.
RSACryptoServiceProvider	PublicKey [get]
	Gets the public key stored on this Member object. May return null if no public key is set on the object.
Access.Rights	Rights [get, set]
	Gets or sets the members's access rights.
string	UserID [get]
	Gets the user identitifer for this object.
string	Given [get, set]
	Gets and sets the member's given (first) name returns null if the property does not exist.
string	Family [get, set]
	Gets and sets the member's family (last) name returns null if the property does not exist.
string	FN [get, set]
	Gets and sets the member's full name returns null if the property does not exist.
HostNode	HomeServer [get, set]
	Gets or Sets the HostID for the home server for this user. This is the ID of the server that hosts this user.
string	NewHomeServer [get, set]
	Gets or Sets the HostID for the New home server for this user. This is the ID of the server to which user needs to be moved .

---

Detailed Description

Class that represents a member that has rights to a collection.

---

Constructor & Destructor Documentation

Simias::Storage::Member::Member	(	string	userName,
		string	userGuid,
		Access.Rights	rights
	)			[inline]

Constructor for creating a new Member object.

Parameters:

	userName	User name of the member.
	userGuid	Unique identifier for the user.
	rights	Collection access rights granted to the user.

Simias::Storage::Member::Member	(	string	userName,
		string	userGuid,
		Access.Rights	rights,
		RSACryptoServiceProvider	publicKey
	)			[inline]

Constructor for creating a new Member object.

Parameters:

	userName	User name of the member.
	userGuid	Unique identifier for the user.
	rights	Collection access rights granted to the user.
	publicKey	Public key that will be used to authenticate the user.

Simias::Storage::Member::Member	(	string	userName,
		string	nodeID,
		string	userGuid,
		Access.Rights	rights,
		RSACryptoServiceProvider	publicKey
	)			[inline]

Constructor for creating a new Member object.

Parameters:

	userName	User name of the member.
	nodeID	Identifier for the Node object.
	userGuid	Unique identifier for the user.
	rights	Collection access rights granted to the user.
	publicKey	Public key that will be used to authenticate the user.

Simias::Storage::Member::Member	(	string	userName,
		string	userGuid,
		Access.Rights	rights,
		string	givenName,
		string	familyName
	)			[inline]

Constructor for creating a new Member object. Parameter validation is the responsibility of the calling function.

Parameters:

	userName	User name of the member.
	userGuid	Unique identifier for the user.
	rights	Collection access rights granted to the user.
	givenName	Given (first) name of the contact
	familyName	Family (last) name of the contact

Simias::Storage::Member::Member

(

Node

node

)

[inline]

Constructor that creates a Member object from a Node object.

Parameters:

node

Node object to create the Member object from.

Simias::Storage::Member::Member	(	Collection	collection,
		ShallowNode	shallowNode
	)			[inline]

Constructor that creates a Member object from a ShallowNode object.

Parameters:

	collection	Collection that the specified Node object belongs to.
	shallowNode	ShallowNode object to create the Member object from.

---

Member Function Documentation

bool Simias::Storage::Member::ServerSetDefaultAccount

(

string

iFolderID

)

[inline]

Set the passphrase(key encrypted by passphrase and SHA1 of key) and recovery agent name and key.

string Simias::Storage::Member::ServerGetDefaultiFolder

(

)

[inline]

Set the passphrase(key encrypted by passphrase and SHA1 of key) and recovery agent name and key.

void Simias::Storage::Member::ServerSetPassPhrase	(	string	EncryptedCryptoKey,
		string	CryptoKeyBlob,
		string	RAName,
		string	RAPublicKey
	)			[inline]

Set the passphrase(key encrypted by passphrase and SHA1 of key) and recovery agent name and key.

void Simias::Storage::Member::SetEncryptionBlobFlag

(

Store

store

)

[inline]

Simias client will call this whenever user sets passphrase for the first time. through thick client.

Parameters:

store

Stroe in which encryption flag has to be set

void Simias::Storage::Member::SetEncryptionBlobFlagServer	(	Store	store,
		string	userID
	)			[inline]

whenever user sets passphrase for the first time. throughweb-access, this will be called.

Parameters:

	store	Store in which encryption flag has to be set
	userID	To which User ID the flag has to set

int Simias::Storage::Member::iFolderMoveState	(	string	DomainID,
		bool	set,
		string	iFolderID,
		int	state,
		long	iFolderSize
	)			[inline]

Commits the value iFolderMoveState. Used during moving iFolder from one machine to other.

Parameters:

	DomainID	Domain ID to which iFolder belongs
	set	Whether to set or to get the value
	iFolderID	ID of iFolder which we have to handle
	state	Whether to delete or to modify or to add
	iFolderSize	Size of iFolder

Returns:

If set is false, it returns the value of state. If set is true, sets the value and returns 0

long Simias::Storage::Member::MovediFolderSize	(	string	DomainID,
		string	iFolderID
	)			[inline]

To get the size of iFolder that was moved from one machine to other.

Parameters:

	DomainID	Domain ID in which iFolder is available
	iFolderID	ID of iFolder

Returns:

void Simias::Storage::Member::ModifyMemberProperties	(	Member	ModifiedMember,
		string	DomainID
	)			[inline]

This method is used to modify the properties of member. Called from Simias.asmx

Parameters:

	ModifiedMember	Member to be modified
	DomainID	Domain ID to which member belongs

void Simias::Storage::Member::ModifyProperties	(	ref Member	MemberOnMaster,
		Member	ModifiedMember,
		string	PolicyID
	)			[inline]

This method is used to modify the properties of member with reference to master.

Parameters:

	MemberOnMaster	Reference to Member on master
	ModifiedMember	Member to be modified
	PolicyID	ID of policy to be modified

void Simias::Storage::Member::SetOnMasterEncryptionBlobFlag

(

string

DomainID

)

[inline]

Sets the master encryption blob flag.

Parameters:

DomainID

Domain Id to which the flag has to set

string Simias::Storage::Member::ServerGetEncrypPassKey

(

)

[inline]

Validate the passphrase.

string Simias::Storage::Member::ServerGetPassKeyHash

(

)

[inline]

Validate the passphrase.

bool Simias::Storage::Member::PassPhraseSetStatus

(

)

[inline]

whether passphrase is set or not , returns a bool value

void Simias::Storage::Member::SetPassPhrase	(	string	Passphrase,
		string	RAName,
		string	RAPublicKey
	)			[inline]

Set the passphrase(key encrypted by passphrase and SHA1 of key) and recovery agent name and key.

void Simias::Storage::Member::TimerFired

(

object

collectionClient

)

[inline]

Call back for timer.

Parameters:

collectionClient

Collection client as object to handle

bool Simias::Storage::Member::DefaultAccount

(

string

iFolderID

)

[inline]

Sets the default account for the user.

Parameters:

iFolderID

ID of iFolder to set as default account

Returns:

Returns true if success or else false

string Simias::Storage::Member::GetDefaultiFolder

(

)

[inline]

Gets the default iFolder name.

Returns:

Returns the name of default iFolder

bool Simias::Storage::Member::ReSetPassPhrase	(	string	OldPassphrase,
		string	Passphrase,
		string	RAName,
		string	RAPublicKey
	)			[inline]

Set the passphrase(key encrypted by passphrase and SHA1 of key) and recovery agent name and key.

void Simias::Storage::Member::KeyCorrection	(	ref string	RAName,
		ref string	RAPublicKey
	)			[inline]

KeyCorrection.

bool Simias::Storage::Member::UpdateSearchContexts

(

bool

add

)

[inline]

adds or removes the members DN from the search contexts

int Simias::Storage::Member::GetGroupsiFolderLimitPolicy	(	string	DomainID,
		string	UserID
	)			[inline]

GetGroupsiFolderLimitPolicy gets you the user groups sharing policy.

bool Simias::Storage::Member::IsTransferAllowed	(	string	DomainID,
		string	oldownerID,
		string	newownerID
	)			[inline]

GetUseriFolderLimitPolicy gets you the user limit policy - transfer of ownership.

int Simias::Storage::Member::GroupsiFolderLimit	(	string	DomainID,
		string	UserID
	)			[inline]

GetGroupsiFolderLimitPolicy gets you the user groups iFolder Limit policy.

int Simias::Storage::Member::GetGroupsSharingPolicy	(	string	DomainID,
		string	UserID
	)			[inline]

GetGroupsSharingPolicy gets you the user groups sharing policy.

bool Simias::Storage::Member::IsTransferAllowed	(	string	DomainID,
		string	UserID
	)			[inline]

Is Transfer Allowed gets you the user iFolder Limit policy - transfer of Ownership.

int Simias::Storage::Member::GroupsSharingPolicy	(	string	DomainID,
		string	UserID
	)			[inline]

GetGroupsiFolderLimitPolicy gets you the user groups sharing policy.

int Simias::Storage::Member::GetGroupSecurityPolicy	(	string	DomainID,
		string	UserID
	)			[inline]

GetGroupSecurityPolicy gets you the user groups Encryption Policy .

int Simias::Storage::Member::GroupsSecurityPolicy	(	string	DomainID,
		string	UserID
	)			[inline]

GroupsSecurityPolicy gets you the user groups Encryption policy.

int Simias::Storage::Member::GetEffectiveSyncPolicy	(	string	DomainID,
		string	UserID,
		String	CollectionID
	)			[inline]

GetEffectiveSyncPolicy gets you the essective sync interval Policy .

int Simias::Storage::Member::EffectiveSyncPolicy

(

Collection

collection

)

[inline]

EffectiveSyncPolicy gets you the essective sync interval Policy .

Simias.Authentication.StatusCodes Simias::Storage::Member::ValidatePassPhrase

(

string

Passphrase

)

[inline]

Validate the passphrase.

byte [] Simias::Storage::Member::HashPassPhrase

(

string

Passphrase

)

[inline]

Hash the passphrase.

bool Simias::Storage::Member::IsPassPhraseSet

(

)

[inline]

Validate the passphrase.

void Simias::Storage::Member::ExportiFoldersCryptoKeys

(

string

FilePath

)

[inline]

Export the crypto keys from server.

void Simias::Storage::Member::ImportiFoldersCryptoKeys	(	string	FilePath,
		string	NewPassphrase,
		string	OneTimePassphrase
	)			[inline]

Import the crypto keys from server.

---

Property Documentation

string Simias::Storage::Member::DeleteProperty [set]

Deletes properties.

bool Simias::Storage::Member::LoginAlreadyDisabled [get, set]

Gets / sets the User already disabled status.

int Simias::Storage::Member::UserMoveState [get, set]

Gets / sets the User already disabled status.

string Simias::Storage::Member::EncryptionType [get, set]

Gets the encryption blob.

string Simias::Storage::Member::EncryptionBlob [get, set]

Gets the encryption blob.

bool Simias::Storage::Member::EncryptionBlobStatus [get]

Gets the encryption blob status , a bool value.

string Simias::Storage::Member::RAName [get, set]

Gets the encryption blob.

string Simias::Storage::Member::RAPublicKey [get, set]

Gets the encryption blob.

bool Simias::Storage::Member::IsOwner [get, set]

Gets or sets whether this Member object is the collection owner.

RSACryptoServiceProvider Simias::Storage::Member::PublicKey [get]

Gets the public key stored on this Member object. May return null if no public key is set on the object.

Access.Rights Simias::Storage::Member::Rights [get, set]

Gets or sets the members's access rights.

string Simias::Storage::Member::UserID [get]

Gets the user identitifer for this object.

string Simias::Storage::Member::Given [get, set]

Gets and sets the member's given (first) name returns null if the property does not exist.

string Simias::Storage::Member::Family [get, set]

Gets and sets the member's family (last) name returns null if the property does not exist.

string Simias::Storage::Member::FN [get, set]

Gets and sets the member's full name returns null if the property does not exist.

HostNode Simias::Storage::Member::HomeServer [get, set]

Gets or Sets the HostID for the home server for this user. This is the ID of the server that hosts this user.

string Simias::Storage::Member::NewHomeServer [get, set]

Gets or Sets the HostID for the New home server for this user. This is the ID of the server to which user needs to be moved .

---

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

• src/core/CollectionStore/Member.cs