WSFederationMessage Class

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

Defines the base class from which all WS-Federation messages classes derive.

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

Usage

'Usage
Dim instance As WSFederationMessage

Syntax

'Declaration
Public MustInherit Class WSFederationMessage

public abstract class WSFederationMessage

public ref class WSFederationMessage abstract

public abstract class WSFederationMessage

public abstract class WSFederationMessage

Example

The following code example demonstrates the use of the WSFederationMessage class to create a SignInRequestMessage.

 
/// <summary>
/// We perform WS-Federation passive protocol logic in this method and call 
/// out to the appropriate request handlers. 
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>

protected void Page_PreRender( object sender, EventArgs e )
{
// Check whether the user is already authenticated
    if ( IsAuthenticatedUser )
    {
        // Use WSFederationMessage.CreateFromUri to parse the request and 
        // create a WSFederationMessage. 
        WSFederationMessage federationMessage = 
                     WSFederationMessage.CreateFromUri( Request.Url );

        if ( federationMessage.Action == WSFederationConstants.Actions.SignIn )
        {
            // Process the sign in request federationMessage
        }
    }
}
/// <summary>
/// Returns whether the user is authenticated or not. 
/// </summary>
bool IsAuthenticatedUser
{
    get
    {
        return ( ( Page.User != null ) && ( Page.User.Identity != null ) && ( Page.User.Identity.IsAuthenticated ) );
    }
}

Remarks

The WSFederationMessage class represents either a WS-Federation request or a WS-Federation response. Both SignInRequestMessage and SignInResponseMessage derive from WSFederationMessage.

For more information about the message that this class represents, see the WS-Federation specification. You can find links to this specification and other WS-* specifications relevant to WIF in the Windows Identity Foundation SDK topic.

Inheritance Hierarchy

System.Object
  Microsoft.IdentityModel.Protocols.WSFederation.WSFederationMessage
     Derived Classes

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)

Change History

See Also

Reference

WSFederationMessage Members
Microsoft.IdentityModel.Protocols.WSFederation Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.