SimiasWebService Class Reference

List of all members.

Public Member Functions
void	PingSimias ()
void	AddMemberToDomain (string DomainID, string MemberName, string MemberID, string PublicKey, string GivenName, string FamilyName)
void	RemoveMemberFromDomain (string DomainID, string MemberID)
void	FindCloseMembers (string domainID, string searchContext)
bool	FindFirstMembers (string domainID, int count, out string searchContext, out MemberInfo[] memberList, out int totalMembers)
bool	FindFirstSpecificMembers (string domainID, string attributeName, string searchString, SearchType operation, int count, out string searchContext, out MemberInfo[] memberList, out int totalMembers)
bool	FindNextMembers (string domainID, ref string searchContext, int count, out MemberInfo[] memberList)
bool	FindPreviousMembers (string domainID, ref string searchContext, int count, out MemberInfo[] memberList)
bool	FindSeekMembers (string domainID, ref string searchContext, int offset, int count, out MemberInfo[] memberList)
string	GetSimiasInformation ()
DomainInformation	GetDomainInformation (string domainID)
DomainInformation[]	GetDomains (bool onlySlaves)
Status	LoginToRemoteDomain (string domainID, string password)
Status	LogoutFromRemoteDomain (string domainID)
void	DisableDomainAutoLogin (string domainID)
bool	IsDomainActive (string domainID)
int	SetDomainActive (string domainID)
int	SetDomainInactive (string domainID)
bool	ValidCredentials (string domainID, string memberID)
void	SetDomainCredentials (string domainID, string credentials, CredentialType type)
void	SetHostAddress (string Host, string PublicUrl, string PrivateUrl, string DomainID)
void	StorePassPhrase (string domainID, string passPhrase, CredentialType type, bool rememberPassPhrase)
CredentialType	GetDomainCredentials (string domainID, out string userID, out string credentials)
string	GetPassPhrase (string domainID)
bool	GetRememberOption (string domainID)
DomainInformation	ConnectToDomain (string UserName, string Password, string Host)
void	LeaveDomain (string DomainID, bool LocalOnly)
void	RemoveCertFromTable (string host)
void	SetDefaultDomain (string domainID)
string	GetDefaultDomainID ()
System.Byte[]	GetCertificate (string host)
System.Byte[]	GetCertificate2 (string host, out CertificateProblem Problem)
void	StoreCertificate (System.Byte[] certificate, string host)
void	StoreDomainCertificate (System.Byte[] certificate, string host, string domainID)
string[]	GetRAList ()
string[]	GetRAListOnClient (string DomainID)
System.Byte[]	GetRACertificate (string rAgent)
System.Byte[]	GetRACertificateOnClient (string DomainID, string rAgent)
string	GetPublicKey (string DomainID, string rAgent)
void	StoreRACertificate (System.Byte[] certificate, string rAgent)
string	GetInvalidSyncFilenameChars ()
bool	SetDomainHostAddress (string domainID, string hostAddress, string user, string password)
bool	SetProxyAddress (string hostUri, string proxyUri, string proxyUser, string proxyPassword)
bool	CanShareService (string simiasDataPath, bool isClient)
void	StopSimiasProcess ()
int	AddSimiasReference ()
int	RemoveSimiasReference ()
bool	ServerSetDefaultAccount (string DomainID, string UserID, string iFolderID)
string	ServerGetDefaultiFolder (string DomainID, string UserID)
int	GetGroupsiFolderLimitPolicy (string DomainID, string UserID)
bool	IsTransferAllowed (string DomainID, string UserID)
int	GetGroupsSharingPolicy (string DomainID, string UserID)
int	GetGroupsSecurityPolicy (string DomainID, string UserID)
int	GetEffectiveSyncPolicy (string DomainID, string UserID, string CollectionID)
Status	ServerSetPassPhrase (string DomainID, string UserID, string EncryptedCryptoKey, string CryptoKeyBlob, string RAName, string RAPublicKey)
string	ServerGetEncrypPassKey (string DomainID, string UserID)
string	ServerGetPassKeyHash (string DomainID, string UserID)
bool	UpdateUserMoveState (string DomainID, string UserID, int userMoveStatus)
bool	UpdateHomeServer (string DomainID, string UserID, string newHostID)
bool	DownloadiFolder (string iFolderID, string name, string DomainID, string HostID, string DirNodeID, string MemberNodeID, string colMemberNodeID, string localPath)
bool	UpdateLocalProperties (string DomainID, string UserID, string EncryptionKey, string EncryptionVersion, string EncryptionBlob, string RAName, string RAPublicKey)
bool	DisableUser (string DomainID, string UserID, string newHostID)
void	SetOnMasterEncryptionBlobFlag (string DomainID, string UserID)
bool	CommitDomainMember (string DomainID, System.Xml.XmlNode ModifiedMemberXML)
string	ServerGetCollectionHashKey (string CollectionID)
CollectionKey	GetiFolderCryptoKeys (string DomainID, string UserID, int Index)
bool	SetiFolderCryptoKeys (string DomainID, string UserID, CollectionKey CKey)
void	ExportiFoldersCryptoKeys (string DomainID, string FilePath)
void	ImportiFoldersCryptoKeys (string DomainID, string NewPassphrase, string OneTimePassphrase, string FilePath)
Status	SetPassPhrase (string DomainID, string PassPhrase, string RAName, string RAPublicKey)
bool	DefaultAccount (string DomainID, string iFolderID)
string	GetDefaultiFolder (string DomainID)
Status	ReSetPassPhrase (string DomainID, string OldPassPhrase, string PassPhrase, string RAName, string RAPublicKey)
Status	ValidatePassPhrase (string DomainID, string PassPhrase)
bool	IsPassPhraseSet (string DomainID)
string	GetSimiasDataPath ()
int	GetSimiasProcessID ()

---

Detailed Description

Web Service providing access to Simias /remarks>

---

Member Function Documentation

void SimiasWebService::PingSimias

(

)

[inline]

Allows a client to ping to make sure the Web Service is up and running /remarks>

void SimiasWebService::AddMemberToDomain	(	string	DomainID,
		string	MemberName,
		string	MemberID,
		string	PublicKey,
		string	GivenName,
		string	FamilyName
	)			[inline]

Add a member to the domain. /remarks>

void SimiasWebService::RemoveMemberFromDomain	(	string	DomainID,
		string	MemberID
	)			[inline]

Remove a member from the domain. /remarks>

void SimiasWebService::FindCloseMembers	(	string	domainID,
		string	searchContext
	)			[inline]

End the search for domain members. /remarks>

bool SimiasWebService::FindFirstMembers	(	string	domainID,
		int	count,
		out string	searchContext,
		out MemberInfo[]	memberList,
		out int	totalMembers
	)			[inline]

Starts a search for all domain members. /remarks>

bool SimiasWebService::FindFirstSpecificMembers	(	string	domainID,
		string	attributeName,
		string	searchString,
		SearchType	operation,
		int	count,
		out string	searchContext,
		out MemberInfo[]	memberList,
		out int	totalMembers
	)			[inline]

Starts a search for a specific set of domain members. /remarks>

bool SimiasWebService::FindNextMembers	(	string	domainID,
		ref string	searchContext,
		int	count,
		out MemberInfo[]	memberList
	)			[inline]

Continues the search for domain members from the current record location. /remarks>

bool SimiasWebService::FindPreviousMembers	(	string	domainID,
		ref string	searchContext,
		int	count,
		out MemberInfo[]	memberList
	)			[inline]

Continues the search for domain members previous to the current record location. /remarks>

bool SimiasWebService::FindSeekMembers	(	string	domainID,
		ref string	searchContext,
		int	offset,
		int	count,
		out MemberInfo[]	memberList
	)			[inline]

Continues the search for domain members from the specified record location. /remarks>

string SimiasWebService::GetSimiasInformation

(

)

[inline]

GetSimiasInformation /remarks>

DomainInformation SimiasWebService::GetDomainInformation

(

string

domainID

)

[inline]

GetDomainInformation /remarks>

DomainInformation [] SimiasWebService::GetDomains

(

bool

onlySlaves

)

[inline]

Get a list of local domains /remarks>

Status SimiasWebService::LoginToRemoteDomain	(	string	domainID,
		string	password
	)			[inline]

Login or authenticate to a remote domain /remarks>

Status SimiasWebService::LogoutFromRemoteDomain

(

string

domainID

)

[inline]

Logout from a remote domain /remarks>

void SimiasWebService::DisableDomainAutoLogin

(

string

domainID

)

[inline]

Disable automatic authentication to the specified domain /remarks>

bool SimiasWebService::IsDomainActive

(

string

domainID

)

[inline]

WebMethod to check if a domain is active /remarks>

int SimiasWebService::SetDomainActive

(

string

domainID

)

[inline]

SetDomainActive - enables synchronization to the remote server /remarks>

int SimiasWebService::SetDomainInactive

(

string

domainID

)

[inline]

SetDomainInactive - disables remote synchronization /remarks>

bool SimiasWebService::ValidCredentials	(	string	domainID,
		string	memberID
	)			[inline]

ValidCredentials /remarks>

void SimiasWebService::SetDomainCredentials	(	string	domainID,
		string	credentials,
		CredentialType	type
	)			[inline]

Sets domain credentials in the local store /remarks>

void SimiasWebService::SetHostAddress	(	string	Host,
		string	PublicUrl,
		string	PrivateUrl,
		string	DomainID
	)			[inline]

Sets host's url to local domain /remarks>

void SimiasWebService::StorePassPhrase	(	string	domainID,
		string	passPhrase,
		CredentialType	type,
		bool	rememberPassPhrase
	)			[inline]

Stores domain passphrase in the local store /remarks>

CredentialType SimiasWebService::GetDomainCredentials	(	string	domainID,
		out string	userID,
		out string	credentials
	)			[inline]

Get the saved credentials from a domain /remarks>

string SimiasWebService::GetPassPhrase

(

string

domainID

)

[inline]

Get the saved credentials from a domain /remarks>

bool SimiasWebService::GetRememberOption

(

string

domainID

)

[inline]

Get the saved credentials from a domain /remarks>

DomainInformation SimiasWebService::ConnectToDomain	(	string	UserName,
		string	Password,
		string	Host
	)			[inline]

Connects to a Domain /remarks>

void SimiasWebService::LeaveDomain	(	string	DomainID,
		bool	LocalOnly
	)			[inline]

Removes a domain account from the workstation /remarks>

void SimiasWebService::RemoveCertFromTable

(

string

host

)

[inline]

Remove Certificate for this specified host /remarks>

void SimiasWebService::SetDefaultDomain

(

string

domainID

)

[inline]

Change the default domain to the specified domain ID /remarks>

string SimiasWebService::GetDefaultDomainID

(

)

[inline]

Get the ID of the default domain /remarks>

System.Byte [] SimiasWebService::GetCertificate

(

string

host

)

[inline]

Get the certificate of the specified host. /remarks>

System.Byte [] SimiasWebService::GetCertificate2	(	string	host,
		out CertificateProblem	Problem
	)			[inline]

Get the certificate of the specified host. /remarks>

void SimiasWebService::StoreCertificate	(	System.Byte[]	certificate,
		string	host
	)			[inline]

Store the certificate for the specified host. /remarks>

void SimiasWebService::StoreDomainCertificate	(	System.Byte[]	certificate,
		string	host,
		string	domainID
	)			[inline]

Store the certificate for the specified host. /remarks>

string [] SimiasWebService::GetRAList

(

)

[inline]

Get the Recovery Agent List. /remarks>

string [] SimiasWebService::GetRAListOnClient

(

string

DomainID

)

[inline]

Get the Recovery Agent List. /remarks>

System.Byte [] SimiasWebService::GetRACertificate

(

string

rAgent

)

[inline]

Get the Recovery Agent certificate of the domain. /remarks>

System.Byte [] SimiasWebService::GetRACertificateOnClient	(	string	DomainID,
		string	rAgent
	)			[inline]

Get the Recovery Agent List. /remarks>

string SimiasWebService::GetPublicKey	(	string	DomainID,
		string	rAgent
	)			[inline]

Get the public key of the certificate /remarks>

void SimiasWebService::StoreRACertificate	(	System.Byte[]	certificate,
		string	rAgent
	)			[inline]

Store the certificate for the Domain. /remarks>

string SimiasWebService::GetInvalidSyncFilenameChars

(

)

[inline]

Returns the characters which cannot be used for filenames in the Simias namespace (files and folders that contain any of these characters cannot be synchronized with iFolder and conflicts will be generated). /remarks>

bool SimiasWebService::SetDomainHostAddress	(	string	domainID,
		string	hostAddress,
		string	user,
		string	password
	)			[inline]

Sets a new server network address for a client. /remarks>

bool SimiasWebService::SetProxyAddress	(	string	hostUri,
		string	proxyUri,
		string	proxyUser,
		string	proxyPassword
	)			[inline]

Sets a new proxy address for the specified host. /remarks>

bool SimiasWebService::CanShareService	(	string	simiasDataPath,
		bool	isClient
	)			[inline]

Checks to see if this instance of Simias is shareable. /remarks>

void SimiasWebService::StopSimiasProcess

(

)

[inline]

Shuts down the controlling server process. /remarks>

int SimiasWebService::AddSimiasReference

(

)

[inline]

Increments the reference count that keeps Simias services running. /remarks>

int SimiasWebService::RemoveSimiasReference

(

)

[inline]

Decrements the Simias service reference count and signals the server to stop if the count goes to zero. /remarks>

bool SimiasWebService::ServerSetDefaultAccount	(	string	DomainID,
		string	UserID,
		string	iFolderID
	)			[inline]

Set the passphrase and recovery agent. /remarks>

string SimiasWebService::ServerGetDefaultiFolder	(	string	DomainID,
		string	UserID
	)			[inline]

Set the passphrase and recovery agent. /remarks>

int SimiasWebService::GetGroupsiFolderLimitPolicy	(	string	DomainID,
		string	UserID
	)			[inline]

gets the GroupsiFolderLimitPolicy for users group. /remarks>

bool SimiasWebService::IsTransferAllowed	(	string	DomainID,
		string	UserID
	)			[inline]

gets the UseriFolderLimitPolicy for users - transfer of Ownership. /remarks>

int SimiasWebService::GetGroupsSharingPolicy	(	string	DomainID,
		string	UserID
	)			[inline]

gets the GroupsiFolderLimitPolicy for users group. /remarks>

int SimiasWebService::GetGroupsSecurityPolicy	(	string	DomainID,
		string	UserID
	)			[inline]

gets the GroupsSecurityPolicy for users group. /remarks>

int SimiasWebService::GetEffectiveSyncPolicy	(	string	DomainID,
		string	UserID,
		string	CollectionID
	)			[inline]

gets the GroupsSecurityPolicy for users group. /remarks>

Status SimiasWebService::ServerSetPassPhrase	(	string	DomainID,
		string	UserID,
		string	EncryptedCryptoKey,
		string	CryptoKeyBlob,
		string	RAName,
		string	RAPublicKey
	)			[inline]

Set the passphrase and recovery agent. /remarks>

string SimiasWebService::ServerGetEncrypPassKey	(	string	DomainID,
		string	UserID
	)			[inline]

ServerGetEncrypPassKey. /remarks>

string SimiasWebService::ServerGetPassKeyHash	(	string	DomainID,
		string	UserID
	)			[inline]

ServerGetPassKeyHash. /remarks>

bool SimiasWebService::UpdateUserMoveState	(	string	DomainID,
		string	UserID,
		int	userMoveStatus
	)			[inline]

Updates the user move state property /remarks>

bool SimiasWebService::UpdateHomeServer	(	string	DomainID,
		string	UserID,
		string	newHostID
	)			[inline]

Update users HomeServer Object /remarks>

bool SimiasWebService::DownloadiFolder	(	string	iFolderID,
		string	name,
		string	DomainID,
		string	HostID,
		string	DirNodeID,
		string	MemberNodeID,
		string	colMemberNodeID,
		string	localPath
	)			[inline]

Returns the characters which cannot be used for filenames in the Simias namespace (files and folders that contain any of these characters cannot be synchronized with iFolder and conflicts will be generated). /remarks>

bool SimiasWebService::UpdateLocalProperties	(	string	DomainID,
		string	UserID,
		string	EncryptionKey,
		string	EncryptionVersion,
		string	EncryptionBlob,
		string	RAName,
		string	RAPublicKey
	)			[inline]

Updates the encryption related local properties. /remarks>

bool SimiasWebService::DisableUser	(	string	DomainID,
		string	UserID,
		string	newHostID
	)			[inline]

Disable user object and set user move property /remarks>

void SimiasWebService::SetOnMasterEncryptionBlobFlag	(	string	DomainID,
		string	UserID
	)			[inline]

SetOnMasterEncryptionBlobFlag /remarks>

bool SimiasWebService::CommitDomainMember	(	string	DomainID,
		System.Xml.XmlNode	ModifiedMemberXML
	)			[inline]

CommitDomainMember /remarks>

string SimiasWebService::ServerGetCollectionHashKey

(

string

CollectionID

)

[inline]

GetCollectionHashKey. /remarks>

CollectionKey SimiasWebService::GetiFolderCryptoKeys	(	string	DomainID,
		string	UserID,
		int	Index
	)			[inline]

GetiFolderCryptoKeys. /remarks>

bool SimiasWebService::SetiFolderCryptoKeys	(	string	DomainID,
		string	UserID,
		CollectionKey	CKey
	)			[inline]

SetiFolderCryptoKeys. /remarks>

void SimiasWebService::ExportiFoldersCryptoKeys	(	string	DomainID,
		string	FilePath
	)			[inline]

ExportiFoldersCryptoKeys. /remarks>

void SimiasWebService::ImportiFoldersCryptoKeys	(	string	DomainID,
		string	NewPassphrase,
		string	OneTimePassphrase,
		string	FilePath
	)			[inline]

ImportiFoldersCryptoKeys. /remarks>

Status SimiasWebService::SetPassPhrase	(	string	DomainID,
		string	PassPhrase,
		string	RAName,
		string	RAPublicKey
	)			[inline]

Set the passphrase and recovery agent. /remarks>

bool SimiasWebService::DefaultAccount	(	string	DomainID,
		string	iFolderID
	)			[inline]

Set the passphrase and recovery agent. /remarks>

string SimiasWebService::GetDefaultiFolder

(

string

DomainID

)

[inline]

Set the passphrase and recovery agent. /remarks>

Status SimiasWebService::ReSetPassPhrase	(	string	DomainID,
		string	OldPassPhrase,
		string	PassPhrase,
		string	RAName,
		string	RAPublicKey
	)			[inline]

Reset passphrase and recovery agent. /remarks>

Status SimiasWebService::ValidatePassPhrase	(	string	DomainID,
		string	PassPhrase
	)			[inline]

Validate the passphrase for the correctness. /remarks>

bool SimiasWebService::IsPassPhraseSet

(

string

DomainID

)

[inline]

Returns the passphrase state. /remarks>

string SimiasWebService::GetSimiasDataPath

(

)

[inline]

Gets the directory path to the Simias data area. /remarks>

int SimiasWebService::GetSimiasProcessID

(

)

[inline]

Gets the process ID for the current running process. /remarks>

---

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

• src/core/SimiasClient/SimiasService.cs