Click or drag to resize

IdentityController Methods

The IdentityController type exposes the following members.

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.)
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.)
Public methodStatic memberCreateIdentityUser(Int32, SqlConnection, SqlTransaction)
Creates User for Identity setting the UserName to IdentityId.
Public methodStatic memberCreateIdentityUser(Int32, Int32, Boolean, SqlConnection, SqlTransaction)
Creates User for Identity setting the UserName to IdentityId.
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 methodGetAppIdentityByIdentityId
Get an AppIdentity from an identity id.
Protected methodGetDbUTCNow
(Inherited from ControllerBase.)
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 methodGetIdentitiesUserIds(IEnumerableInt32)
The method returns the ids of the users which the specified identities belongs to (if any). Delete-marked users are ignored.
Public methodGetIdentitiesUserIds(IEnumerableInt32, Int32)
The method returns the ids of the users which the specified identities belongs to (if any). Delete-marked users are ignored.
Public methodStatic memberGetIdentityDataObjectCountLoadOptions
Public methodGetIdentityDataObjectLoadOptions
Returns a DataObjectLoadOptions object prepared for loading identity data objects conforming to a number of identity specific load options.
Public methodGetIdentityTimeZone
Returns the timezone for an identity as specified in the Identity.TIMEZONE property. If an identity has no timezone then the system default (specified in the customer settings) is returned.
Public methodGetIdentityUserId(Int32)
The method returns the id of the user which the specified identity belongs to. Delete-marked users are ignored.
Public methodStatic memberGetIdentityUserId(Int32, SqlConnection, SqlTransaction)
The method returns the id of the user which the specified identity belongs to. Delete-marked users are ignored.
Public methodStatic memberGetIdentityUserIds
The method returns the ids of the users which the specified identities belongs to (if any). Delete-marked users are ignored.
Public methodGetManagerIds(Int32, ContextControllerCrawlMode)
Returns the "managers" of an identity. The managers are the owners of the identity's primary context (or the owner of an ancestor context if the primary context itself has no owners). If one or more supervisors are stated (according to the identity's primary context type) on the identity then these are returned as priority one. Managers are either users or (non-personal) groups (or a combination).
Public methodStatic memberGetManagerIds(Int32, SqlConnection, SqlTransaction)
Returns the "managers" of an identity. The managers are the owners of the identity's primary context (or the owner of an ancestor context if the primary context itself has no owners). If one or more supervisors are stated (according to the identity's primary context type) on the identity then these are returned as priority one.
Public methodStatic memberGetManagerIds(Int32, Boolean, SqlConnection, SqlTransaction)
Returns the "managers" of an identity. The managers are the owners of the identity's primary context (or the owner of an ancestor context if the primary context itself has no owners). If one or more supervisors are stated (according to the identity's primary context type) on the identity then these are returned as priority one. Managers are either users or (non-personal) groups (or a combination).
Public methodStatic memberGetManagerIdsCheck(Int32, SqlConnection, SqlTransaction) Obsolete.
Public methodStatic memberGetManagerIdsCheck(Int32, Boolean, SqlConnection, SqlTransaction)
Protected methodGetNewRowIdentity (Inherited from ControllerBase.)
Protected methodGetObjectDataVersion
Gets the data version of an object.
(Inherited from ControllerBase.)
Public methodStatic memberGetOrgUnitId
Returns the id of the org. unit which the identity belongs to.
Public methodStatic memberGetPreviousOrgUnitId
The method returns the id of the org. unit than an identity was previously working in. If the identity has never been working in other org. units (than the current one) then 0 (zero) is returned. If the identity has been working in more than one other org. units, then the id of the most recent one is returned.
Public methodGetTimeZonePerIdentity
Returns the timezone for a list of identities as specified in the Identity.TIMEZONE property. If an identity has no timezone then the system default (specified in the customer settings) is returned.
Public methodGetUserIdentityId
Returns the IdentityId for a user. The identity of the user is found by inspecting the 'Identity' reference property present on the User data object type. If the user doesn't have a referred identity the method returns 0.
Public methodGetUsersIdentityId
Returns the IdentityId for a list of users. The identity of the user is found by inspecting the 'Identity' reference property present on the User data object type. If the user doesn't have a referred identity the method returns 0.
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 methodLoadIdentities(IdentityLoadOptions)
Public methodStatic memberLoadIdentities(IEnumerableInt32, SqlConnection, SqlTransaction)
Overrides security.
Public methodLoadIdentity
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.)
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 methodUpdateIdentities(IEnumerableInt32, IdentityUpdateOptions)
Public methodStatic memberUpdateIdentities(IntegerList, IdentityUpdateOptions, SqlConnection, SqlTransaction)
Public methodStatic memberUpdateIdentity
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
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIIdentityResolverFindIdentity
The method looks up an Identity based on a userPrincipalName account name and a system. The method mimicks how RoPE looks up accounts in ODW which also covers owned accounts. It searches on the DistinguishedName column which we know is mapped from the userPrincipalName in the Azure collector. If it is not found in ODW, we make a simple lookup on the Identity email address.
Top
See Also