Click or drag to resize

PasswordResetController Class

Inheritance Hierarchy
SystemObject
  Omada.OE.AppLogicControllerBase
    Omada.OE.Solution.OIM.AppLogicPasswordResetController

Namespace:  Omada.OE.Solution.OIM.AppLogic
Assembly:  Omada.OE.Solution.OIM.AppLogic (in Omada.OE.Solution.OIM.AppLogic.dll) Version: 15.0.0.0
Syntax
C#
public class PasswordResetController : ControllerBase

The PasswordResetController type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyConnectionString
Connection string for the database. Can be null.
(Inherited from ControllerBase.)
Public propertyDbCommandTimeout
DbCommandTimeout is applied to SqlCommand objects created using CreateSqlCommand(). The DbCommandTimeout value is (normally) passed on to other controllers created by the controller. If DbCommandTimeout is Zero then the DB default will be used as timeout.
(Inherited from ControllerBase.)
Public propertyDbConnection
Consider using CreateCommand() instead of accessing DbConnection directly. DbConnection and DbTransaction are either specified when constucting the controller or the controller constructs them itself (by using ConnectionString) when calling DoInConnection or DoInTransaction. If the caller specified DbConnection and DbTransaction when constucting the controller then the caller is responsible for the management of the connection.
(Inherited from ControllerBase.)
Public propertyDbTransaction
Consider using CreateCommand() instead of accessing DbTransaction directly. DbConnection and DbTransaction are either specified when constucting the controller or the controller constructs them itself (by using ConnectionString) when calling DoInConnection or DoInTransaction. If the caller specified DbConnection and DbTransaction when constucting the controller then the caller is responsible for the management of the connection.
(Inherited from ControllerBase.)
Public propertyFactory
Factory class for creating controller instances.
(Inherited from ControllerBase.)
Top
Methods
  NameDescription
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.)
Public methodCheckLicence
Checks for the PASSWORDRESET module key. Throws LicenseException if not present.
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 methodCheckPasswordStrength
Check if the provided password fullfills the requirements of a specific password policy.
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 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 methodGetAccountResources
Returns all account resources for the systems with pw reset enabled
Public methodGetBlackList(DataObject)
Returns the identity id, the first name and the last name of the provided identity. Used for the validating passwords if the policy states that those items are not allowed.
Public methodGetBlackList(User)
Returns the username, the first name and the last name of the provided user Used for the validating passwords if the policy states that those items are not allowed.
Public methodGetChallengeQuestions(Boolean)
Returns all challenge questions as DataObjects
Public methodGetChallengeQuestions(Int32, IntegerList)
Gets the challenge questions for the password reset process. The function supports that identityId can be 0. Its used when we mimic that we found the identity but did not.
Public methodGetChallengeResponses
Get question ids and responses for a identity
Protected methodGetDbUTCNow
(Inherited from ControllerBase.)
Public methodGetDefaultPasswordPolicy
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.)
Protected methodGetNewRowIdentity (Inherited from ControllerBase.)
Protected methodGetObjectDataVersion
Gets the data version of an object.
(Inherited from ControllerBase.)
Public methodGetPasswordPolicy(Int32, DataObject)
Public methodGetPasswordPolicy(DataObject, DataObject)
Public methodGetPasswordPolicyFromAccountKeys
Public methodHashResponse
Generates a SHA512 hash of the provided string for storing in the database. A random 4 byte salt is generated and prepended to the result.
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 methodOnPasswordResetCompleted
This method is called from the notification services optionally via a WebService
Public methodOnSendOneTimeCode
This method is called from the password reset web pages
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 methodSaveChallengeResponses
Clears existing challenge responses and adds the provided new ones
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 methodValidateChallengeResponses
Validates the provided responses. Responses are optionally converted to lowercase and trimmed according to the definition on the question
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.)
Public methodVerifyHashResponse
Compares a clear text string with stored hash data. The stored hash data is already prepended with the salt and the method copies the salt value from there.
Public methodVerifyResponses
Used by the reset process to verify all the provided answers towards values provided in the enroll process.
Top
Fields
  NameDescription
Public fieldStatic memberCompleted
The implementation of this delegate must execute the notify the user regarding the password reset result
Public fieldStatic memberPasswordReset
The implementation of this delegate must execute the password reset for the account of the identity
Public fieldStatic memberSendOneTimeCode
The implementation of this delegate must send off one time passwords to the identity
Public fieldStatic memberVerifyPassword
The delegate is used to determine if a user is able to present his current password when he wants to change his password.
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