linux-packaging-mono/mcs/class/System.ServiceModel/Documentation/en/System.ServiceModel/WSFederationHttpBinding.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="WSFederationHttpBinding" FullName="System.ServiceModel.WSFederationHttpBinding">
  <TypeSignature Language="C#" Value="public class WSFederationHttpBinding : System.ServiceModel.WSHttpBindingBase" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WSFederationHttpBinding extends System.ServiceModel.WSHttpBindingBase" />
  <AssemblyInfo>
    <AssemblyName>System.ServiceModel</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.ServiceModel.WSHttpBindingBase</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Federation is the ability to share identities across multiple systems for authentication and authorization. These identities can refer to users or to machines. Federated HTTP supports SOAP security as well as mixed-mode security, but it does not support exclusively using transport security. This binding provides indigo1 support for the WS-Federation protocol. Services configured with this binding must use the HTTP transport. </para>
      <para>Bindings consist of a stack of binding elements. The stack of binding elements in <see cref="T:System.ServiceModel.WSFederationHttpBinding" /> is the same as that contained in <see cref="T:System.ServiceModel.WSHttpBinding" /> when <see cref="P:System.ServiceModel.WSHttpBinding.Security" /> is set to the default value of <see cref="F:System.ServiceModel.WSFederationHttpSecurityMode.Message" />. </para>
      <para>The <see cref="T:System.ServiceModel.WSFederationHttpBinding" /> controls the details of the message security settings, the values of which are available from the instance of <see cref="T:System.ServiceModel.FederatedMessageSecurityOverHttp" /> that is returned by the <see cref="P:System.ServiceModel.WSFederationHttpSecurity.Message" /> property. </para>
      <para>The <see cref="T:System.ServiceModel.WSFederationHttpBinding" /> also provides a <see cref="P:System.ServiceModel.WSFederationHttpBinding.PrivacyNoticeAt" /> property to set and retrieve the URI at which the privacy notice is located. </para>
      <block subset="none" type="note">
        <para>When calling a indigo2 service built with netfx40_short from a WCF client application built with netfx35_short or earlier, the configuration file generated by svcutil.exe or adding a service reference from vsprvs contains the establishSecurityContext attribute in the binding configuration. This attribute is not recognized by the netfx35_short runtime and the application throws an <see cref="T:System.Configuration.ConfigurationErrorsException" /> with the message "Unrecognized attribute establishSecurityContext ". To workaround this problem, remove the establishSecurityContext attribute from the binding configuration.</para>
      </block>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>A secure and interoperable binding that supports federated security.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public WSFederationHttpBinding ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The details of these settings are available from the instance of <see cref="T:System.ServiceModel.FederatedMessageSecurityOverHttp" /> that is returned by the <see cref="P:System.ServiceModel.WSFederationHttpSecurity.Message" /> property.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.ServiceModel.WSFederationHttpBinding" /> class. </para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public WSFederationHttpBinding (System.ServiceModel.WSFederationHttpSecurityMode securityMode);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.ServiceModel.WSFederationHttpSecurityMode securityMode) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="securityMode" Type="System.ServiceModel.WSFederationHttpSecurityMode" />
      </Parameters>
      <Docs>
        <param name="securityMode">To be added.</param>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The default value of <see cref="T:System.ServiceModel.WSFederationHttpSecurityMode" /> is <see cref="F:System.ServiceModel.WSFederationHttpSecurityMode.Message" /> which specifies that integrity, confidentiality, and server and client authentication are provided using SOAP message security. The details of these settings are available from the instance of <see cref="T:System.ServiceModel.FederatedMessageSecurityOverHttp" /> that is returned by the <see cref="P:System.ServiceModel.WSFederationHttpSecurity.Message" /> property.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.ServiceModel.WSFederationHttpBinding" /> class with a specified type of security used by the binding.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public WSFederationHttpBinding (string configurationName);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string configurationName) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="configurationName" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="configurationName">To be added.</param>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.ServiceModel.WSFederationHttpBinding" /> class with a binding specified by its configuration name.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public WSFederationHttpBinding (System.ServiceModel.WSFederationHttpSecurityMode securityMode, bool reliableSessionEnabled);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.ServiceModel.WSFederationHttpSecurityMode securityMode, bool reliableSessionEnabled) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="securityMode" Type="System.ServiceModel.WSFederationHttpSecurityMode" />
        <Parameter Name="reliableSessionEnabled" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="securityMode">To be added.</param>
        <param name="reliableSessionEnabled">To be added.</param>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.ServiceModel.WSFederationHttpBinding" /> class with a specified type of security used by the binding and a value that indicates whether a reliable session is enabled.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="AllowCookies">
      <MemberSignature Language="C#" Value="public bool AllowCookies { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool AllowCookies" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateBindingElements">
      <MemberSignature Language="C#" Value="public override System.ServiceModel.Channels.BindingElementCollection CreateBindingElements ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.ServiceModel.Channels.BindingElementCollection CreateBindingElements() cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ServiceModel.Channels.BindingElementCollection</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The stack of binding elements depends on the value of the <see cref="T:System.ServiceModel.WSFederationHttpSecurityMode" /> set.</para>
          <para>The stack of binding elements in <see cref="T:System.ServiceModel.WSFederationHttpBinding" /> is the same as that contained in <see cref="T:System.ServiceModel.WSHttpBinding" /> when <see cref="P:System.ServiceModel.WSHttpBinding.Security" /> is set to the default value of <see cref="F:System.ServiceModel.WSFederationHttpSecurityMode.Message" />. </para>
          <list type="ordered">
            <item>
              <para>
                <see cref="T:System.ServiceModel.Channels.TransactionFlowBindingElement" />
              </para>
            </item>
            <item>
              <para>
                <see cref="T:System.ServiceModel.Channels.SymmetricSecurityBindingElement" />
              </para>
            </item>
            <item>
              <para>
                <see cref="T:System.ServiceModel.Channels.TextMessageEncodingBindingElement" />
              </para>
            </item>
            <item>
              <para>
                <see cref="T:System.ServiceModel.Channels.HttpTransportBindingElement" />
              </para>
            </item>
          </list>
          <para>However, setting <see cref="T:System.ServiceModel.WSFederationHttpSecurityMode" /> to <see cref="F:System.ServiceModel.WSFederationHttpSecurityMode.TransportWithMessageCredential" /> results in a stack that is something of a hybrid between the <see cref="T:System.ServiceModel.WSHttpBinding" /> and <see cref="T:System.ServiceModel.BasicHttpBinding" /> bindings.</para>
          <list type="ordered">
            <item>
              <para>
                <see cref="T:System.ServiceModel.Channels.TransactionFlowBindingElement" />
              </para>
            </item>
            <item>
              <para>
                <see cref="T:System.ServiceModel.Channels.TransportSecurityBindingElement" />
              </para>
            </item>
            <item>
              <para>
                <see cref="T:System.ServiceModel.Channels.TextMessageEncodingBindingElement" />
              </para>
            </item>
            <item>
              <para>
                <see cref="T:System.ServiceModel.Channels.HttpsTransportBindingElement" />
              </para>
            </item>
          </list>
          <para>Finally, using the MTOM encoder looks exactly the same as for <see cref="T:System.ServiceModel.WSHttpBinding" />.</para>
          <list type="ordered">
            <item>
              <para>
                <see cref="T:System.ServiceModel.Channels.TransactionFlowBindingElement" />
              </para>
            </item>
            <item>
              <para>
                <see cref="T:System.ServiceModel.Channels.MtomMessageEncodingBindingElement" />
              </para>
            </item>
            <item>
              <para>
                <see cref="T:System.ServiceModel.Channels.HttpTransportBindingElement" />
              </para>
            </item>
          </list>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Creates a collection with the binding elements for the binding.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="T:System.Collections.Generic.ICollection`1" /> of type <see cref="T:System.ServiceModel.Channels.BindingElement" /> that makes up the binding.</para>
        </returns>
      </Docs>
    </Member>
    <Member MemberName="CreateMessageSecurity">
      <MemberSignature Language="C#" Value="protected override System.ServiceModel.Channels.SecurityBindingElement CreateMessageSecurity ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.ServiceModel.Channels.SecurityBindingElement CreateMessageSecurity() cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ServiceModel.Channels.SecurityBindingElement</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Creates a <see cref="T:System.ServiceModel.Channels.SecurityBindingElement" /> that has enabled a reliable session.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>A <see cref="T:System.ServiceModel.Channels.SecurityBindingElement" /> that has enabled a reliable session.</para>
        </returns>
      </Docs>
    </Member>
    <Member MemberName="GetTransport">
      <MemberSignature Language="C#" Value="protected override System.ServiceModel.Channels.TransportBindingElement GetTransport ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.ServiceModel.Channels.TransportBindingElement GetTransport() cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ServiceModel.Channels.TransportBindingElement</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Returns the transport binding element from the current binding.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="T:System.ServiceModel.Channels.TransportBindingElement" /> from the current binding.</para>
        </returns>
      </Docs>
    </Member>
    <Member MemberName="PrivacyNoticeAt">
      <MemberSignature Language="C#" Value="public Uri PrivacyNoticeAt { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Uri PrivacyNoticeAt" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Uri</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets the URI at which the privacy notice is located.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="PrivacyNoticeVersion">
      <MemberSignature Language="C#" Value="public int PrivacyNoticeVersion { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 PrivacyNoticeVersion" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets the privacy notice version number for the binding.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="Security">
      <MemberSignature Language="C#" Value="public System.ServiceModel.WSFederationHttpSecurity Security { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.WSFederationHttpSecurity Security" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ServiceModel.WSFederationHttpSecurity</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets the type of security used with this binding.  </para>
        </summary>
      </Docs>
    </Member>
  </Members>
</Type>