This documentation is archived and is not being maintained.

ClientCredentialsSecurityTokenManager Class

Manages security tokens for the client.


Namespace:  System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

public class ClientCredentialsSecurityTokenManager : SecurityTokenManager

The ClientCredentialsSecurityTokenManager type exposes the following members.

Public methodClientCredentialsSecurityTokenManagerInitializes a new instance of the ClientCredentialsSecurityTokenManager class.

Public propertyClientCredentialsGets the client credentials.

Public methodCreateSecurityTokenAuthenticatorCreates a security token authenticator. (Overrides SecurityTokenManager.CreateSecurityTokenAuthenticator(SecurityTokenRequirement, SecurityTokenResolver).)
Public methodCreateSecurityTokenProviderCreates a security token provider. (Overrides SecurityTokenManager.CreateSecurityTokenProvider(SecurityTokenRequirement).)
Public methodCreateSecurityTokenSerializer(SecurityTokenVersion)Creates a security token serializer. (Overrides SecurityTokenManager.CreateSecurityTokenSerializer(SecurityTokenVersion).)
Protected methodCreateSecurityTokenSerializer(SecurityVersion)Creates a security token serializer.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodIsIssuedSecurityTokenRequirementGets a value that indicates whether the specified token requirement is an issued security token requirement.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

This class handles security token serialization, security token provision and security token authentication for the client. There is one instance of this class for each client channel factory.

The following code shows how you can override this class to create a custom Client Credentials Security Token Manager.

internal class MyClientCredentialsSecurityTokenManager : 
    MyClientCredentials credentials;

    public MyClientCredentialsSecurityTokenManager(MyClientCredentials credentials)
        : base(credentials)
        this.credentials = credentials;

    public override SecurityTokenProvider CreateSecurityTokenProvider(
        SecurityTokenRequirement tokenRequirement)
        // Return your implementation of the SecurityTokenProvider, if required.
        // This implementation delegates to the base class.
        return base.CreateSecurityTokenProvider(tokenRequirement);

    public override SecurityTokenAuthenticator CreateSecurityTokenAuthenticator(
        SecurityTokenRequirement tokenRequirement, out SecurityTokenResolver outOfBandTokenResolver)
        // Return your implementation of the SecurityTokenAuthenticator, if required.
        // This implementation delegates to the base class.
        return base.CreateSecurityTokenAuthenticator(tokenRequirement, out outOfBandTokenResolver);

    public override SecurityTokenSerializer CreateSecurityTokenSerializer(SecurityTokenVersion version)
        // Return your implementation of the SecurityTokenSerializer, if required.
        // This implementation delegates to the base class.
        return base.CreateSecurityTokenSerializer(version);

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.