iFolder::WebService::iFolderCommonLocal Class Reference

iFolder Common Local Web Service More...

Inheritance diagram for iFolder::WebService::iFolderCommonLocal:

[legend]

List of all members.

Public Member Functions
	iFolderCommonLocal ()
	Constructor.
virtual iFolderSystem	GetSystem ()
	enum to store the different sharing policy combination
virtual iFolderServer	GetHomeServer ()
	Get information about the authenticated user's home iFolder server.
virtual string[]	GetServerProvisioningList ()
	Get the list of all the server names.
virtual string	GetiFolderLocation (string ifolderID)
	Get the location of the iFolder.
virtual iFolderSet	GetOrphanediFolders (SearchOperation operation, string pattern, int index, int max)
	Get all the searched orphaned ifolders.
virtual string	IsOrphanediFolder (string iFolderID)
	Checks whether an ifolder is orphaned or not.
virtual string	GetShortenedName (string name, int length)
	return the shortened string
virtual string[]	GetRAList ()
	Get the list of recovery agents.
virtual byte[]	GetRACertificate (string rAgent)
	Get the RA Certificate.
virtual bool	IsPassPhraseSet ()
	Get the PassPhrase Status.
virtual Simias.Authentication.Status	ValidatePassPhrase (string passPhrase)
virtual void	SetPassPhrase (string passPhrase, string recoveryAgentName, string publicKey)
virtual bool	IsGroupId (string UserID)
	whether this id is a group id or not
virtual int	GetSharingStatus (string iFolderID)
	Get the policy for an iFolder.
virtual void	DisableSystemPastSharing ()
	Disable Past sharing for whole system.
virtual void	DisableUserPastSharing (string UserID)
	Disable Past sharing for a particular user.
virtual void	DisableiFolderPastSharing (string iFolderID)
	Disable Past sharing for an iFolder.
virtual iFolderServer	GetServer (string serverID)
	Get information about an iFolder Server.
virtual iFolderServer[]	GetServers ()
	Get information about all the iFolder servers.
virtual string	GetHomeServerForUser (string username, string password)
	Get the home server for the user.
virtual string	GetHomeServerURLForUserID (string userid)
	Get the home server for the user using admin credential.
virtual string[]	GetReports ()
	Get reports.
virtual iFolderServerSet	GetServersByName (SearchOperation operation, string pattern, int index, int count)
	Get information about iFolder Servers identified by a search on name.
virtual void	DeleteiFolder (string ifolderID)
	Delete an iFolder.
virtual iFolder	GetiFolder (string ifolderID)
	Get information about an iFolder.
virtual iFolderDetails	GetiFolderDetails (string ifolderID)
	Get detailed information about an iFolder.
virtual void	SetiFolderDescription (string ifolderID, string description)
	Set the description of an iFolder.
virtual void	PublishiFolder (string ifolderID, bool publish)
	Publish an iFolder.
virtual ChangeEntrySet	GetChanges (string ifolderID, string itemID, int index, int max)
	Get a history of changes to an iFolder.
virtual string	TrimUrl (string FullUrl)
	To extract the aspx page from header.
virtual iFolderUser	GetAuthenticatedUser ()
	Get information about the authenticated user.
virtual void	SetMemberRights (string ifolderID, string userID, Rights rights)
	Set the rights of a member on an iFolder.
virtual void	AddMember (string ifolderID, string userID, Rights rights)
	Add a member to an iFolder.
virtual void	RemoveMember (string ifolderID, string userID)
	Remove a member from an iFolder.
virtual string[]	GetGroupIDs (string userID)
	Get all groupids this member belongs to .
virtual void	SetiFolderOwner (string ifolderID, string userID, bool OrphanAdopt)
	Set the owner of an iFolder.
virtual iFolderUserSet	GetMembers (string ifolderID, int index, int max)
	Get information about the members of an iFolder.
virtual iFolderUserSet	GetUsers (int index, int max)
	Get information about all of the iFolder users.
virtual iFolderUser	GetUser (string userID)
	Get information about a user using an id or username.
virtual void	ProvisionUsersToServers (string[] ServerNames, string[] UserIDs)
	Provision Users to servers.
virtual void	ProvisionUsersToServer (string ServerName, string[] ListOfUsers)
	Provision Users to a server.
virtual void	ReProvisionUsersToServer (string ServerName, string UserID)
	ReProvision Users to a server.
virtual iFolderUserDetails	GetUserDetails (string userID)
	Get detailed information about a user.
virtual iFolderUserSet	GetUsersBySearch (SearchProperty property, SearchOperation operation, string pattern, int index, int max)
	Get information about all of the iFolder users identified by the search property, operation, and pattern.
virtual iFolderUserSet	GetReprovisionUsers (int index, int max)
	Get information about all of the iFolder users with DATA move property set.
Protected Member Functions
abstract string	GetAccessID ()
	Get the access user's id.
abstract string	GetUserID ()
	Get the authenticated user's id.
abstract void	Authorize ()
	Authorize the authenticated user.

---

Detailed Description

iFolder Common Local Web Service

---

Constructor & Destructor Documentation

iFolder::WebService::iFolderCommonLocal::iFolderCommonLocal

(

)

[inline]

Constructor.

---

Member Function Documentation

virtual iFolderSystem iFolder::WebService::iFolderCommonLocal::GetSystem

(

)

[inline, virtual]

enum to store the different sharing policy combination

Get information about the iFolder system.

Returns:

An iFolderSystem object describing the system.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual iFolderServer iFolder::WebService::iFolderCommonLocal::GetHomeServer

(

)

[inline, virtual]

Get information about the authenticated user's home iFolder server.

Returns:

An iFolderServer object describing the user's home iFolder server.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual string [] iFolder::WebService::iFolderCommonLocal::GetServerProvisioningList

(

)

[inline, virtual]

Get the list of all the server names.

Returns:

a string array of server names

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual string iFolder::WebService::iFolderCommonLocal::GetiFolderLocation

(

string

ifolderID

)

[inline, virtual]

Get the location of the iFolder.

Returns:

The PrivateUrl of the iFolder's HomeServer.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual iFolderSet iFolder::WebService::iFolderCommonLocal::GetOrphanediFolders	(	SearchOperation	operation,
		string	pattern,
		int	index,
		int	max
	)			[inline, virtual]

Get all the searched orphaned ifolders.

Returns:

a list of orphaned ifolders.

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual string iFolder::WebService::iFolderCommonLocal::IsOrphanediFolder

(

string

iFolderID

)

[inline, virtual]

Checks whether an ifolder is orphaned or not.

Returns:

. string 'false' if the ifolder is not orphaned otherwise returns userID of prev owner

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual string iFolder::WebService::iFolderCommonLocal::GetShortenedName	(	string	name,
		int	length
	)			[inline, virtual]

return the shortened string

Returns:

short string

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual string [] iFolder::WebService::iFolderCommonLocal::GetRAList

(

)

[inline, virtual]

Get the list of recovery agents.

Returns:

The list containing recovery agents name

Reimplemented in iFolder::WebService::iFolderWeb.

virtual byte [] iFolder::WebService::iFolderCommonLocal::GetRACertificate

(

string

rAgent

)

[inline, virtual]

Get the RA Certificate.

Returns:

The byte array containing the certificate

Reimplemented in iFolder::WebService::iFolderWeb.

virtual bool iFolder::WebService::iFolderCommonLocal::IsPassPhraseSet

(

)

[inline, virtual]

Get the PassPhrase Status.

Returns:

The Status of pass-phrase

summary> Validate the passphrase for the correctness /summary> returns>passPhrase.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual Simias.Authentication.Status iFolder::WebService::iFolderCommonLocal::ValidatePassPhrase

(

string

passPhrase

)

[inline, virtual]

summary> Set the passphrase and recovery agent /summary> returns>passPhrase.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual void iFolder::WebService::iFolderCommonLocal::SetPassPhrase	(	string	passPhrase,
		string	recoveryAgentName,
		string	publicKey
	)			[inline, virtual]

summary> checks if for this user, encryption is enforced /summary> returns>true/false

Reimplemented in iFolder::WebService::iFolderWeb.

virtual bool iFolder::WebService::iFolderCommonLocal::IsGroupId

(

string

UserID

)

[inline, virtual]

whether this id is a group id or not

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual int iFolder::WebService::iFolderCommonLocal::GetSharingStatus

(

string

iFolderID

)

[inline, virtual]

Get the policy for an iFolder.

Parameters:

policy

The iFolderPolicy object.

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual void iFolder::WebService::iFolderCommonLocal::DisableSystemPastSharing

(

)

[inline, virtual]

Disable Past sharing for whole system.

got an iFolder, now remove the member list

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual void iFolder::WebService::iFolderCommonLocal::DisableUserPastSharing

(

string

UserID

)

[inline, virtual]

Disable Past sharing for a particular user.

got an iFolder, now remove the member list

got an iFolder, now remove the member list

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual void iFolder::WebService::iFolderCommonLocal::DisableiFolderPastSharing

(

string

iFolderID

)

[inline, virtual]

Disable Past sharing for an iFolder.

got an iFolder, now remove the member list

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual iFolderServer iFolder::WebService::iFolderCommonLocal::GetServer

(

string

serverID

)

[inline, virtual]

Get information about an iFolder Server.

Parameters:

serverID

The id of the iFolder Server.

Returns:

An iFolderServer object describing the iFolder Server.

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual iFolderServer [] iFolder::WebService::iFolderCommonLocal::GetServers

(

)

[inline, virtual]

Get information about all the iFolder servers.

Returns:

An array of iFolderServer objects.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual string iFolder::WebService::iFolderCommonLocal::GetHomeServerForUser	(	string	username,
		string	password
	)			[inline, virtual]

Get the home server for the user.

Returns:

Publiv url of the home server.

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual string iFolder::WebService::iFolderCommonLocal::GetHomeServerURLForUserID

(

string

userid

)

[inline, virtual]

Get the home server for the user using admin credential.

Returns:

Publiv url of the home server.

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual string [] iFolder::WebService::iFolderCommonLocal::GetReports

(

)

[inline, virtual]

Get reports.

Returns:

An array of iFolderServer objects.

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual iFolderServerSet iFolder::WebService::iFolderCommonLocal::GetServersByName	(	SearchOperation	operation,
		string	pattern,
		int	index,
		int	count
	)			[inline, virtual]

Get information about iFolder Servers identified by a search on name.

Parameters:

	operation	The operation to compare the name and pattern.
	pattern	The pattern to search.
	index	The starting index for the search results.
	count	The max number of search results to be returned.

Returns:

A set of iFolder Server objects.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual void iFolder::WebService::iFolderCommonLocal::DeleteiFolder

(

string

ifolderID

)

[inline, virtual]

Delete an iFolder.

Parameters:

ifolderID

The id of the iFolder to be deleted.

This API will accept multiple iFolder ids in a comma delimited list.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual iFolder iFolder::WebService::iFolderCommonLocal::GetiFolder

(

string

ifolderID

)

[inline, virtual]

Get information about an iFolder.

Parameters:

ifolderID

The id of the iFolder.

Returns:

An iFolder object describing the iFolder.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual iFolderDetails iFolder::WebService::iFolderCommonLocal::GetiFolderDetails

(

string

ifolderID

)

[inline, virtual]

Get detailed information about an iFolder.

Parameters:

ifolderID

The id of the iFolder

Returns:

An iFolderDetails object describing the iFolder

It is more expensive to call GetiFolderDetails than GetiFolder.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual void iFolder::WebService::iFolderCommonLocal::SetiFolderDescription	(	string	ifolderID,
		string	description
	)			[inline, virtual]

Set the description of an iFolder.

Parameters:

	ifolderID	The id of the iFolder.
	description	The new description for the iFolder.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual void iFolder::WebService::iFolderCommonLocal::PublishiFolder	(	string	ifolderID,
		bool	publish
	)			[inline, virtual]

Publish an iFolder.

Parameters:

	ifolderID	The id of the iFolder.
	publish	The published state of the iFolder

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual ChangeEntrySet iFolder::WebService::iFolderCommonLocal::GetChanges	(	string	ifolderID,
		string	itemID,
		int	index,
		int	max
	)			[inline, virtual]

Get a history of changes to an iFolder.

Parameters:

	ifolderID	The id of the iFolder.
	itemID	The id of item to filter the results (can be null for no filtering).
	index	The starting index for the search results.
	max	The max number of search results to be returned.

Returns:

A set of ChangeEntry objects.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual string iFolder::WebService::iFolderCommonLocal::TrimUrl

(

string

FullUrl

)

[inline, virtual]

To extract the aspx page from header.

Parameters:

	sender
	e

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual iFolderUser iFolder::WebService::iFolderCommonLocal::GetAuthenticatedUser

(

)

[inline, virtual]

Get information about the authenticated user.

Returns:

An iFolderUser object describing the authenticated user.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual void iFolder::WebService::iFolderCommonLocal::SetMemberRights	(	string	ifolderID,
		string	userID,
		Rights	rights
	)			[inline, virtual]

Set the rights of a member on an iFolder.

Parameters:

	ifolderID	The id of the iFolder.
	userID	The user id of the member.
	rights	The rights to be set.

This API will accept multiple user ids in a comma delimited list.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual void iFolder::WebService::iFolderCommonLocal::AddMember	(	string	ifolderID,
		string	userID,
		Rights	rights
	)			[inline, virtual]

Add a member to an iFolder.

Parameters:

	ifolderID	The id of iFolder.
	userID	The user id of the new member.
	rights	The rights of the new member on the iFolder.

This API will accept multiple user ids in a comma delimited list.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual void iFolder::WebService::iFolderCommonLocal::RemoveMember	(	string	ifolderID,
		string	userID
	)			[inline, virtual]

Remove a member from an iFolder.

Parameters:

	ifolderID	The id of the iFolder.
	userID	The user id of the member.

This API will accept multiple user ids in a comma delimited list.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual string [] iFolder::WebService::iFolderCommonLocal::GetGroupIDs

(

string

userID

)

[inline, virtual]

Get all groupids this member belongs to .

Parameters:

userID

The user id of the member.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual void iFolder::WebService::iFolderCommonLocal::SetiFolderOwner	(	string	ifolderID,
		string	userID,
		bool	OrphanAdopt
	)			[inline, virtual]

Set the owner of an iFolder.

Parameters:

	ifolderID	The id of the iFolder.
	userID	The user id of the new owner.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual iFolderUserSet iFolder::WebService::iFolderCommonLocal::GetMembers	(	string	ifolderID,
		int	index,
		int	max
	)			[inline, virtual]

Get information about the members of an iFolder.

Parameters:

	ifolderID	The id of the iFolder.
	index	The starting index for the search results.
	max	The max number of search results to be returned.

Returns:

A set of iFolderUser objects describing the members.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual iFolderUserSet iFolder::WebService::iFolderCommonLocal::GetUsers	(	int	index,
		int	max
	)			[inline, virtual]

Get information about all of the iFolder users.

Parameters:

	index	The starting index for the search results.
	max	The max number of search results to be returned.

Returns:

A set of iFolderUser objects.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual iFolderUser iFolder::WebService::iFolderCommonLocal::GetUser

(

string

userID

)

[inline, virtual]

Get information about a user using an id or username.

Parameters:

userID

The id or username of the user.

Returns:

A iFolderUser object.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual void iFolder::WebService::iFolderCommonLocal::ProvisionUsersToServers	(	string[]	ServerNames,
		string[]	UserIDs
	)			[inline, virtual]

Provision Users to servers.

Parameters:

	ServerNames	A string array containing server names
	UserIDs	A string array containing corresponding userids

Returns:

No return value

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual void iFolder::WebService::iFolderCommonLocal::ProvisionUsersToServer	(	string	ServerName,
		string[]	ListOfUsers
	)			[inline, virtual]

Provision Users to a server.

Parameters:

	ServerName	A string containing server's name.
	ListOfUsers	An array of string containing userIDs

Returns:

No return value

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual void iFolder::WebService::iFolderCommonLocal::ReProvisionUsersToServer	(	string	ServerName,
		string	UserID
	)			[inline, virtual]

ReProvision Users to a server.

Parameters:

	ServerName	A string containing server's name.
	UserID	string containing userID

Returns:

No return value

virtual iFolderUserDetails iFolder::WebService::iFolderCommonLocal::GetUserDetails

(

string

userID

)

[inline, virtual]

Get detailed information about a user.

Parameters:

userID

The id of the user.

Returns:

A iFolderUserDetails object.

It is more expensive to call GetUserDetails than GetUser.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual iFolderUserSet iFolder::WebService::iFolderCommonLocal::GetUsersBySearch	(	SearchProperty	property,
		SearchOperation	operation,
		string	pattern,
		int	index,
		int	max
	)			[inline, virtual]

Get information about all of the iFolder users identified by the search property, operation, and pattern.

Parameters:

	property	The property to search.
	operation	The operation to compare the property and pattern.
	pattern	The pattern to search
	index	The starting index for the search results.
	max	The max number of search results to be returned.

Returns:

A set of iFolderUser objects.

Reimplemented in iFolder::WebService::iFolderAdmin, and iFolder::WebService::iFolderWeb.

virtual iFolderUserSet iFolder::WebService::iFolderCommonLocal::GetReprovisionUsers	(	int	index,
		int	max
	)			[inline, virtual]

Get information about all of the iFolder users with DATA move property set.

Parameters:

	index	The starting index for the search results.
	max	The max number of search results to be returned.

Returns:

A set of iFolderUser objects.

Reimplemented in iFolder::WebService::iFolderAdmin.

abstract string iFolder::WebService::iFolderCommonLocal::GetAccessID

(

)

[protected, pure virtual]

Get the access user's id.

Implemented in iFolder::WebService::iFolderAdminLocal, and iFolder::WebService::iFolderWebLocal.

abstract string iFolder::WebService::iFolderCommonLocal::GetUserID

(

)

[protected, pure virtual]

Get the authenticated user's id.

Implemented in iFolder::WebService::iFolderAdminLocal, and iFolder::WebService::iFolderWebLocal.

abstract void iFolder::WebService::iFolderCommonLocal::Authorize

(

)

[protected, pure virtual]

Authorize the authenticated user.

Implemented in iFolder::WebService::iFolderAdminLocal, and iFolder::WebService::iFolderWebLocal.

---

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

• src/webservices/iFolderCommonLocal.cs