Autodesk FDO Data Management Utility API Reference

Autodesk FDO Data Management Utility

API Reference Autodesk FDO Data Management Utility

FdoUserManager Class Reference

List of all members.

Detailed Description

Definition at line 41 of file FdoUserManager.h.

Public Member Functions

virtual FDOUSERMGR_API void AddUser (FdoString *name, FdoString *password)=0
 Adds a new user to the RDBMS. <>
Parameters:
name Input the user name
password Input the user's password
Returns:
Returns nothing <.

virtual FDOUSERMGR_API void ApplyWindowsUser (FdoString *domain, FdoString *name)=0
 Supported by SQL Server. Adds a Windows user to the server. <>
Parameters:
domain Input the Windows domain name
name Input the user name
Returns:
Returns nothing <.

virtual FDOUSERMGR_API void AssignRoleOrPrivilege (FdoString *name, FdoString *roleOrPrivilege)=0
 Supported by Oracle and MySQL. Assigns a role to the specified user. In MySQL this assigns the role to the specified user in all datastores.<>
Parameters:
name Input the user name
roleOrPrivilege Input the role name.
Returns:
Returns nothing <.

virtual FDOUSERMGR_API void DropUser (FdoString *name)=0
 Removes a user from the RDBMS. <>
Parameters:
name Input the user name
Returns:
Returns nothing <.

virtual FDOUSERMGR_API FdoStringCollection * GetDatastores (bool bIncludeNonFdoEnabledDatastores=false)
 Gets the list of the datastores. <>
Returns:
Returns the list of datastores <.

virtual FDOUSERMGR_API FdoDbUserReaderGetDbUsers (FdoString *datastore)=0
 Supported by SQL Server and MySQL. Gets a reader over the users of a specific datastore. <>
Parameters:
datastore Input the datastore name
Returns:
Returns the reader <.

virtual FDOUSERMGR_API FdoDbUserReaderGetDbUsers ()=0
 Gets a reader over all RDBMS users. <>
Returns:
Returns the reader <.

virtual FDOUSERMGR_API FdoStringCollection * GetRolesOrPrivileges ()=0
 Gets the list of supported Roles or Privileges. <>
Returns:
Returns the list of supported Roles or Privileges. <.

virtual FDOUSERMGR_API void GrantAccessToDatastore (FdoString *name, FdoString *datastore, FdoString *roleOrPrivilege)=0
 Supported by SQL Server and MySQL. Grants access to a datastore with the specified privilege. <>
Parameters:
name Input the user name
datastore Input the datastore name
roleOrPrivilege Input the privilege name.
Returns:
Returns nothing <.

virtual FDOUSERMGR_API void GrantAccessToDatastore (FdoString *name, FdoString *datastore)=0
 Supported by SQL Server and MySQL. Grants explicit access to a datastore with the default privileges. <>
Parameters:
name Input the user name
datastore Input the datastore name
Returns:
Returns nothing <.

virtual FDOUSERMGR_API void RevokeAccessToDatastore (FdoString *name, FdoString *datastore, FdoString *roleOrPrivilege)=0
 Supported by SQL Server and MySQL. Revokes an access privilege against a datastore. If roleOrPrivilege is set to '*', all roles or privileges are revoked from the specified user; on SQL Server this will also remove the user from that datastore.<>
Parameters:
name Input the user name
datastore Input the datastore name
roleOrPrivilege Input the privilege name.
Returns:
Returns nothing <.

virtual FDOUSERMGR_API void RevokeRoleOrPrivilege (FdoString *name, FdoString *roleOrPrivilege)=0
 Supported by Oracle and MySQL. Revokes a role from the specified user. In MySQL this revokes the role from the specified user in all datastores.<>
Parameters:
name Input the user name
roleOrPrivilege Input the role name.
Returns:
Returns nothing <.

virtual FDOUSERMGR_API bool SupportsDatastoreGrants ()=0
 SQL Server and MySQL use explicit grants to datastores. <>
Returns:
Returns true if the RDBMS use explicit grants <.

virtual FDOUSERMGR_API bool SupportsWindowsAuthentication ()=0
 SQL Server can use Windows authenticated users. <>
Returns:
Returns true if the RDBMS use Windows authenticated users.<.


Static Public Member Functions

static FDOUSERMGR_API FdoUserManagerCreate (FdoIConnection *connection)
 Creates an instance of this class that can be used to dynamically manage the users of a datasource. <>
Parameters:
connection Input the connection
Returns:
Returns an instance of this class <.


Protected Member Functions

virtual void Dispose ()
 FdoUserManager ()

Protected Attributes

FdoIConnection * mFdoConnection
FdoStringsP mRolesOrPrivileges
FdoPtr< FdoISQLCommand > mSqlCmd

Comments?