Export (0) Print
Expand All

WSFederationMessage Class

.NET Framework 4.5

Represents a WS-Federation message and defines the base class from which more specialized WS-Federation message classes derive.

Namespace:  System.IdentityModel.Services
Assembly:  System.IdentityModel.Services (in System.IdentityModel.Services.dll)

public abstract class WSFederationMessage : FederationMessage

The WSFederationMessage type exposes the following members.

Public methodWSFederationMessageInitializes a new instance of the WSFederationMessage class from the base URL to which the message applies and the action to be performed (the wa message parameter).

Public propertyActionGets or sets the wa parameter of the message.
Public propertyBaseUriGets or sets the base URL to which the message applies. (Inherited from FederationMessage.)
Public propertyContextGets or sets the wctx parameter of the message.
Public propertyEncodingGets or sets the wencoding parameter of the message.
Public propertyParametersGets the message parameters as a dictionary. (Inherited from FederationMessage.)

Public methodStatic memberCreateFromFormPostCreates a WS-Federation message from the form post received in the specified request.
Public methodStatic memberCreateFromNameValueCollectionCreates a WS-Federation message from a NameValueCollection of parameters.
Public methodStatic memberCreateFromUriCreates a WS-Federation message from the specified URI. The parameters are assumed to be specified in the query string.
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 methodGetParameterReturns the specified parameter value from the parameters dictionary. (Inherited from FederationMessage.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRemoveParameterRemoves a parameter from the parameters dictionary. (Inherited from FederationMessage.)
Public methodSetParameterSets the value of a parameter in the parameters dictionary. (Inherited from FederationMessage.)
Public methodSetUriParameterSets the value of a parameter in the parameters dictionary. The value must be an absolute URI. (Inherited from FederationMessage.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodStatic memberTryCreateFromUriAttempts to create a WS-Federation message from the specified URI. The parameters are assumed to be specified as a query string.
Protected methodValidateValidates the message. (Inherited from FederationMessage.)
Public methodWriteWhen overridden in a derived class, writes the message to the output stream. (Inherited from FederationMessage.)
Public methodWriteFormPostSerializes the message as a form post and returns the resulting Form together with its Javascript as a string. (Inherited from FederationMessage.)
Public methodWriteQueryStringReturns a string representation of the message in query-string format. (Inherited from FederationMessage.)

The WSFederationMessage class represents either a WS-Federation request or a WS-Federation response. More specialized classes that represent specific WS-Federation messages derive from WSFederationMessage; for example, the SignInRequestMessage class, which represents a WS-Federation sign-in request message.

The WSFederationMessage class exposes several properties that can be used to set or access individual message parameters. These parameters can also be set or accessed through the Parameters dictionary. For example, you can read the wencoding parameter in the message either through the Encoding property or by specifying “wencoding” as the key to the Parameters dictionary.

The WSFederationMessage contains static methods that you can call to create the appropriate WS-Federation message from: a URL that includes a query string; a base URL and a collection of WS-Federation parameter names and values; or form post data in an HTTP request.

For more information about the message that this class represents, see section 13 of the following specification: Web Services Federation Language (WS-Federation) Version 1.2 (http://go.microsoft.com/fwlink/?LinkID=210152).

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5

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.
© 2014 Microsoft