Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

WSTrustChannel Class

.NET Framework 4.5

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

System.Object
  System.ServiceModel.Security.WSTrustChannel

Namespace:  System.ServiceModel.Security
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
public class WSTrustChannel : IWSTrustChannelContract, 
	IWSTrustContract, IChannel, ICommunicationObject

The WSTrustChannel type exposes the following members.

  NameDescription
Public methodWSTrustChannelInitializes a new instance of the WSTrustChannel class.
Top
  NameDescription
Public propertyChannelGets or sets the channel object that is used for sending and receiving messages.
Public propertyChannelFactoryGets or sets the factory that created the channel.
Public propertyContractGets or sets the channel contract the channel uses for sending and receiving messages.
Public propertyStateGets the current state of the communication-oriented object.
Public propertyTrustVersionGets or sets the version of WS-Trust this channel uses for serializing Message objects.
Public propertyWSTrustRequestSerializerThe WSTrustRequestSerializer that the channel uses for serializing WS-Trust request messages.
Public propertyWSTrustResponseSerializerGets or sets the WSTrustResponseSerializer that the channel uses for serializing WS-Trust response messages.
Public propertyWSTrustSerializationContextGets or sets the WSTrustSerializationContext that the channel uses for serializing WS-Trust messages.
Top
  NameDescription
Public methodAbortCauses a communication object to transition immediately from its current state into the closed state.
Public methodBeginCancel(Message, AsyncCallback, Object)Begins an asynchronous operation to send a WS-Trust Cancel message to an endpoint using the specified Message object.
Public methodBeginCancel(RequestSecurityToken, AsyncCallback, Object)Begins an asynchronous operation to send a WS-Trust Cancel message to an endpoint using the specified RequestSecurityToken object.
Public methodBeginClose(AsyncCallback, Object)Begins an asynchronous operation to close a communication object.
Public methodBeginClose(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to close a communication object with a specified timeout.
Public methodBeginIssue(Message, AsyncCallback, Object)Begins an asynchronous operation to send a WS-Trust Issue message to an endpoint using the specified Message object.
Public methodBeginIssue(RequestSecurityToken, AsyncCallback, Object)Begins an asynchronous operation to send a WS-Trust Issue message to an endpoint using the specified RequestSecurityToken object.
Public methodBeginOpen(AsyncCallback, Object)Begins an asynchronous operation to open a communication object.
Public methodBeginOpen(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to open a communication object within a specified interval of time.
Public methodBeginRenew(Message, AsyncCallback, Object)Begins an asynchronous operation to send a WS-Trust Renew message to an endpoint using the specified Message object.
Public methodBeginRenew(RequestSecurityToken, AsyncCallback, Object)Begins an asynchronous operation to send a WS-Trust Renew message to an endpoint using the specified RequestSecurityToken object.
Public methodBeginValidate(Message, AsyncCallback, Object)Begins an asynchronous operation to send a WS-Trust Validate message to an endpoint using the specified Message object.
Public methodBeginValidate(RequestSecurityToken, AsyncCallback, Object)Begins an asynchronous operation to send a WS-Trust Validate message to an endpoint using the specified RequestSecurityToken object.
Public methodCancel(Message)Sends a WS-Trust Cancel message to an endpoint using the specified Message object.
Public methodCancel(RequestSecurityToken)Sends a WS-Trust Cancel message to an endpoint using the specified Message object.
Public methodClose()Causes a communication object to transition from its current state into the closed state.
Public methodClose(TimeSpan)Causes a communication object to transition from its current state into the closed state within a specified interval of time.
Protected methodCreateRequestCreates a Message object that represents a WS-Trust RST message.
Public methodEndCancel(IAsyncResult)Completes an asynchronous operation to send a WS-Trust Cancel message initiated by the BeginCancel(Message, AsyncCallback, Object) method.
Public methodEndCancel(IAsyncResult, RequestSecurityTokenResponse)Completes an asynchronous operation to send a WS-Trust Cancel message initiated by the BeginCancel(RequestSecurityToken, AsyncCallback, Object) method.
Public methodEndCloseCompletes an asynchronous operation to close a communication object.
Public methodEndIssue(IAsyncResult)Completes an asynchronous operation to send a WS-Trust Issue message initiated by the BeginIssue(Message, AsyncCallback, Object) method.
Public methodEndIssue(IAsyncResult, RequestSecurityTokenResponse)Completes an asynchronous operation to send a WS-Trust Issue message initiated by the BeginIssue(RequestSecurityToken, AsyncCallback, Object) method.
Public methodEndOpenCompletes an asynchronous operation to open a communication object.
Public methodEndRenew(IAsyncResult)Completes an asynchronous operation to send a WS-Trust Renew message initiated by the BeginRenew(Message, AsyncCallback, Object) method.
Public methodEndRenew(IAsyncResult, RequestSecurityTokenResponse)Completes an asynchronous operation to send a WS-Trust Renew message initiated by the BeginRenew(RequestSecurityToken, AsyncCallback, Object) method.
Public methodEndValidate(IAsyncResult)Completes an asynchronous operation to send a WS-Trust Validate message initiated by the BeginValidate(Message, AsyncCallback, Object) method.
Public methodEndValidate(IAsyncResult, RequestSecurityTokenResponse)Completes an asynchronous operation to send a WS-Trust Validate message initiated by the BeginValidate(RequestSecurityToken, AsyncCallback, Object) method.
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 the default hash function. (Inherited from Object.)
Public methodGetProperty<T>Returns a typed object requested, if present, from the appropriate layer in the channel stack.
Protected methodStatic memberGetRequestActionGets the WS-Addressing SOAP action that corresponds to the specified request type and WS-Trust version.
Public methodGetTokenFromResponseGets the security token from the RSTR.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIssue(Message)Sends a WS-Trust Issue message to an endpoint STS using the specified Message object.
Public methodIssue(RequestSecurityToken)Sends a WS-Trust Issue message to an endpoint STS using the specified RequestSecurityToken object.
Public methodIssue(RequestSecurityToken, RequestSecurityTokenResponse)Sends a WS-Trust Issue message to an endpoint STS using the specified RequestSecurityToken and RequestSecurityToken objects.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOpen()Causes a communication object to transition from the created state into the opened state.
Public methodOpen(TimeSpan)Causes a communication object to transition from the created state into the opened state within a specified interval of time.
Protected methodReadResponseDeserializes a RequestSecurityTokenResponse from a Message received from the WS-Trust endpoint.
Public methodRenew(Message)Sends a WS-Trust Renew message to an endpoint using the specified Message object.
Public methodRenew(RequestSecurityToken)Sends a WS-Trust Renew message to an endpoint using the specified RequestSecurityToken object.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodValidate(Message)Sends a WS-Trust Validate message to an endpoint using the specified Message object.
Public methodValidate(RequestSecurityToken)Sends a WS-Trust Validate message to an endpoint using the specified RequestSecurityToken object.
Top
  NameDescription
Public eventClosedOccurs when the communication object completes its transition from the closing state into the closed state.
Public eventClosingOccurs when the communication object first enters the closing state.
Public eventFaultedOccurs when the communication object first enters the faulted state.
Public eventOpenedOccurs when the communication object completes its transition from the opening state into the opened state.
Public eventOpeningOccurs when the communication object first enters the opening state.
Top

.NET Framework

Supported in: 4.5.1, 4.5

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.