FederationMessage Class

.NET Framework 4.5

Defines the base class from which all federation message classes derive.

System.Object
  System.IdentityModel.Services.FederationMessage
    System.IdentityModel.Services.WSFederationMessage

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

public abstract class FederationMessage

The FederationMessage type exposes the following members.

  NameDescription
Protected methodFederationMessageCalled from constructors in derived classes to initialize the FederationMessage class.
Top

  NameDescription
Public propertyBaseUriGets or sets the base URL to which the message applies.
Public propertyParametersGets the message parameters as a dictionary.
Top

  NameDescription
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 methodStatic memberGetBaseUrlHelper method that extracts the base URL from the specified URI.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetParameterReturns the specified parameter value from the parameters dictionary.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodStatic memberParseQueryStringHelper method that parses the query string in the specified URI into a NameValueCollection.
Public methodRemoveParameterRemoves a parameter from the parameters dictionary.
Public methodSetParameterSets the value of a parameter in the parameters dictionary.
Public methodSetUriParameterSets the value of a parameter in the parameters dictionary. The value must be an absolute URI.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodValidateValidates the message.
Public methodWriteWhen overridden in a derived class, writes the message to the output stream.
Public methodWriteFormPostSerializes the message as a form post and returns the resulting Form together with its Javascript as a string.
Public methodWriteQueryStringReturns a string representation of the message in query-string format.
Top

Notes to Inheritors

At a minimum, you must override the ProviderIdentifier property and the Write method in derived classes.

.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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft