Share via


SPClaimProviderManager members

Represents a class to provide management of the various claims providers in the SPFarm object.

The SPClaimProviderManager type exposes the following members.

Constructors

  Name Description
Public method SPClaimProviderManager Initializes a new instance of the SPClaimProviderManager class.

Top

Properties

  Name Description
Public propertyStatic member BasicClaimTypes Gets a set of claim types that the [T:HYPERLINK"mk:@MSITStore:D:\\aSDK\\SPF14.chm::/html/ea01343a-26c9-dc17-2a9d-4b8abf50220b.htm"Microsoft.SharePoint.Administration.SPFarm] farm knows about included by default in SharePoint.
Public propertyStatic member BasicClaimValueTypes Gets a set of claim value types that the [T:HYPERLINK"mk:@MSITStore:D:\\aSDK\\SPF14.chm::/html/ea01343a-26c9-dc17-2a9d-4b8abf50220b.htm"Microsoft.SharePoint.Administration.SPFarm] farm knows about included by default in SharePoint.
Public property ClaimProviders Gets the set of SPClaimProvider claim providers in the SPFarm farm.
Public property DeploymentLocked (Inherited from SPPersistedObject.)
Public property DisplayName Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public propertyStatic member Local Gets the claims provider manager.
Public property Name Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property TrustedClaimProviderMappableClaims
Public property TrustedClaimProviders Gets the set of SPTrustedClaimProvider trusted claim providers in the SPFarm farm.
Public property TypeName Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property Version Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
Protected property WasCreated Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)

Top

Methods

  Name Description
Public method AddClaimProvider Adds a claims provider to be used by the local farm.
Public method AddEncodingForClaimType
Public method Clone Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
Public method ConvertClaimToIdentifier Converts an identity claim into its original unique identifier.
Public method ConvertIdentifierToClaim Converts a unique identifier into a claim.
Public method ConvertSPUserToClaim Converts a user into an identity claim.
Public methodStatic member CreateUserClaim(String, SPOriginalIssuerType) Creates an object that represents the SPClaim for the user.
Public methodStatic member CreateUserClaim(String, SPOriginalIssuerType, String) Creates an object that represents the SPClaim for the user.
Public method DecodeClaim Decodes an encoded claim string into an SPClaim object.
Public method DecodeClaimFromFormsSuffix Decodes the suffix of an encoded claim string into a SPClaim object..
Public methodStatic member DecodeUserIdentifierClaim(SPClaim) Decodes an encoded claim string that identifies a user into an SPClaim object.
Public methodStatic member DecodeUserIdentifierClaim(String, String, String, String) Decodes an encoded claim string that identifies a user into an SPClaim object.
Public method Delete Deletes the object. (Inherited from SPPersistedObject.)
Public method DeleteClaimProvider(String) Removes a registered claims provider.
Public method DeleteClaimProvider(SPClaimProviderDefinition)
Public method DoesClaimProviderExist Verifies that a SPClaimProvider claim provider with the name parameter exists.
Public method EncodeClaim Encodes an SPClaim object into a String.
Public methodStatic member EncodeProviderUserKey Creates an [Microsoft.SharePoint.Administration.Claims.SPClaim] with the right claim
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Protected method Finalize (Inherited from Object.)
Public method GetChild<T>() Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
Public method GetClaimProvider Retrieves a SPClaimProvider by name.
Public method GetClaimProviderDefinitionForClaim
Public method GetClaimTypeEncodings
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Public method GetType (Inherited from Object.)
Public method GetUserIdentifierEncodedClaim(IIdentity) Extracts the EncodeClaim() from the identity.
Public method GetUserIdentifierEncodedClaim(String) Extracts the EncodeClaim(SPClaim)-encoded SPClaim from the identity.
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Public methodStatic member IsClaimsUser Checks whether the current threads principal is for a claims user (and thereford that claims is active).
Public methodStatic member IsClaimsUserAndMatchesIdentityClaim Static method to check the current thread's principal is for a claims user (and thus that claims is active) and that it's identity claim matches identityClaim.
Public methodStatic member IsEncodedClaim Indicates whether a string represents an encoded SPClaim.
Public methodStatic member IsUserIdentifierClaim(SPClaim) Tests to see if the claim represented by the inputs is a SharePoint identity claim.
Public methodStatic member IsUserIdentifierClaim(String, String, String, String) Tests to see if the claim represented by the inputs is a SharePoint identity claim.
Public method LegacyUpdate (Inherited from SPPersistedObject.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnDeserialization Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
Protected method OnPostCreate (Inherited from SPPersistedObject.)
Protected method OnPreCreate (Inherited from SPPersistedObject.)
Public method Provision Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
Public method RunWithConcurrencyRetries (Inherited from SPPersistedObject.)
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
Public method Update() Commits changes to the claims provider manager. (Overrides SPPersistedObject.Update().)
Public method Update(Boolean) Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Public method UpdateWithNoObjectCallbackCheck (Inherited from SPPersistedObject.)
Protected method Validate Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)

Top

Explicit interface implementations

  Name Description
Explicit interface implemetationPrivate method IBackupRestore.AddBackupObjects Adds the claims provider manager to the backup and restore operation.
Explicit interface implemetationPrivate property IBackupRestore.CanRenameOnRestore Gets a value that indicates whether this item can be renamed at restore time.
Explicit interface implemetationPrivate property IBackupRestore.CanSelectForBackup Gets or sets a value that indicates whether the content component that is represented by the object can be selected for restoration.
Explicit interface implemetationPrivate property IBackupRestore.CanSelectForRestore Gets or sets a value that indicates whether the content component that is represented by the IBackupRestore object can be selected for restoration.
Explicit interface implemetationPrivate property IBackupRestore.DiskSizeRequired Gets the amount of disk space, in bytes, that is required to store a backup of the content represented by the IBackupRestore object.
Explicit interface implemetationPrivate property IBackupRestore.Id Gets or sets the unique identifier for the back-up of the claims provider manager.
Explicit interface implemetationPrivate property IBackupRestore.Name Gets and sets the name for the claims provider manager.
Explicit interface implemetationPrivate method IBackupRestore.OnAbort An event that is called in the backup and restore infrastructure when the user cancels the operation.
Explicit interface implemetationPrivate method IBackupRestore.OnBackup An event that is called when the system is being backed up.
Explicit interface implemetationPrivate method IBackupRestore.OnBackupComplete The event that is called when the system is finished with the backup and restore procedure.
Explicit interface implemetationPrivate method IBackupRestore.OnPostRestore The event that is called when the system is finished restoring.
Explicit interface implemetationPrivate method IBackupRestore.OnPrepareBackup The event that is called when the system is preparing a backup operation.
Explicit interface implemetationPrivate method IBackupRestore.OnPreRestore The event that is called when the system is preparing a restore operation.
Explicit interface implemetationPrivate method IBackupRestore.OnRestore The event that is called when the system is being restored.

Top

See also

Reference

SPClaimProviderManager class

Microsoft.SharePoint.Administration.Claims namespace