iFolder::WebService::iFolderAdmin Class Reference

iFolder Admin Web Service More...

Inheritance diagram for iFolder::WebService::iFolderAdmin:

Inheritance graph
[legend]
Collaboration diagram for iFolder::WebService::iFolderAdmin:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 iFolderAdmin ()
 Constructor.
override iFolderSystem GetSystem ()
 Get information about the iFolder system.
override iFolderServer GetHomeServer ()
 Get information about the authenticated user's home iFolder server.
override string GetHomeServerForUser (string username, string password)
 Get the HomeServer for the specified user.
override string GetHomeServerURLForUserID (string userid)
 Get the HomeServer for the specified user using admin credential.
override bool IsUserOrSystemEncryptionEnforced (string userid)
 returns whether encryption is enforced for this user or not
override string GetiFolderLocation (string ifolderID)
 Get the HomeServer for the specified user.
override iFolderSet GetOrphanediFolders (SearchOperation operation, string pattern, int index, int max)
override int GetiFolderLimitPolicyStatus (string userID)
 Get the ifolder limit policy for a User.
override string IsOrphanediFolder (string iFolderID)
 check the Orphaned property
override string GetShortenedName (string name, int length)
 Shorten the name so that it can fit inot dispaly .
override bool IsGroupId (string userid)
 returns whether the id is a group id or not
override int GetSharingStatus (string iFolderID)
 evaluate the disable sharing policy for an iFolder
override void DisableSystemPastSharing ()
 DisablePast Sharing for the system.
override void DisableUserPastSharing (string UserID)
 DisablePastSharing for an user.
override void DisableiFolderPastSharing (string iFolderID)
 Disable Past Sharing for an iFolder.
override int AddDataStore (string datapathname, string fullpath, string ServerID)
 Add a data store for an iFolder Server.
virtual bool ModifyDataStore (string datapathname, bool enabled)
 Modify data store for an iFolder Server.
virtual bool DeleteDataStore (string datapathname)
 Delete data store for an iFolder Server.
override VolumesList GetVolumes (int index, int max)
 Gets all the data store for an iFolder Server.
override string[] GetReports ()
 Get the HomeServer for the specified user.
override iFolderServer GetServer (string serverID)
 Get information about an iFolder Server.
override iFolderServer[] GetServers ()
 Get information about all the iFolder servers.
override iFolderServerSet GetServersByName (SearchOperation operation, string pattern, int index, int count)
 Get information about iFolder Servers identified by a search on name.
override void DeleteiFolder (string ifolderID)
 Delete an iFolder.
override iFolder GetiFolder (string ifolderID)
 Get information about an iFolder.
override iFolderDetails GetiFolderDetails (string ifolderID)
 Get detailed information about an iFolder.
override void SetiFolderDescription (string ifolderID, string description)
 Set the description of an iFolder.
override void PublishiFolder (string ifolderID, bool publish)
 Publish an iFolder.
override ChangeEntrySet GetChanges (string ifolderID, string itemID, int index, int max)
 Get a history of changes to an iFolder.
override string TrimUrl (string FullUrl)
 Get a trimmed url from full url.
override iFolderUser GetAuthenticatedUser ()
 Get information about the authenticated user.
override void SetMemberRights (string ifolderID, string userID, Rights rights)
 Set the rights of a member on an iFolder.
override void AddMember (string ifolderID, string userID, Rights rights)
 Add a member to an iFolder.
override void RemoveMember (string ifolderID, string userID)
 Remove a member from an iFolder.
override void SetiFolderOwner (string ifolderID, string userID, bool OrphanAdopt)
 Set the owner of an iFolder.
override iFolderUserSet GetMembers (string ifolderID, int index, int max)
 Get information about the members of an iFolder.
override bool IsPassPhraseSetForUser (string userID)
 check whether passphrase is set for a particular user.
override iFolderUserSet GetUsers (int index, int max)
 Get information about all of the iFolder users.
override void ProvisionUsersToServers (string[] ServerNames, string[] UserIDs)
 Provision the users to servers.
override void ProvisionUsersToServer (string ServerName, string[] ListOfUsers)
 Provision the users to a server.
override string[] GetServerProvisioningList ()
 Get the list of servers.
override string GetSimiasRequiresSSLStatus ()
 Get the simiasserverrequiressl status.
override bool SetIPDetails (string privateIP, string publicIP, string MastersIP)
override iFolderUser GetUser (string userID)
 Get information about a user using an id or username.
override iFolderUserDetails GetUserDetails (string userID)
 Get detailed information about a user.
override 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.
override iFolderUserSet GetReprovisionUsers (int index, int max)
 Get information about all of the iFolder users with DATA move property set.
override iFolder CreateiFolder (string name, string userID, string description)
 Create a new iFolder.
override iFolder CreateiFolderWithID (string name, string userID, string description, string iFolderID)
 Create a new iFolder with given ID.
override iFolderSet GetiFolders (iFolderType type, int index, int max)
 Get inforamtion about all iFolders.
override iFolderSet GetiFoldersByMember (string userID, MemberRole role, int index, int max)
 Get information about all iFolders identified by a member.
override iFolderSet GetiFoldersByName (SearchOperation operation, string pattern, int index, int count)
 Get information about all iFolders identified by a search on the it's name.
override string GetSystemSetting (string name)
 Get a setting global to the system.
override void SetSystemSetting (string name, string value)
 Set a setting global to the system.
override string GetUserSetting (string userID, string name)
 Get a setting specific to a user.
override void SetUserSetting (string userID, string name, string value)
 Set a setting specific to a user.
override string GetiFolderSetting (string ifolderID, string name)
 Get a setting specific to an iFolder.
override void SetiFolderSetting (string ifolderID, string name, string value)
 Set a setting specific to an iFolder.
override iFolderUser CreateUser (string username, string password, string guid, string firstName, string lastName, string fullName, string dn, string email)
 Create a new user in the iFolder system.
override bool DeleteUser (string userID)
 Delete a user from the iFolder system.
override iFolderUser SetUser (string userID, iFolderUser user)
 Update a user in the iFolder system.
override bool SetPassword (string userID, string password)
 Set a user's password.
override void SetSystem (iFolderSystem system)
 Update the editable information for the iFolder system.
override bool SetSimiasSSLStatus (string SimiasSSLStatus)
 Update the ssl information for the iFolder system.
override void AddAdministrator (string userID)
 Grant a user system administration rights.
override void RemoveAdministrator (string userID)
 Revoke system administration rights from a user.
override iFolderUserSet GetAdministrators (int index, int max)
 Get information about all the administrators.
override SystemPolicy GetSystemPolicy ()
 Get policy information for the system.
override int GetGroupSharingPolicy (string userID)
 Get policy information for Group.
override int GetGroupEncryptionPolicy (string userID)
 Get Encryption policy information for Group.
override void SetSystemPolicy (SystemPolicy policy)
 Set policy for the iFolder system.
override UserPolicy GetUserPolicy (string userID)
 Get policy information for a user.
override void SetUserPolicy (UserPolicy policy)
 Set the policy for a user.
override iFolderPolicy GetiFolderPolicy (string ifolderID)
 Get policy information for an iFolder.
override void SetiFolderPolicy (iFolderPolicy policy)
 Set the policy for an iFolder.
override IdentityPolicy GetIdentityPolicy ()
 Get policy information for the registered identity provider.
override void IdentitySyncDisableService (bool disable)
 Disables/enables the identity synchronization service. true - disables false - enables the synchronization service Note! once enabled the service will enter a synchronization cycle ignoring the configured sync interval time.
override LastSyncInfo IdentitySyncGetLastInfo ()
 Get detailed information about the last synchronization cycle.
override SyncServiceInfo IdentitySyncGetServiceInfo ()
 Get the current status of the identity sync service thread. status could be: Disabled Working Waiting Authentication Failure etc..
override void IdentitySyncSetDeleteMemberGracePeriod (int seconds)
 Method to set the grace period a member is given before they are removed from the domain. Members are disabled during this grace period. Represented in seconds.
override void IdentitySyncSetInterval (int seconds)
 Method to set the synchronization interval for the sync engine. Represented in seconds.
override void IdentitySyncNow ()
 Tells the sync service to immediately start a synchronization cycle.
override string[] GetLogLevels ()
 Get the loglevels set in Simias.log4net.
override void SetLogLevel (iFolderServer.LoggerType type, string logLevel)
 Get the loglevels set in Simias.log4net.
override LdapInfo GetLdapDetails ()
 Get information about a user using an id or username.
override void SetLdapDetails (LdapInfo ldapInfo, string LdapAdminDN, string LdapAdminPwd, string ServerID)
 Set information about a user using an id or username.

Detailed Description

iFolder Admin Web Service

Constructor & Destructor Documentation

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

Constructor.

Member Function Documentation

override iFolderSystem iFolder::WebService::iFolderAdmin::GetSystem (  )  [inline, virtual]

Get information about the iFolder system.

Returns:
An iFolderSystem object describing the system.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override iFolderServer iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

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

Get the HomeServer for the specified user.

Returns:
HomeServer ID

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override string iFolder::WebService::iFolderAdmin::GetHomeServerURLForUserID ( string  userid  )  [inline, virtual]

Get the HomeServer for the specified user using admin credential.

Returns:
HomeServer ID

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override bool iFolder::WebService::iFolderAdmin::IsUserOrSystemEncryptionEnforced ( string  userid  )  [inline, virtual]

returns whether encryption is enforced for this user or not

Returns:
true/false

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override string iFolder::WebService::iFolderAdmin::GetiFolderLocation ( string  ifolderID  )  [inline, virtual]

Get the HomeServer for the specified user.

Returns:
HomeServer ID

Reimplemented from iFolder::WebService::iFolderCommonLocal.

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

Get the Orphaned ifolders

Returns:
a list of orphaned ifolders

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override int iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderAdminLocal.

override string iFolder::WebService::iFolderAdmin::IsOrphanediFolder ( string  iFolderID  )  [inline, virtual]

check the Orphaned property

Returns:
a string value

Reimplemented from iFolder::WebService::iFolderCommonLocal.

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

Shorten the name so that it can fit inot dispaly .

Parameters:
name The name of the iFolder to be shortened.
Returns:
< string which is short.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override bool iFolder::WebService::iFolderAdmin::IsGroupId ( string  userid  )  [inline, virtual]

returns whether the id is a group id or not

Returns:
bool

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override int iFolder::WebService::iFolderAdmin::GetSharingStatus ( string  iFolderID  )  [inline, virtual]

evaluate the disable sharing policy for an iFolder

Returns:
an integer value which has disable sharing policy information

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderAdmin::DisableSystemPastSharing (  )  [inline, virtual]

DisablePast Sharing for the system.

Returns:
No return value

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderAdmin::DisableUserPastSharing ( string  UserID  )  [inline, virtual]

DisablePastSharing for an user.

Returns:
No return value

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderAdmin::DisableiFolderPastSharing ( string  iFolderID  )  [inline, virtual]

Disable Past Sharing for an iFolder.

Returns:
No return value

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override int iFolder::WebService::iFolderAdmin::AddDataStore ( string  datapathname,
string  fullpath,
string  ServerID 
) [inline, virtual]

Add a data store for an iFolder Server.

Parameters:
DataPathname The name of the data store.
FullPath The Full Path of the data store.
serverID Server ID of the server
Returns:
Integer : 0 on success.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

virtual bool iFolder::WebService::iFolderAdmin::ModifyDataStore ( string  datapathname,
bool  enabled 
) [inline, virtual]

Modify data store for an iFolder Server.

Parameters:
name The name of the data store.
Returns:
Bool true on success.

virtual bool iFolder::WebService::iFolderAdmin::DeleteDataStore ( string  datapathname  )  [inline, virtual]

Delete data store for an iFolder Server.

Parameters:
name The name of the data store.
Returns:
Bool true on success.

override VolumesList iFolder::WebService::iFolderAdmin::GetVolumes ( int  index,
int  max 
) [inline, virtual]

Gets all the data store for an iFolder Server.

Returns:
An array of DataPaths.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override string [] iFolder::WebService::iFolderAdmin::GetReports (  )  [inline, virtual]

Get the HomeServer for the specified user.

Returns:
HomeServer ID

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override iFolderServer iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override iFolderServer [] iFolder::WebService::iFolderAdmin::GetServers (  )  [inline, virtual]

Get information about all the iFolder servers.

Returns:
An array of iFolderServer objects.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override iFolderServerSet iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override iFolder iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override iFolderDetails iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override ChangeEntrySet iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override string iFolder::WebService::iFolderAdmin::TrimUrl ( string  FullUrl  )  [inline, virtual]

Get a trimmed url from full url.

Parameters:
FullUrl Full URL to be called
Returns:
a trimmed url that will contain only aspx page name

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override iFolderUser iFolder::WebService::iFolderAdmin::GetAuthenticatedUser (  )  [inline, virtual]

Get information about the authenticated user.

Returns:
An iFolderUser object describing the authenticated user.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override iFolderUserSet iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override bool iFolder::WebService::iFolderAdmin::IsPassPhraseSetForUser ( string  userID  )  [inline, virtual]

check whether passphrase is set for a particular user.

Parameters:
userID The id of the user.
Returns:
A Bool value.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override iFolderUserSet iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

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

Provision the users to servers.

Parameters:
ServerNames A string array containing server names
UserIDs A string array containing corresponding userids
Returns:
No Return value

Reimplemented from iFolder::WebService::iFolderCommonLocal.

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

Provision the users to a server.

Parameters:
ServerName A string containing server's name.
ListOfUsers An array of string containing userIDs
Returns:
No Return value

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override string [] iFolder::WebService::iFolderAdmin::GetServerProvisioningList (  )  [inline, virtual]

Get the list of servers.

Returns:
a string array of all the server names

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override string iFolder::WebService::iFolderAdmin::GetSimiasRequiresSSLStatus (  )  [inline, virtual]

Get the simiasserverrequiressl status.

Returns:
a string

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override bool iFolder::WebService::iFolderAdmin::SetIPDetails ( string  privateIP,
string  publicIP,
string  MastersIP 
) [inline, virtual]

set the new IP addresses.

Returns:
bool value based on success/failure

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override iFolderUser iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override iFolderUserDetails iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override iFolderUserSet iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override iFolderUserSet iFolder::WebService::iFolderAdmin::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 from iFolder::WebService::iFolderCommonLocal.

override iFolder iFolder::WebService::iFolderAdmin::CreateiFolder ( string  name,
string  userID,
string  description 
) [inline, virtual]

Create a new iFolder.

Parameters:
name The name of the new iFolder.
userID The user id of the owner of the new iFolder.
description The description of the new iFolder (can be null).
Returns:
An iFolder object describing the new iFolder.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override iFolder iFolder::WebService::iFolderAdmin::CreateiFolderWithID ( string  name,
string  userID,
string  description,
string  iFolderID 
) [inline, virtual]

Create a new iFolder with given ID.

Parameters:
name The name of the new iFolder.
userID The user id of the owner of the new iFolder.
description The description of the new iFolder (can be null).
Returns:
An iFolder object describing the new iFolder.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override iFolderSet iFolder::WebService::iFolderAdmin::GetiFolders ( iFolderType  type,
int  index,
int  max 
) [inline, virtual]

Get inforamtion about all iFolders.

Parameters:
type An iFolder type filter of the results.
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 from iFolder::WebService::iFolderAdminLocal.

override iFolderSet iFolder::WebService::iFolderAdmin::GetiFoldersByMember ( string  userID,
MemberRole  role,
int  index,
int  max 
) [inline, virtual]

Get information about all iFolders identified by a member.

Parameters:
userID The user id of the member.
role The member's role in the iFolder.
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 from iFolder::WebService::iFolderAdminLocal.

override iFolderSet iFolder::WebService::iFolderAdmin::GetiFoldersByName ( SearchOperation  operation,
string  pattern,
int  index,
int  count 
) [inline, virtual]

Get information about all iFolders identified by a search on the it's 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 objects.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override string iFolder::WebService::iFolderAdmin::GetSystemSetting ( string  name  )  [inline, virtual]

Get a setting global to the system.

Parameters:
name The name of the setting.
Returns:
The value of the setting.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override void iFolder::WebService::iFolderAdmin::SetSystemSetting ( string  name,
string  value 
) [inline, virtual]

Set a setting global to the system.

Parameters:
name The name of the setting.
value The value of the setting.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override string iFolder::WebService::iFolderAdmin::GetUserSetting ( string  userID,
string  name 
) [inline, virtual]

Get a setting specific to a user.

Parameters:
userID The id of the user.
name The name of the setting.
Returns:
The value of the setting.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override void iFolder::WebService::iFolderAdmin::SetUserSetting ( string  userID,
string  name,
string  value 
) [inline, virtual]

Set a setting specific to a user.

Parameters:
userID The id of the user.
name The name of the setting.
value The value of the setting.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override string iFolder::WebService::iFolderAdmin::GetiFolderSetting ( string  ifolderID,
string  name 
) [inline, virtual]

Get a setting specific to an iFolder.

Parameters:
ifolderID The id of the iFolder.
name The name of the setting.
Returns:
The value of the setting.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override void iFolder::WebService::iFolderAdmin::SetiFolderSetting ( string  ifolderID,
string  name,
string  value 
) [inline, virtual]

Set a setting specific to an iFolder.

Parameters:
ifolderID The id of the iFolder.
name The name of the setting.
value The value of the setting.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override iFolderUser iFolder::WebService::iFolderAdmin::CreateUser ( string  username,
string  password,
string  guid,
string  firstName,
string  lastName,
string  fullName,
string  dn,
string  email 
) [inline, virtual]

Create a new user in the iFolder system.

Parameters:
username A short unique name for the user (required).
password The password for the user (required).
guid A GUID for the user (optional).
firstName The first/given name of the user (optional).
lastName The last/family name of the user (optional).
fullName The full name of the user (optional).
dn The distinguished name, from an external identity store, for the user (optional).
email The primary email address of the user (optional).
Returns:
An iFolderUser object describing the new user.

Some identity providers DO NOT allow the creation, modification or deletion of new users.

If the firstName and lastName are specified but the fullName is null, the fullName is created with the firstName and lastName.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override bool iFolder::WebService::iFolderAdmin::DeleteUser ( string  userID  )  [inline, virtual]

Delete a user from the iFolder system.

Parameters:
userID The ID of the user to be deleted.

Some identity providers DO NOT allow the creation, modification or deletion of new users.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override iFolderUser iFolder::WebService::iFolderAdmin::SetUser ( string  userID,
iFolderUser  user 
) [inline, virtual]

Update a user in the iFolder system.

Parameters:
userID The ID of the user to be updated.
user The update iFolderUser object (FullName, FirstName, LastName, Email).

Some identity providers DO NOT allow the creation, modification or deletion of new users.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override bool iFolder::WebService::iFolderAdmin::SetPassword ( string  userID,
string  password 
) [inline, virtual]

Set a user's password.

Parameters:
userID The username of the user.
password The new password for the user.

Some identity providers DO NOT allow the creation, modification or deletion of new users.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override void iFolder::WebService::iFolderAdmin::SetSystem ( iFolderSystem  system  )  [inline, virtual]

Update the editable information for the iFolder system.

Parameters:
system The update iFolderSystem object (Name, Description).

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override bool iFolder::WebService::iFolderAdmin::SetSimiasSSLStatus ( string  SimiasSSLStatus  )  [inline, virtual]

Update the ssl information for the iFolder system.

Parameters:
SimiasSSLStatus The updated ssl info as string (ssl/nonssl/both)

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override void iFolder::WebService::iFolderAdmin::AddAdministrator ( string  userID  )  [inline, virtual]

Grant a user system administration rights.

Parameters:
userID The id of user.
A user is an administrator if the user has "Admin" rights in the domain. This API will accept multiple user ids in a comma delimited list.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override void iFolder::WebService::iFolderAdmin::RemoveAdministrator ( string  userID  )  [inline, virtual]

Revoke system administration rights from a user.

Parameters:
userID The user id of the administrator.
Administration rights are removed by the user having "ReadOnly" rights in the domain. This API will accept multiple user ids in a comma delimited list.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override iFolderUserSet iFolder::WebService::iFolderAdmin::GetAdministrators ( int  index,
int  max 
) [inline, virtual]

Get information about all the administrators.

Parameters:
index The starting index for the search results.
max The max number of search results to be returned.
A user is an administrator if the user has "Admin" rights in the domain.
Returns:
An array of iFolderUser objects describing the administrators.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override SystemPolicy iFolder::WebService::iFolderAdmin::GetSystemPolicy (  )  [inline, virtual]

Get policy information for the system.

Returns:
A SystemPolicy object.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override int iFolder::WebService::iFolderAdmin::GetGroupSharingPolicy ( string  userID  )  [inline, virtual]

Get policy information for Group.

Returns:
A integer value of user's group objects sharing policy object.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override int iFolder::WebService::iFolderAdmin::GetGroupEncryptionPolicy ( string  userID  )  [inline, virtual]

Get Encryption policy information for Group.

Returns:
A integer value of user's group objects Encryption policy object.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override void iFolder::WebService::iFolderAdmin::SetSystemPolicy ( SystemPolicy  policy  )  [inline, virtual]

Set policy for the iFolder system.

Parameters:
policy The SystemPolicy object.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override UserPolicy iFolder::WebService::iFolderAdmin::GetUserPolicy ( string  userID  )  [inline, virtual]

Get policy information for a user.

Parameters:
userID A id of user.
Returns:
A UserPolicy object.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override void iFolder::WebService::iFolderAdmin::SetUserPolicy ( UserPolicy  policy  )  [inline, virtual]

Set the policy for a user.

Parameters:
policy The UserPolicy object.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

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

Get policy information for an iFolder.

Parameters:
ifolderID The id of an iFolder.
Returns:
A iFolderPolicy object.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

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

Set the policy for an iFolder.

Parameters:
policy The iFolderPolicy object.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override IdentityPolicy iFolder::WebService::iFolderAdmin::GetIdentityPolicy (  )  [inline, virtual]

Get policy information for the registered identity provider.

Returns:
An IdentityPolicy object.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override LastSyncInfo iFolder::WebService::iFolderAdmin::IdentitySyncGetLastInfo (  )  [inline, virtual]

Get detailed information about the last synchronization cycle.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override SyncServiceInfo iFolder::WebService::iFolderAdmin::IdentitySyncGetServiceInfo (  )  [inline, virtual]

Get the current status of the identity sync service thread. status could be: Disabled Working Waiting Authentication Failure etc..

Returns:
current status as SyncServiceInfo object

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override void iFolder::WebService::iFolderAdmin::IdentitySyncSetDeleteMemberGracePeriod ( int  seconds  )  [inline, virtual]

Method to set the grace period a member is given before they are removed from the domain. Members are disabled during this grace period. Represented in seconds.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override void iFolder::WebService::iFolderAdmin::IdentitySyncSetInterval ( int  seconds  )  [inline, virtual]

Method to set the synchronization interval for the sync engine. Represented in seconds.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

override LdapInfo iFolder::WebService::iFolderAdmin::GetLdapDetails (  )  [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 from iFolder::WebService::iFolderAdminLocal.

override void iFolder::WebService::iFolderAdmin::SetLdapDetails ( LdapInfo  ldapInfo,
string  LdapAdminDN,
string  LdapAdminPwd,
string  ServerID 
) [inline, virtual]

Set information about a user using an id or username.

Parameters:
userID The id or username of the user.
Returns:
A iFolderUser object.

Reimplemented from iFolder::WebService::iFolderAdminLocal.

The documentation for this class was generated from the following file:
Generated on Wed Apr 8 14:42:37 2009 for simias by  doxygen 1.5.6