iFolder::WebService::iFolderWebLocal Class Reference

iFolder Local Web Service More...

Inheritance diagram for iFolder::WebService::iFolderWebLocal:

Collaboration diagram for iFolder::WebService::iFolderWebLocal:

List of all members.

Public Types

enum Share

Public Member Functions

iFolderWebLocal ()

Constructor.

virtual void SetMigratedFlag (string iFolderID, int MigrateionSource)

Set the migrated flag for the iFolder to determine that the iFolder is a migrated one.

virtual iFolderSet GetiFolders (int index, int max)

Get information about all the iFolders to which the authenticate user has rights.

virtual iFolder CreateiFolder (string name, string description, bool ssl, string encryptionAlgorithm, string PassPhrase)

Create a new iFolder with the authenticated user as the owner.

virtual iFolderSet GetiFoldersByName (SearchOperation operation, string pattern, int index, int max)

Get information about iFolders identified by the search operation and pattern.

virtual bool ShowTabDetails (string PassPhrase, string EncryptionAlgorithm)

virtual iFolderSet GetiFoldersBySearch (MemberRole role, DateTime after, SearchOperation operation, string pattern, int index, int max)

Get information about iFolder identified by role, creation time, and search operation and pattern.

virtual void RemoveMembership (string ifolderID)

Remove the authenticated user's membership to an iFolder.

virtual UserPolicy GetAuthenticatedUserPolicy ()

Get policy information for the authenticated user.

virtual iFolderPolicy GetiFolderPolicy (string ifolderID)

Get policy information for an iFolder.

virtual int GetEncryptionPolicy ()

Get the policy for an iFolder.

virtual bool GetSharingPolicy (string iFolderID)

evaluate the disable sharing policy for an iFolder

virtual int GetiFolderLimitPolicyStatus (string userID)

Get the ifolder limit policy for a User.

virtual void SetiFolderPolicy (iFolderPolicy policy)

Set the policy for an iFolder.

virtual iFolderEntry CreateEntry (string ifolderID, string parentID, iFolderEntryType type, string entryName)

Create an iFolder entry (file or directory).

virtual int CreateNodes (string ifolderID, bool RemoveEntry)

Create nodes for an iFolder.

virtual void DeleteEntry (string ifolderID, string entryID)

Delete an iFolder entry.

virtual iFolderEntry GetEntry (string ifolderID, string entryID)

Get information about an iFolder entry.

virtual iFolderEntry GetEntryByPath (string ifolderID, string entryPath)

Get information about an entry identified by it's relative path in the iFolder.

virtual iFolderEntrySet GetEntries (string ifolderID, string entryID, int index, int max)

Get information about entries in an iFolder identified by their parent entry.

virtual iFolderEntrySet GetEntriesByName (string ifolderID, string parentID, SearchOperation operation, string pattern, int index, int max)

Get information about entries in an iFolder identified by a search on the name.

virtual string GetSetting (string name)

Get a setting specific to the authenticated user.

virtual void SetSetting (string name, string value)

Set a setting specific to the authenticated user.

virtual string OpenFileRead (string ifolderID, string entryID)

Open an iFolder file entry for reading.

virtual string OpenFileWrite (string ifolderID, string entryID, long length)

Open an iFolder file entry for writing.

virtual byte[] ReadFile (string file, int size)

Read from an openned iFolder file entry.

virtual void WriteFile (string file, byte[] buffer)

Write to an openned iFolder file entry.

virtual void CloseFile (string file)

Close an openned iFolder file entry.

virtual void SetFileLength (string ifolderID, string nodeID, long length)

Protected Member Functions

override string GetAccessID ()

Get the access user's id.

override string GetUserID ()

Get the authenticated user's id.

override void Authorize ()

Authorize the authenticated user.

Detailed Description

iFolder Local Web Service

Member Enumeration Documentation

enum iFolder::WebService::iFolderWebLocal::Share

enum to store different disable sharing value

Constructor & Destructor Documentation

iFolder::WebService::iFolderWebLocal::iFolderWebLocal ( ) [inline]

Constructor.

Member Function Documentation

virtual void iFolder::WebService::iFolderWebLocal::SetMigratedFlag	(	string	iFolderID,
		int	MigrateionSource
	)			`[inline, virtual]`

Set the migrated flag for the iFolder to determine that the iFolder is a migrated one.

Parameters:

	ifolderID	The id of the iFolder.
	MigrationSource	Determines from which source the iFolder is migrated. (whther from iFolder2 server or 3.2 server or anyother

///

Returns:

Reimplemented in iFolder::WebService::iFolderWeb.

virtual iFolderSet iFolder::WebService::iFolderWebLocal::GetiFolders	(	int	index,
		int	max
	)			`[inline, virtual]`

Get information about all the iFolders to which the authenticate user has rights.

Parameters:

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

Returns:: A set of iFolder objects.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual iFolder iFolder::WebService::iFolderWebLocal::CreateiFolder	(	string	name,
		string	description,
		bool	ssl,
		string	encryptionAlgorithm,
		string	PassPhrase
	)			`[inline, virtual]`

Create a new iFolder with the authenticated user as the owner.

Parameters:

	name	The name of the new iFolder.
	description	The description of the new iFolder.

Returns:: An iFolder object describing the new iFolder.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual iFolderSet iFolder::WebService::iFolderWebLocal::GetiFoldersByName	(	SearchOperation	operation,
		string	pattern,
		int	index,
		int	max
	)			`[inline, virtual]`

Get information about iFolders identified by the search operation and pattern.

Parameters:

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

Returns:: A set of iFolder objects.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual bool iFolder::WebService::iFolderWebLocal::ShowTabDetails	(	string	PassPhrase,
		string	EncryptionAlgorithm
	)			`[inline, virtual]`

Whether the tab should be shown or not for encrypted folder

Parameters:

file

passphrase and encryptionalgo name

Reimplemented in iFolder::WebService::iFolderWeb.

virtual iFolderSet iFolder::WebService::iFolderWebLocal::GetiFoldersBySearch	(	MemberRole	role,
		DateTime	after,
		SearchOperation	operation,
		string	pattern,
		int	index,
		int	max
	)			`[inline, virtual]`

Get information about iFolder identified by role, creation time, and search operation and pattern.

Parameters:

	role	The required authenticated user's role in the Folder.
	after	The required earliest limit on the shared date of the iFolder.
	operation	The operation for the search.
	pattern	The pattern for the search.
	index	The starting index for the search results.
	max	The max number of search results to be returned.

Returns:: A set of iFolder objects.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual void iFolder::WebService::iFolderWebLocal::RemoveMembership ( string ifolderID ) [inline, virtual]

Remove the authenticated user's membership to an iFolder.

Parameters:

ifolderID

The id of the iFolder.

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

Reimplemented in iFolder::WebService::iFolderWeb.

virtual UserPolicy iFolder::WebService::iFolderWebLocal::GetAuthenticatedUserPolicy ( ) [inline, virtual]

Get policy information for the authenticated user.

Returns:: A UserPolicy object describing the authenticated user's policy.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual iFolderPolicy iFolder::WebService::iFolderWebLocal::GetiFolderPolicy ( string ifolderID ) [inline, virtual]

Get policy information for an iFolder.

Parameters:

ifolderID

The id of an iFolder.

Returns:: A iFolderPolicy object.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual int iFolder::WebService::iFolderWebLocal::GetEncryptionPolicy ( ) [inline, virtual]

Get the policy for an iFolder.

Parameters:

policy

The iFolderPolicy object.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual bool iFolder::WebService::iFolderWebLocal::GetSharingPolicy ( string iFolderID ) [inline, virtual]

evaluate the disable sharing policy for an iFolder

Returns:: an integer value which has disable sharing policy information

If on system level or user level, enforcement of policy is there, it means the iFolder must not be shared

it means, on iFolder Details page, admin had unchecked the box so sharing is enabled now

it means, on iFolder Details page, admin had checked the box so sharing is disabled

no iFolder level policy present , now if current user is not an owner , then check for system level policy if current user is owner of the iFolder, then check for user level and then for system level

it means, on User Details page, admin had unchecked the box so sharing is enabled now

it means, on User Details page, admin had checked the box so sharing is disabled

check for Group level policy as there was no user level or ifolder level policy applied No policy found on iFolder level or User level, no enforcement also, so follow group level

check for system level policy as there was no user level or ifolder level policy applied No policy found on iFolder level or User level, no enforcement also, so follow system level

virtual int iFolder::WebService::iFolderWebLocal::GetiFolderLimitPolicyStatus ( string userID ) [inline, virtual]

Get the ifolder limit policy for a User.

Parameters:

userID

The user id of the user who owns the ifolder.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual void iFolder::WebService::iFolderWebLocal::SetiFolderPolicy ( iFolderPolicy policy ) [inline, virtual]

Set the policy for an iFolder.

Parameters:

policy

The iFolderPolicy object.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual iFolderEntry iFolder::WebService::iFolderWebLocal::CreateEntry	(	string	ifolderID,
		string	parentID,
		iFolderEntryType	type,
		string	entryName
	)			`[inline, virtual]`

Create an iFolder entry (file or directory).

Parameters:

	ifolderID	The id of the iFolder.
	parentID	The id of the parent or containing entry.
	type	The type (file or directory for the entry.
	entryName	The name of the new entry.

Returns:: An iFolderEntry object describing the new entry.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual int iFolder::WebService::iFolderWebLocal::CreateNodes	(	string	ifolderID,
		bool	RemoveEntry
	)			`[inline, virtual]`

Create nodes for an iFolder.

Parameters:

ifolderID

The id of the iFolder.

Returns:: A boolean describing the status of creation of nodes.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual void iFolder::WebService::iFolderWebLocal::DeleteEntry	(	string	ifolderID,
		string	entryID
	)			`[inline, virtual]`

Delete an iFolder entry.

Parameters:

	ifolderID	The id of the iFolder.
	entryID	The id of the entry to be deleted.

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

Reimplemented in iFolder::WebService::iFolderWeb.

virtual iFolderEntry iFolder::WebService::iFolderWebLocal::GetEntry	(	string	ifolderID,
		string	entryID
	)			`[inline, virtual]`

Get information about an iFolder entry.

Parameters:

	ifolderID	The id of the iFolder containing the entry.
	entryID	The id of the entry.

Returns:: An iFolderEntry object.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual iFolderEntry iFolder::WebService::iFolderWebLocal::GetEntryByPath	(	string	ifolderID,
		string	entryPath
	)			`[inline, virtual]`

Get information about an entry identified by it's relative path in the iFolder.

Parameters:

	ifolderID	The id of the iFolder containing the entry.
	entryPath	The relative path of entry.

Returns:: An iFolderEntry object.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual iFolderEntrySet iFolder::WebService::iFolderWebLocal::GetEntries	(	string	ifolderID,
		string	entryID,
		int	index,
		int	max
	)			`[inline, virtual]`

Get information about entries in an iFolder identified by their parent entry.

Parameters:

	ifolderID	The id of the iFolder.
	entryID	The id of the parent entry (can be null for the root 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 iFolderEntry objects.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual iFolderEntrySet iFolder::WebService::iFolderWebLocal::GetEntriesByName	(	string	ifolderID,
		string	parentID,
		SearchOperation	operation,
		string	pattern,
		int	index,
		int	max
	)			`[inline, virtual]`

Get information about entries in an iFolder identified by a search on the name.

Parameters:

	ifolderID	The id of iFolder.
	parentID	The id of the parent entry.
	operation	The operation to compare the name and search 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 iFolderEntry objects.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual string iFolder::WebService::iFolderWebLocal::GetSetting ( string name ) [inline, virtual]

Get a setting specific to the authenticated user.

Parameters:

name

The name of the setting.

Returns:: The value of the setting.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual void iFolder::WebService::iFolderWebLocal::SetSetting	(	string	name,
		string	value
	)			`[inline, virtual]`

Set a setting specific to the authenticated user.

Parameters:

	name	The name of the setting.
	value	The value of the setting.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual string iFolder::WebService::iFolderWebLocal::OpenFileRead	(	string	ifolderID,
		string	entryID
	)			`[inline, virtual]`

Open an iFolder file entry for reading.

Parameters:

	ifolderID	The id of the iFolder.
	entryID	The id of the file entry.

Returns:: A file handle.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual string iFolder::WebService::iFolderWebLocal::OpenFileWrite	(	string	ifolderID,
		string	entryID,
		long	length
	)			`[inline, virtual]`

Open an iFolder file entry for writing.

Parameters:

	ifolderID	The id of the iFolder.
	entryID	The id of the file entry.
	length	The length of the file to be written.

Returns:: A file handle.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual byte [] iFolder::WebService::iFolderWebLocal::ReadFile	(	string	file,
		int	size
	)			`[inline, virtual]`

Read from an openned iFolder file entry.

Parameters:

	file	The file handle.
	size	The max size of the return buffer.

Returns:: An array of bytes.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual void iFolder::WebService::iFolderWebLocal::WriteFile	(	string	file,
		byte[]	buffer
	)			`[inline, virtual]`

Write to an openned iFolder file entry.

Parameters:

	file	The file handle.
	buffer	The buffer to be written.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual void iFolder::WebService::iFolderWebLocal::CloseFile ( string file ) [inline, virtual]

Close an openned iFolder file entry.

Parameters:

file

The file handle.

Reimplemented in iFolder::WebService::iFolderWeb.

virtual void iFolder::WebService::iFolderWebLocal::SetFileLength	(	string	ifolderID,
		string	nodeID,
		long	length
	)			`[inline, virtual]`

set the file length

Parameters:

file

The file handle.

Reimplemented in iFolder::WebService::iFolderWeb.

override string iFolder::WebService::iFolderWebLocal::GetAccessID ( ) [inline, protected, virtual]

Get the access user's id.

Implements iFolder::WebService::iFolderCommonLocal.

override string iFolder::WebService::iFolderWebLocal::GetUserID ( ) [inline, protected, virtual]

Get the authenticated user's id.

Implements iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderWebLocal::Authorize ( ) [inline, protected, virtual]

Authorize the authenticated user.

Implements iFolder::WebService::iFolderCommonLocal.

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

src/webservices/iFolderWebLocal.asmx.cs


Public Types
enum	Share
Public Member Functions
	iFolderWebLocal ()
	Constructor.
virtual void	SetMigratedFlag (string iFolderID, int MigrateionSource)
	Set the migrated flag for the iFolder to determine that the iFolder is a migrated one.
virtual iFolderSet	GetiFolders (int index, int max)
	Get information about all the iFolders to which the authenticate user has rights.
virtual iFolder	CreateiFolder (string name, string description, bool ssl, string encryptionAlgorithm, string PassPhrase)
	Create a new iFolder with the authenticated user as the owner.
virtual iFolderSet	GetiFoldersByName (SearchOperation operation, string pattern, int index, int max)
	Get information about iFolders identified by the search operation and pattern.
virtual bool	ShowTabDetails (string PassPhrase, string EncryptionAlgorithm)
virtual iFolderSet	GetiFoldersBySearch (MemberRole role, DateTime after, SearchOperation operation, string pattern, int index, int max)
	Get information about iFolder identified by role, creation time, and search operation and pattern.
virtual void	RemoveMembership (string ifolderID)
	Remove the authenticated user's membership to an iFolder.
virtual UserPolicy	GetAuthenticatedUserPolicy ()
	Get policy information for the authenticated user.
virtual iFolderPolicy	GetiFolderPolicy (string ifolderID)
	Get policy information for an iFolder.
virtual int	GetEncryptionPolicy ()
	Get the policy for an iFolder.
virtual bool	GetSharingPolicy (string iFolderID)
	evaluate the disable sharing policy for an iFolder
virtual int	GetiFolderLimitPolicyStatus (string userID)
	Get the ifolder limit policy for a User.
virtual void	SetiFolderPolicy (iFolderPolicy policy)
	Set the policy for an iFolder.
virtual iFolderEntry	CreateEntry (string ifolderID, string parentID, iFolderEntryType type, string entryName)
	Create an iFolder entry (file or directory).
virtual int	CreateNodes (string ifolderID, bool RemoveEntry)
	Create nodes for an iFolder.
virtual void	DeleteEntry (string ifolderID, string entryID)
	Delete an iFolder entry.
virtual iFolderEntry	GetEntry (string ifolderID, string entryID)
	Get information about an iFolder entry.
virtual iFolderEntry	GetEntryByPath (string ifolderID, string entryPath)
	Get information about an entry identified by it's relative path in the iFolder.
virtual iFolderEntrySet	GetEntries (string ifolderID, string entryID, int index, int max)
	Get information about entries in an iFolder identified by their parent entry.
virtual iFolderEntrySet	GetEntriesByName (string ifolderID, string parentID, SearchOperation operation, string pattern, int index, int max)
	Get information about entries in an iFolder identified by a search on the name.
virtual string	GetSetting (string name)
	Get a setting specific to the authenticated user.
virtual void	SetSetting (string name, string value)
	Set a setting specific to the authenticated user.
virtual string	OpenFileRead (string ifolderID, string entryID)
	Open an iFolder file entry for reading.
virtual string	OpenFileWrite (string ifolderID, string entryID, long length)
	Open an iFolder file entry for writing.
virtual byte[]	ReadFile (string file, int size)
	Read from an openned iFolder file entry.
virtual void	WriteFile (string file, byte[] buffer)
	Write to an openned iFolder file entry.
virtual void	CloseFile (string file)
	Close an openned iFolder file entry.
virtual void	SetFileLength (string ifolderID, string nodeID, long length)
Protected Member Functions
override string	GetAccessID ()
	Get the access user's id.
override string	GetUserID ()
	Get the authenticated user's id.
override void	Authorize ()
	Authorize the authenticated user.