This topic has not yet been rated - Rate this topic

ServiceCredentials Class

Configures a service credential. Use this class to specify the credential for the service such as an X.509 certificate. Also, use this class to specify the authentication model for various client credentials such as user name and password validation.

System.Object
  System.ServiceModel.Security.SecurityCredentialsManager
    System.ServiceModel.Description.ServiceCredentials

Namespace:  System.ServiceModel.Description
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
public class ServiceCredentials : SecurityCredentialsManager, 
	IServiceBehavior

The ServiceCredentials type exposes the following members.

  Name Description
Public method ServiceCredentials() Initializes a new instance of the ServiceCredentials class.
Protected method ServiceCredentials(ServiceCredentials) Initializes a new instance of ServiceCredentials from the specified ServiceCredentials.
Top
  Name Description
Public property ClientCertificate Gets the current client certificate authentication and provisioning settings for this service.
Public property IssuedTokenAuthentication Gets the current issued token (for example, SAML) authentication settings for this service.
Public property Peer Gets the current credential authentication and provisioning settings to be used by peer transport endpoints configured on the service.
Public property SecureConversationAuthentication Gets the current settings to be used by a secure conversation.
Public property ServiceCertificate Gets the current certificate associated with this service.
Public property UserNameAuthentication Gets the current user name/password authentication settings for this service.
Public property WindowsAuthentication Gets the current Windows authentication settings for this service.
Top
  Name Description
Public method Clone Creates a copy of the current instance.
Protected method CloneCore Copies the essential members of the current instance.
Public method CreateSecurityTokenManager Creates a token manager for this service. (Overrides SecurityCredentialsManager.CreateSecurityTokenManager().)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private method IServiceBehavior.AddBindingParameters Infrastructure. Adds this instance to a binding parameter collection. This is an infrastructure method and not intended to be called directly.
Explicit interface implemetation Private method IServiceBehavior.ApplyDispatchBehavior Infrastructure. Apply the dispatch behavior. This is an infrastructure method and not intended to be called directly.
Explicit interface implemetation Private method IServiceBehavior.Validate Infrastructure. Validates a service description. This is an infrastructure method and not intended to be called directly.
Top

This class is used as a parameter in the BuildChannelListenerCore<TChannel> method, by methods of the ServiceCredentialsSecurityTokenManager, and is returned by the ServiceHostBase.Credentials property.

The following code shows how to override this class to implement custom service credentials.


public class MyServiceCredentials : ServiceCredentials
{
    X509Certificate2 additionalCertificate;

    public MyServiceCredentials()
    {
    }

    protected MyServiceCredentials(MyServiceCredentials other)
        : base(other)
    {
        this.additionalCertificate = other.additionalCertificate;
    }

    public X509Certificate2 AdditionalCertificate
    {
        get
        {
            return this.additionalCertificate;
        }
        set
        {
            if (value == null)
            {
                throw new ArgumentNullException("value");
            }
            this.additionalCertificate = value;
        }
    }

    public override SecurityTokenManager CreateSecurityTokenManager()
    {
        return base.CreateSecurityTokenManager();
    }

    protected override ServiceCredentials CloneCore()
    {
        return new MyServiceCredentials(this);
    }
}


.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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ