WSFederationSerializer.CreateRequest Method

2012-10-05

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

Converts a WS-Federation Sign-In Request message to a RequestSecurityToken object that the security token service (the SecurityTokenService class) can consume.

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

Usage

'Usage
Dim instance As WSFederationSerializer
Dim message As WSFederationMessage
Dim context As WSTrustSerializationContext
Dim returnValue As RequestSecurityToken

returnValue = instance.CreateRequest(message, context)

Syntax

'Declaration
Public Overridable Function CreateRequest ( _
    message As WSFederationMessage, _
    context As WSTrustSerializationContext _
) As RequestSecurityToken

public virtual RequestSecurityToken CreateRequest (
    WSFederationMessage message,
    WSTrustSerializationContext context
)

public:
virtual RequestSecurityToken^ CreateRequest (
    WSFederationMessage^ message, 
    WSTrustSerializationContext^ context
)

public RequestSecurityToken CreateRequest (
    WSFederationMessage message, 
    WSTrustSerializationContext context
)

public function CreateRequest (
    message : WSFederationMessage, 
    context : WSTrustSerializationContext
) : RequestSecurityToken

Parameters

message
The message to convert. This should be an instance of SignInRequestMessage.

context
The current serialization context.

Return Value

A RequestSecurityToken object that represents the converted Sign-In Request message.

Exceptions

Exception type	Condition
ArgumentNullException	message is null. -or- context is null.
ArgumentException	The message is not of type SignInRequestMessage. -or- The SignInRequestMessage object is missing required information to construct a valid RequestSecurityToken object.

ArgumentNullException

message is null.

-or-

context is null.

ArgumentException

The message is not of type SignInRequestMessage.

-or-

The SignInRequestMessage object is missing required information to construct a valid RequestSecurityToken object.

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)

Share via