ChannelFactoryOperations.CreateChannelActingAs Method (ChannelFactory, SecurityToken)

Article
10/05/2012

[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.]

Creates a channel of a specified type that will augment any token issuance requests with the provided security token as an ActAs element.

Namespace: Microsoft.IdentityModel.Protocols.WSTrust
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim factory As ChannelFactory(Of T)
Dim actAs As SecurityToken
Dim returnValue As T

returnValue = ChannelFactoryOperations.CreateChannelActingAs(factory, actAs)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function CreateChannelActingAs(Of T) ( _
    factory As ChannelFactory(Of T), _
    actAs As SecurityToken _
) As T

[ExtensionAttribute] 
public static T CreateChannelActingAs<T> (
    ChannelFactory<T> factory,
    SecurityToken actAs
)

[ExtensionAttribute] 
public:
generic<typename T>
static T CreateChannelActingAs (
    ChannelFactory<T>^ factory, 
    SecurityToken^ actAs
)

GenericParameters

T
The type of channel produced by the channel factory.

Parameters

factory
The channel factory used to create the channel.

actAs
The SecurityToken to serialize in the ActAs element of the WS-Trust RequestSecurityToken messages sent to the token issuer configured in the channel binding.

Return Value

The IChannel of type T created by the factory.

Exceptions

Exception type	Condition
ArgumentNullException	channelFactory is null.
InvalidOperationException	The channel factory specified by factory was not configured already by calling the factory.ConfigureChannelFactory method.

Remarks

Creates a channel of type T, the generic parameter for the method.

You must call the factory.ConfigureChannelFactory method prior to calling this method.

Thread Safety

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

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)