WSTrustChannel Class

Reference

Definition

Namespace:: System.ServiceModel.Security

Assembly:: System.ServiceModel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class WSTrustChannel : System::ServiceModel::Channels::IChannel, System::ServiceModel::Security::IWSTrustChannelContract

public class WSTrustChannel : System.ServiceModel.Channels.IChannel, System.ServiceModel.Security.IWSTrustChannelContract

type WSTrustChannel = class
    interface IWSTrustChannelContract
    interface IWSTrustContract
    interface IChannel
    interface ICommunicationObject

Public Class WSTrustChannel
Implements IChannel, IWSTrustChannelContract

Inheritance: Object
WSTrustChannel

Implements: IChannel ICommunicationObject IWSTrustChannelContract IWSTrustContract

Remarks

Important

Calling methods from this class with untrusted data is a security risk. Call the methods from this class only with trusted data. For more information, see Validate All Inputs.

Constructors

WSTrustChannel(WSTrustChannelFactory, IWSTrustChannelContract, TrustVersion, WSTrustSerializationContext, WSTrustRequestSerializer, WSTrustResponseSerializer)

Initializes a new instance of the WSTrustChannel class.

Properties

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

Methods

Abort()	Causes a communication object to transition immediately from its current state into the closed state.
BeginCancel(Message, AsyncCallback, Object)	Begins an asynchronous operation to send a WS-Trust Cancel message to an endpoint using the specified Message object.
BeginCancel(RequestSecurityToken, AsyncCallback, Object)	Begins an asynchronous operation to send a WS-Trust Cancel message to an endpoint using the specified RequestSecurityToken object.
BeginClose(AsyncCallback, Object)	Begins an asynchronous operation to close a communication object.
BeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to close a communication object with a specified timeout.
BeginIssue(Message, AsyncCallback, Object)	Begins an asynchronous operation to send a WS-Trust Issue message to an endpoint using the specified Message object.
BeginIssue(RequestSecurityToken, AsyncCallback, Object)	Begins an asynchronous operation to send a WS-Trust Issue message to an endpoint using the specified RequestSecurityToken object.
BeginOpen(AsyncCallback, Object)	Begins an asynchronous operation to open a communication object.
BeginOpen(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to open a communication object within a specified interval of time.
BeginRenew(Message, AsyncCallback, Object)	Begins an asynchronous operation to send a WS-Trust Renew message to an endpoint using the specified Message object.
BeginRenew(RequestSecurityToken, AsyncCallback, Object)	Begins an asynchronous operation to send a WS-Trust Renew message to an endpoint using the specified RequestSecurityToken object.
BeginValidate(Message, AsyncCallback, Object)	Begins an asynchronous operation to send a WS-Trust Validate message to an endpoint using the specified Message object.
BeginValidate(RequestSecurityToken, AsyncCallback, Object)	Begins an asynchronous operation to send a WS-Trust Validate message to an endpoint using the specified RequestSecurityToken object.
Cancel(Message)	Sends a WS-Trust Cancel message to an endpoint using the specified Message object.
Cancel(RequestSecurityToken)	Sends a WS-Trust Cancel message to an endpoint using the specified Message object.
Close()	Causes a communication object to transition from its current state into the closed state.
Close(TimeSpan)	Causes a communication object to transition from its current state into the closed state within a specified interval of time.
CreateRequest(RequestSecurityToken, String)	Creates a Message object that represents a WS-Trust RST message.
EndCancel(IAsyncResult, RequestSecurityTokenResponse)	Completes an asynchronous operation to send a WS-Trust Cancel message initiated by the BeginCancel(RequestSecurityToken, AsyncCallback, Object) method.
EndCancel(IAsyncResult)	Completes an asynchronous operation to send a WS-Trust Cancel message initiated by the BeginCancel(Message, AsyncCallback, Object) method.
EndClose(IAsyncResult)	Completes an asynchronous operation to close a communication object.
EndIssue(IAsyncResult, RequestSecurityTokenResponse)	Completes an asynchronous operation to send a WS-Trust Issue message initiated by the BeginIssue(RequestSecurityToken, AsyncCallback, Object) method.
EndIssue(IAsyncResult)	Completes an asynchronous operation to send a WS-Trust Issue message initiated by the BeginIssue(Message, AsyncCallback, Object) method.
EndOpen(IAsyncResult)	Completes an asynchronous operation to open a communication object.
EndRenew(IAsyncResult, RequestSecurityTokenResponse)	Completes an asynchronous operation to send a WS-Trust Renew message initiated by the BeginRenew(RequestSecurityToken, AsyncCallback, Object) method.
EndRenew(IAsyncResult)	Completes an asynchronous operation to send a WS-Trust Renew message initiated by the BeginRenew(Message, AsyncCallback, Object) method.
EndValidate(IAsyncResult, RequestSecurityTokenResponse)	Completes an asynchronous operation to send a WS-Trust Validate message initiated by the BeginValidate(RequestSecurityToken, AsyncCallback, Object) method.
EndValidate(IAsyncResult)	Completes an asynchronous operation to send a WS-Trust Validate message initiated by the BeginValidate(Message, AsyncCallback, Object) method.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetProperty<T>()	Returns a typed object requested, if present, from the appropriate layer in the channel stack.
GetRequestAction(String, TrustVersion)	Gets the WS-Addressing SOAP action that corresponds to the specified request type and WS-Trust version.
GetTokenFromResponse(RequestSecurityToken, RequestSecurityTokenResponse)	Gets the security token from the RSTR.
GetType()	Gets the Type of the current instance. (Inherited from Object)
Issue(Message)	Sends a WS-Trust Issue message to an endpoint STS using the specified Message object.
Issue(RequestSecurityToken, RequestSecurityTokenResponse)	Sends a WS-Trust Issue message to an endpoint STS using the specified RequestSecurityToken and RequestSecurityToken objects.
Issue(RequestSecurityToken)	Sends a WS-Trust Issue message to an endpoint STS using the specified RequestSecurityToken object.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Open()	Causes a communication object to transition from the created state into the opened state.
Open(TimeSpan)	Causes a communication object to transition from the created state into the opened state within a specified interval of time.
ReadResponse(Message)	Deserializes a RequestSecurityTokenResponse from a Message received from the WS-Trust endpoint.
Renew(Message)	Sends a WS-Trust Renew message to an endpoint using the specified Message object.
Renew(RequestSecurityToken)	Sends a WS-Trust Renew message to an endpoint using the specified RequestSecurityToken object.
ToString()	Returns a string that represents the current object. (Inherited from Object)
Validate(Message)	Sends a WS-Trust Validate message to an endpoint using the specified Message object.
Validate(RequestSecurityToken)	Sends a WS-Trust Validate message to an endpoint using the specified RequestSecurityToken object.

Events

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

Applies to

Jaa