Click or drag to resize

UserController Methods

The UserController type exposes the following members.

Methods
  NameDescription
Public methodStatic memberAuthenticateUser(String, String, String, AuthUserInfo) Obsolete.
Validates that the provided combination of customer and user exists and that the provided password is valid.
Public methodAuthenticateUser(Customer, String, String, Boolean, AuthUserInfo)
Public methodStatic memberAuthenticateUserExternal Obsolete.
Validates that the provided combination of customer and user exists. No password validation is performed
Protected methodBuildCacheKey
Builds a cache key for use with GetFromCacheIfPresent. The cache key is not hashed because we have experienced a collision using GetHashCode() ie. the cache keys are quite long and there is a price in dictionary size in memory and in dictionary lookups.
(Inherited from ControllerBase.)
Protected methodCheckObjectOperationSecurity
Checks that the active user is allowed to perform an CRUD operation on a specific configuration object. (note: except that a Create operation is not for a specific object). Throws a SecurityException if not. Method can be used for all configuration objects that are represented by a ConfigurationObjectType (except those that have a compound key). Method checks auth role security as well as whether it is allowed to modify builtin/feature package objects.
(Inherited from ControllerBase.)
Protected methodCheckObjectSaveOperationSecurity
Checks that the active user is allowed to Create a new - or Update an existing configuration object. Throws a SecurityException if not. Method can be used for all configuration objects that are represented by a ConfigurationObjectType (except those that have a compound key). Method checks auth role security as well as whether it is allowed to modify builtin/feature package objects.
(Inherited from ControllerBase.)
Public methodConvertId(Int32, ConfigurationObjectType)
Converts the integer id of an object to its transport-safe unique id (UId).
(Inherited from ControllerBase.)
Public methodConvertId(String, ConfigurationObjectType)
Converts a string representation of an integer or Guid id to an integer id.
(Inherited from ControllerBase.)
Public methodConvertId(Guid, ConfigurationObjectType, Boolean)
Converts the transport-safe unique id (UId) of an object to its integer id.
(Inherited from ControllerBase.)
Public methodConvertIds(IEnumerableGuid, ConfigurationObjectType)
Converts the transport-safe unique ids (UId) of a number of objects to integer ids.
(Inherited from ControllerBase.)
Public methodConvertIds(IEnumerableInt32, ConfigurationObjectType)
Converts the integer ids of a number of objects to their transport-safe unique ids (UId).
(Inherited from ControllerBase.)
Protected methodCreateCommand(SQLBuilder) (Inherited from ControllerBase.)
Protected methodCreateCommand(String) (Inherited from ControllerBase.)
Protected methodCreateSqlBulkCopy
Create a new SqlBulkCopy instance using the connection, transaction and timeout values from the controller
(Inherited from ControllerBase.)
Public methodStatic memberDeactivateUser
Deactivates a user. The Username attribute is postfixed with $YYYYMMDDHHmmss$ for current date. It is used in a DataExchange (import) when MissingObjectAction=Deactivate. The postfix makes usure that new users with the same username can be created without errors.
Public methodDoInConnection(ControllerBaseActionWithNoResult)
Executes an action that doesn't return a result. If no current connection exists, it will establish a connection to the database and close it afterwards. An existing connection will be reused. Inside the action, the connection is available as DbConnection.
(Inherited from ControllerBase.)
Public methodDoInConnection(ActionSqlConnection, SqlTransaction, Boolean)
Executes an action that doesn't return a result. If no current connection exists, it will establish a connection to the database and close it afterwards. Connection and Transaction are passed to delegate, to allow passing to other controllers An existing connection will be reused. Inside the action, the connection is available as DbConnection. To ensure a new connection set forceNew to true.
(Inherited from ControllerBase.)
Public methodDoInConnectionT(ControllerBaseActionWithResultT)
Executes an action and returns the result. If no current connection exists, it will establish a connection to the database and close it afterwards. An existing connection will be reused. Inside the action, the connection is available as DbConnection.
(Inherited from ControllerBase.)
Public methodDoInTransaction(ControllerBaseActionWithNoResult)
Executes an action (that doesn't return a result) in a transaction. If no current connection and/or transaction exists, it will establish it and commit and close it afterwards. An existing connection/transaction will be reused. Inside the action, the connection is available as DbConnection and the transaction as DbTransaction.
(Inherited from ControllerBase.)
Public methodDoInTransactionT(ControllerBaseActionWithResultT)
Executes an action in a transaction and returns the result. If no current connection and/or transaction exists, it will establish it and commit and close it afterwards. An existing connection/transaction will be reused. Inside the action, the connection is available as DbConnection and the transaction as DbTransaction.
(Inherited from ControllerBase.)
Public methodDoInTransactionT(FuncSqlConnection, SqlTransaction, T, Boolean)
Executes an action in a transaction and returns the result. Connection and Transaction are passed to delegate, to allow passing to other controllers If no current connection and/or transaction exists, it will establish it and commit and close it afterwards. An existing connection/transaction will be reused. Set forceNew to true to ensure new connection and transaction Inside the action, the connection is available as DbConnection and the transaction as DbTransaction.
(Inherited from ControllerBase.)
Protected methodDoInTransactionUnlessPostponedDueToPreviousDefaultResultT
The method can postpone a SQL transaction implemented by action if the method returns a default number, eg. 0. If the the action method throws a SQL transitent error, then the next call to action is also postponed.
(Inherited from ControllerBase.)
Protected methodDoUnlessPostponedDueToPreviousDefaultResultT
The method can postpone a method invocation if the previous call returned a default number, eg. 0.
(Inherited from ControllerBase.)
Protected methodExecScalarResultQueryT
Executes a query with a scalar result.
(Inherited from ControllerBase.)
Public methodExecuteMutexOperation(String, Action, Boolean) (Inherited from ControllerBase.)
Protected methodExecuteMutexOperationT(String, FuncT, Boolean) (Inherited from ControllerBase.)
Protected methodExpireCacheItem (Inherited from ControllerBase.)
Public methodGetActiveUserAuthElementPermissions(Int32)
Returns the rights of the active user to the provided auth element. The method only returns the right within the current session according to the AuthLevel of the session and the user groups. The method applies caching.
Public methodStatic memberGetActiveUserAuthElementPermissions(Int32, SqlConnection, SqlTransaction)
Returns the rights of the active user to the provided auth element. The method only returns the right within the current session according to the AuthLevel of the session and the user groups.
Public methodGetActiveUserViewPermissions
Returns the security context for the active user to a view.
Public methodGetAuthUserInfo(Int32)
Public methodStatic memberGetAuthUserInfo(Int32, Int32)
Protected methodGetDbUTCNow
(Inherited from ControllerBase.)
Public methodGetDefaultTimeZone
Returns the default time zone which is specified in the customer settings. The default time zone is used when a new user is created.
Public methodGetFromCacheIfPresent(String, ControllerBaseActionWithResultIntegerList, ControllerBaseCacheOptions) (Inherited from ControllerBase.)
Public methodGetFromCacheIfPresent(String, ControllerBaseActionWithResultAppIdentity, ControllerBaseCacheOptions) (Inherited from ControllerBase.)
Public methodGetFromCacheIfPresent(String, ControllerBaseActionWithResultBoolean, ControllerBaseCacheOptions) (Inherited from ControllerBase.)
Public methodGetFromCacheIfPresent(String, ControllerBaseActionWithResultIListGuid, ControllerBaseCacheOptions) (Inherited from ControllerBase.)
Public methodGetFromCacheIfPresent(String, ControllerBaseActionWithResultListGuid, ControllerBaseCacheOptions) (Inherited from ControllerBase.)
Public methodGetFromCacheIfPresent(String, ControllerBaseActionWithResultListInt32, ControllerBaseCacheOptions) (Inherited from ControllerBase.)
Public methodGetFromCacheIfPresent(String, ControllerBaseActionWithResultGuid, ControllerBaseCacheOptions) (Inherited from ControllerBase.)
Public methodGetFromCacheIfPresent(String, ControllerBaseActionWithResultInt32, ControllerBaseCacheOptions) (Inherited from ControllerBase.)
Public methodGetFromCacheIfPresent(String, ControllerBaseActionWithResultTimeZoneInfo, ControllerBaseCacheOptions) (Inherited from ControllerBase.)
Public methodGetFromCacheIfPresentT(String, ControllerBaseActionWithResultListT, ControllerBaseCacheOptions) (Inherited from ControllerBase.)
Public methodGetFromCacheIfPresentT(String, ControllerBaseActionWithResultT, ControllerBaseCacheOptions)
Retrieves some data from the cache or (if it is not there) executes an action and stores the result in the cache. Caching is not applied if the IgnoreCacheContext is used (depending on the parameter for it). Note: caching should only be used with great care as there are a number of potential issues involved in using it!
(Inherited from ControllerBase.)
Public methodGetGroupAuthElementPermissions
Public methodGetIdentityByUserId
Get an AppIdentity from a userid
Public methodGetMemberGroupIdsByUser
Returns user ids and group ids which they are members of
Protected methodGetNewRowIdentity (Inherited from ControllerBase.)
Protected methodGetObjectDataVersion
Gets the data version of an object.
(Inherited from ControllerBase.)
Public methodGetPersonalGroupId(Int32)
Public methodStatic memberGetPersonalGroupId(Int32, SqlConnection, SqlTransaction)
Public methodStatic memberGetPersonalGroupIds
Public methodGetUser(Int32, Boolean)
Public methodStatic memberGetUser(Int32, SqlConnection, SqlTransaction)
Returns a user object. User is not returned if: * he is deleted * the caller hasn't readaccess to the user.
Public methodStatic memberGetUser(Int32, UserLoadOptions, SqlConnection, SqlTransaction)
Returns a user object. The loadoptions can be used to specify additional load options - except IdPosList.
Public methodStatic memberGetUser(Int32, Boolean, SqlConnection, SqlTransaction)
Public methodGetUserCount(UserCountLoadOptions)
Public methodStatic memberGetUserCount(UserCountLoadOptions, SqlConnection)
Public methodGetUserFormattedName(Int32, UserNameFormat)
Public methodStatic memberGetUserFormattedName(Int32, UserNameFormat, SqlConnection, SqlTransaction)
Public methodGetUserIdByUserName(String)
Public methodStatic memberGetUserIdByUserName(String, SqlConnection, SqlTransaction)
Returns the id of a user based on his username. The username is caseINsensitive. If the username doesn't exists zero is returned.
Public methodGetUserIdFromPersonalGroupId(Int32)
Public methodStatic memberGetUserIdFromPersonalGroupId(Int32, SqlConnection, SqlTransaction)
Public methodGetUserIds(UserIdLoadOptions)
Public methodStatic memberGetUserIds(UserIdLoadOptions, SqlConnection, SqlTransaction)
Public methodGetUserInfo
Returns a UserInfo object based on a authUserInfo object. Missing attributes on the authUserInfo object are loaded from the database. The method is used in the authentication logic.
Public methodGetUserManager(UserLoadOptions)
Public methodStatic memberGetUserManager(UserLoadOptions, SqlConnection, SqlTransaction)
Returns a user manager object populated with some or all users in the system.
Public methodGetUserMemberGroupIds(IEnumerableInt32, AuthLevel)
Public methodStatic memberGetUserMemberGroupIds(Int32, SqlConnection, SqlTransaction)
Returns ids of all user groups that a user is member of. The AuthLevel of the groups are NOT considered.
Public methodGetUserName(Int32)
Public methodStatic memberGetUserName(Int32, SqlConnection, SqlTransaction)
Public methodGetUserOverrideSecurity(Int32)
Public methodStatic memberGetUserOverrideSecurity(Int32, SqlConnection, SqlTransaction)
Returns a user object. User is not returned if: * he is deleted
Public methodStatic memberGetUsers
Loads a number of user objects.
Public methodGetUserTimeZoneId
Returns the timezone code/id for a user.
Public methodStatic memberGetWorkWeekId
Protected methodIncrementDataVersion
(Inherited from ControllerBase.)
Protected methodIncrementObjectDataVersion(IEntityObject)
Increments the data version of an entity object. The data version is incremented in the db as well as on the object itself. Method is used to update the data version of an object when an aggregated object is created/modified/deleted. The purpose is to ensure that the id-based cache (in AppIdentity) is updated properly.
(Inherited from ControllerBase.)
Protected methodIncrementObjectDataVersion(Int32, EntityObjectType)
Increments the data version of an entity object in the db. Method is used to update the data version of an object when an aggregated object is created/modified/deleted. The purpose is to ensure that the id-based cache (in AppIdentity) is updated properly.
(Inherited from ControllerBase.)
Public methodStatic memberIsInactive
Returns whether a specific user is inactive. The method doesn't consider the security model. The method doesn't consider whether the user is marked as deleted.
Public methodIsPasswordValid
Public methodMarkUserAsDeleted(Int32)
Deletes the specified user by setting a marker.
Public methodStatic memberMarkUserAsDeleted(Int32, SqlConnection, SqlTransaction)
Deletes the specified user by setting a marker.
Protected methodPopulateTempTableT
Creates a temporary db table with a single column and populates it with values.
(Inherited from ControllerBase.)
Protected methodPostponeTransientErrorT
If the action throws a transient sql error, the exception is eaten. An entry is written to the log with level Information. The entire exception is written to the log with level Debug.
(Inherited from ControllerBase.)
Public methodSaveUser(User)
Public methodSaveUser(User, UserSaveOptions)
Public methodStatic memberSaveUser(User, SqlConnection, SqlTransaction)
Public methodStatic memberSaveUser(User, UserSaveOptions, SqlConnection, SqlTransaction)
Public methodSaveUserUserGroups(User)
Public methodStatic memberSaveUserUserGroups(User, SqlConnection, SqlTransaction)
Public methodSetActiveUserLanguageId
Public methodSetUserDefaultViewId(Int32, Int32)
Public methodStatic memberSetUserDefaultViewId(Int32, Int32, SqlConnection, SqlTransaction)
Public methodStatic memberSetUserInactiveFlag
Public methodStatic memberSetUserName
Public methodSetUserPassword(Int32, String)
Public methodStatic memberSetUserPassword(Int32, String, SqlConnection, SqlTransaction)
Public methodSetUserTimeZoneId
Protected methodTransferUIdsToIdsLoadOption
Converts/transfers one or more specified uids in a loadoptions object to ids. The purpose is to enable caching as IEntityObjectsLoadOptions.IdList only works with ids (and not uids).
(Inherited from ControllerBase.)
Public methodUpdateUserRegionalSettings(Int32, RegionalSettings)
Public methodStatic memberUpdateUserRegionalSettings(Int32, RegionalSettings, SqlConnection, SqlTransaction)
Protected methodValidateDataVersionT
Validates that the data version of an object corresponds to the data version in the DB. Method is used for validation before saving an object.
(Inherited from ControllerBase.)
Top
Extension Methods
  NameDescription
Public Extension MethodToBool
Converts object to boolean.
(Defined by ObjectExtensions.)
Public Extension MethodToDateTime
Converts object to DateTime.
(Defined by ObjectExtensions.)
Public Extension MethodToInt
Converts object to integer.
(Defined by ObjectExtensions.)
Top
See Also