Share via


WSTrustChannel Members

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Represents a channel that is used to send WS-Trust messages to a security token service (STS).

The following tables list the members exposed by the WSTrustChannel type.

Public Constructors

  Name Description
  WSTrustChannel Initializes a new instance of the WSTrustChannel class.

Top

Public Properties

  Name Description
public property Channel Gets or sets the channel object that is used for sending and receiving messages.
public property ChannelFactory Gets or sets the factory that created the channel.
public property Contract Gets or sets the channel contract the channel uses for sending and receiving messages.
public property State Gets the current state of the communication-oriented object.
public property TrustVersion Gets or sets the version of WS-Trust this channel uses for serializing Message objects.
public property WSTrustRequestSerializer The WSTrustRequestSerializer the channel uses for serializing WS-Trust request messages.
public property WSTrustResponseSerializer Gets or sets the WSTrustResponseSerializer the channel uses for serializing WS-Trust response messages.
public property WSTrustSerializationContext Gets or sets the WSTrustSerializationContext the channel uses for serializing WS-Trust messages.

Top

Public Methods

(see also Protected Methods)

  Name Description
public method Abort Causes a communication object to transition immediately from its current state into the closed state.
public method BeginCancel Overloaded. Begins an asynchronous operation to send a WS-Trust Cancel message to an endpoint.
public method BeginClose Overloaded. Begins an asynchronous operation to close a communication object.
public method BeginIssue Overloaded. Begins an asynchronous operation to send a WS-Trust Issue message to an endpoint.
public method BeginOpen Overloaded. Begins an asynchronous operation to open a communication object.
public method BeginRenew Overloaded. Begins an asynchronous operation to send a WS-Trust Renew message to an endpoint.
public method BeginValidate Overloaded. Begins an asynchronous operation to send a WS-Trust Validate message to an endpoint.
public method Cancel Overloaded. Sends a WS-Trust Cancel message to an endpoint.
public method Close Overloaded. Causes a communication object to transition from its current state into the closed state.
public method EndCancel Overloaded. Completes an asynchronous operation to send a WS-Trust Cancel message to an endpoint.
public method EndClose Completes an asynchronous operation to close a communication object.
public method EndIssue Overloaded. Completes an asynchronous operation to send a WS-Trust Issue message to an endpoint.
public method EndOpen Completes an asynchronous operation to open a communication object.
public method EndRenew Overloaded. Completes an asynchronous operation to send a WS-Trust Renew message to an endpoint.
public method EndValidate Overloaded. Completes an asynchronous operation to send a WS-Trust Validate message to an endpoint.
public method Equals  (Inherited from Object)
public method GetHashCode  (Inherited from Object)
public method GetProperty Returns a typed object requested, if present, from the appropriate layer in the channel stack.
public method GetTokenFromResponse Gets the security token from the RSTR.
public method GetType  (Inherited from Object)
public method Issue Overloaded. Sends a WS-Trust Issue message to an endpoint STS.
public method Open Overloaded. Causes a communication object to transition from the created state into the opened state.
public method Renew Overloaded. Sends a WS-Trust Renew message to an endpoint.
public method ToString  (Inherited from Object)
public method Validate Overloaded. Sends a WS-Trust Validate message to an endpoint.

Top

Protected Methods

  Name Description
protected method CreateRequest Creates a Message object that represents a WS-Trust RST message.
protected method Finalize  (Inherited from Object)
protected methodstatic GetRequestAction Gets the WS-Addressing SOAP action that corresponds to the specified request type and WS-Trust version.
protected method MemberwiseClone  (Inherited from Object)
protected method ReadResponse Deserializes a RequestSecurityTokenResponse from a Message received from the WS-Trust endpoint.

Top

Public Events

  Name Description
public event Closed Occurs when the communication object completes its transition from the closing state into the closed state.
public event Closing Occurs when the communication object first enters the closing state.
public event Faulted Occurs when the communication object first enters the faulted state.
public event Opened Occurs when the communication object completes its transition from the opening state into the opened state.
public event Opening Occurs when the communication object first enters the opening state.

Top

See Also

Reference

WSTrustChannel Class
Microsoft.IdentityModel.Protocols.WSTrust Namespace

Other Resources

WSTrustChannelFactory and WSTrustChannel

Copyright © 2008 by Microsoft Corporation. All rights reserved.