iFolder::WebService::iFolderAdminLocal Class Reference

iFolder Admin Local Web Service More...

Inheritance diagram for iFolder::WebService::iFolderAdminLocal:

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

Collaboration graph
[legend]

List of all members.

Public Types

enum  Share
 enum to store different disable sharing value

Public Member Functions

 iFolderAdminLocal ()
 Constructor.
virtual iFolder CreateiFolder (string name, string userID, string description)
 Create a new iFolder.
virtual iFolder CreateiFolderWithID (string name, string userID, string description, string iFolderID)
 Create a new iFolder with a given ID.
virtual iFolderSet GetiFolders (iFolderType type, int index, int max)
 Get inforamtion about all iFolders.
virtual iFolderSet GetiFoldersByMember (string userID, MemberRole role, int index, int max)
 Get information about all iFolders identified by a member.
virtual iFolderSet GetiFoldersByName (SearchOperation operation, string pattern, int index, int count)
 Get information about all iFolders identified by a search on the it's name.
virtual string GetSystemSetting (string name)
 Get a setting global to the system.
virtual void SetSystemSetting (string name, string value)
 Set a setting global to the system.
virtual string GetUserSetting (string userID, string name)
 Get a setting specific to a user.
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 SetUserSetting (string userID, string name, string value)
 Set a setting specific to a user.
virtual string GetiFolderSetting (string ifolderID, string name)
 Get a setting specific to an iFolder.
virtual void SetiFolderSetting (string ifolderID, string name, string value)
 Set a setting specific to an iFolder.
virtual 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.
virtual bool DeleteUser (string userID)
 Delete a user from the iFolder system.
virtual iFolderUser SetUser (string userID, iFolderUser user)
 Update a user in the iFolder system.
virtual bool SetPassword (string userID, string password)
 Set a user's password.
virtual bool IsPassPhraseSetForUser (string userID)
 return whether passphrase is set for that user.
virtual void SetSystem (iFolderSystem system)
 Update the editable information for the iFolder system.
virtual bool SetSimiasSSLStatus (string SimiasSSLValue)
 Update the ssl value for the system.
virtual void AddAdministrator (string userID)
 Grant a user system administration rights.
virtual void RemoveAdministrator (string userID)
 Revoke system administration rights from a user.
virtual iFolderUserSet GetAdministrators (int index, int max)
 Get information about all the administrators.
virtual int GetGroupEncryptionPolicy (string userID)
 Get Encryption policy information for Group.
virtual int GetGroupSharingPolicy (string userID)
 Get policy information for Group.
virtual SystemPolicy GetSystemPolicy ()
 Get policy information for the system.
virtual void SetSystemPolicy (SystemPolicy policy)
 Set policy for the iFolder system.
virtual int GetUserGroupSharingPolicy (string ownerID)
 Get policy information for a user.
virtual UserPolicy GetUserPolicy (string userID)
 Get policy information for a user.
virtual void SetUserPolicy (UserPolicy policy)
 Set the policy for a user.
virtual iFolderPolicy GetiFolderPolicy (string ifolderID)
 Get policy information for an iFolder.
virtual void SetiFolderPolicy (iFolderPolicy policy)
 Set the policy for an iFolder.
virtual IdentityPolicy GetIdentityPolicy ()
 Get policy information for the registered identity provider.
virtual 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.
virtual LastSyncInfo IdentitySyncGetLastInfo ()
 Get detailed information about the last synchronization cycle.
virtual SyncServiceInfo IdentitySyncGetServiceInfo ()
 Get the current status of the identity sync service thread. status could be: Disabled Working Waiting Authentication Failure etc..
virtual 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.
virtual void IdentitySyncSetInterval (int seconds)
 Method to set the synchronization interval for the sync engine. Represented in seconds.
virtual void IdentitySyncNow ()
 Tells the sync service to immediately start a synchronization cycle.
virtual string[] GetLogLevels ()
 Get LogLevel Information.
virtual int AddDataStore (string datapathname, string fullpath, string ServerID)
 Add a data path for an iFolder Server.
virtual bool ModifyStore (string datapathname, bool enabled)
 Modify data store for an iFolder Server.
virtual bool DeleteDataPath (string datapathname)
 Delete data store for an iFolder Server.
virtual VolumesList GetVolumes (int index, int max)
 Gets an array of datastore of an iFolder Server.
virtual void SetLogLevel (iFolderServer.LoggerType type, string logLevel)
 Set LogLevel Information.
virtual LdapInfo GetLdapDetails ()
 Get log level information.
virtual string GetSimiasRequiresSSLStatus ()
 Getsimiasrequiressl info.
virtual void SetLdapDetails (LdapInfo ldapInfo, string LdapAdminDN, string LdapAdminPwd, string ServerID)
 Get LogLevel Information.
virtual bool SetIPDetails (string privateIP, string publicIP, string MastersIP)

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 Admin Local Web Service


Constructor & Destructor Documentation

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

Constructor.


Member Function Documentation

virtual iFolder iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

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

Create a new iFolder with a 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 in iFolder::WebService::iFolderAdmin.

virtual iFolderSet iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

virtual iFolderSet iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

virtual iFolderSet iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

virtual string iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

virtual void iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

virtual string iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

virtual bool iFolder::WebService::iFolderAdminLocal::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::iFolderAdminLocal::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::iFolderAdmin.

virtual void iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

virtual string iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

virtual void iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

virtual iFolderUser iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

virtual bool iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

virtual iFolderUser iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

virtual bool iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

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

return whether passphrase is set for that user.

Parameters:
userID The id of the user.

Reimplemented in iFolder::WebService::iFolderAdmin.

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

Update the editable information for the iFolder system.

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

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual bool iFolder::WebService::iFolderAdminLocal::SetSimiasSSLStatus ( string  SimiasSSLValue  )  [inline, virtual]

Update the ssl value for the system.

Parameters:
system The update iFolderSystem object (SSL value will be used only).

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual void iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

virtual void iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

virtual iFolderUserSet iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

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

Get Encryption policy information for Group.

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

Reimplemented in iFolder::WebService::iFolderAdmin.

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

Get policy information for Group.

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

Reimplemented in iFolder::WebService::iFolderAdmin.

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

Get policy information for the system.

Returns:
A SystemPolicy object.

Reimplemented in iFolder::WebService::iFolderAdmin.

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

Set policy for the iFolder system.

Parameters:
policy The SystemPolicy object.

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual int iFolder::WebService::iFolderAdminLocal::GetUserGroupSharingPolicy ( string  ownerID  )  [inline, virtual]

Get policy information for a user.

Parameters:
userID A id of user.
Returns:
A Group Policy status object.

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

Get policy information for a user.

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

Reimplemented in iFolder::WebService::iFolderAdmin.

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

Set the policy for a user.

Parameters:
policy The UserPolicy object.

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual iFolderPolicy iFolder::WebService::iFolderAdminLocal::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::iFolderAdmin.

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

Set the policy for an iFolder.

Parameters:
policy The iFolderPolicy object.

Reimplemented in iFolder::WebService::iFolderAdmin.

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

Get policy information for the registered identity provider.

Returns:
An IdentityPolicy object.

Reimplemented in iFolder::WebService::iFolderAdmin.

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

Get detailed information about the last synchronization cycle.

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual void iFolder::WebService::iFolderAdminLocal::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 in iFolder::WebService::iFolderAdmin.

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

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

Reimplemented in iFolder::WebService::iFolderAdmin.

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

Add a data path 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 in iFolder::WebService::iFolderAdmin.

virtual bool iFolder::WebService::iFolderAdminLocal::ModifyStore ( 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::iFolderAdminLocal::DeleteDataPath ( string  datapathname  )  [inline, virtual]

Delete data store for an iFolder Server.

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

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

Gets an array of datastore of an iFolder Server.

Returns:
Bool true on success.

Reimplemented in iFolder::WebService::iFolderAdmin.

virtual LdapInfo iFolder::WebService::iFolderAdminLocal::GetLdapDetails (  )  [inline, virtual]

Get log level information.

Returns:
ldap info object containing all informations, null if unsuccessful

Reimplemented in iFolder::WebService::iFolderAdmin.

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

Getsimiasrequiressl info.

Returns:
string representing SimiasRequiresSSL value is set into config file

Reimplemented in iFolder::WebService::iFolderAdmin.

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

Get LogLevel Information.

Reimplemented in iFolder::WebService::iFolderAdmin.

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

sets new IP

Returns:
true if successful

Reimplemented in iFolder::WebService::iFolderAdmin.

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

Get the access user's id.

Implements iFolder::WebService::iFolderCommonLocal.

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

Get the authenticated user's id.

Implements iFolder::WebService::iFolderCommonLocal.

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

Authorize the authenticated user.

Implements iFolder::WebService::iFolderCommonLocal.


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

Generated on Wed Apr 8 14:42:41 2009 for simias by  doxygen 1.5.6