WSHttpBinding Class

 

Represents an interoperable binding that supports distributed transactions and secure, reliable sessions.

Namespace:   System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)


Public Class WSHttpBinding
	Inherits WSHttpBindingBase

NameDescription
System_CAPS_pubmethodWSHttpBinding()

Initializes a new instance of the WSHttpBinding class.

System_CAPS_pubmethodWSHttpBinding(SecurityMode)

Initializes a new instance of the WSHttpBinding class with a specified type of security used by the binding.

System_CAPS_pubmethodWSHttpBinding(SecurityMode, Boolean)

Initializes a new instance of the WSHttpBinding class with a specified type of security used by the binding and a value that indicates whether a reliable session is enabled.

System_CAPS_pubmethodWSHttpBinding(String)

Initializes a new instance of the WSHttpBinding class with a binding specified by its configuration name.

NameDescription
System_CAPS_pubpropertyAllowCookies

Gets or sets a value that indicates whether the WCF client will automatically store and resend any cookies sent by a single web service.

System_CAPS_pubpropertyBypassProxyOnLocal

Gets or sets a value that indicates whether to bypass the proxy server for local addresses.(Inherited from WSHttpBindingBase.)

System_CAPS_pubpropertyCloseTimeout

Gets or sets the interval of time provided for a connection to close before the transport raises an exception.(Inherited from Binding.)

System_CAPS_pubpropertyEnvelopeVersion

Gets the version of SOAP that is used for messages that are processed by this binding.(Inherited from WSHttpBindingBase.)

System_CAPS_pubpropertyHostNameComparisonMode

Gets or sets a value that indicates whether the hostname is used to reach the service when matching the URI.(Inherited from WSHttpBindingBase.)

System_CAPS_pubpropertyMaxBufferPoolSize

Gets or sets the maximum amount of memory allocated, in bytes, for the buffer manager that manages the buffers required by endpoints using this binding.(Inherited from WSHttpBindingBase.)

System_CAPS_pubpropertyMaxReceivedMessageSize

Gets or sets the maximum size, in bytes, for a message that can be processed by the binding.(Inherited from WSHttpBindingBase.)

System_CAPS_pubpropertyMessageEncoding

Gets or sets whether MTOM or Text/XML is used to encode SOAP messages.(Inherited from WSHttpBindingBase.)

System_CAPS_pubpropertyMessageVersion

Gets the message version used by clients and services configured with the binding.(Inherited from Binding.)

System_CAPS_pubpropertyName

Gets or sets the name of the binding.(Inherited from Binding.)

System_CAPS_pubpropertyNamespace

Gets or sets the XML namespace of the binding.(Inherited from Binding.)

System_CAPS_pubpropertyOpenTimeout

Gets or sets the interval of time provided for a connection to open before the transport raises an exception.(Inherited from Binding.)

System_CAPS_pubpropertyProxyAddress

Gets or sets the URI address of the HTTP proxy.(Inherited from WSHttpBindingBase.)

System_CAPS_pubpropertyReaderQuotas

Gets or sets constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding.(Inherited from WSHttpBindingBase.)

System_CAPS_pubpropertyReceiveTimeout

Gets or sets the interval of time that a connection can remain inactive, during which no application messages are received, before it is dropped.(Inherited from Binding.)

System_CAPS_pubpropertyReliableSession

Gets an object that provides convenient access to the properties of a reliable session binding element that are available when using one of the system-provided bindings.(Inherited from WSHttpBindingBase.)

System_CAPS_pubpropertyScheme

Gets the URI transport scheme for the channels and listeners that are configured with this binding.(Inherited from WSHttpBindingBase.)

System_CAPS_pubpropertySecurity

Gets the security settings used with this binding.

System_CAPS_pubpropertySendTimeout

Gets or sets the interval of time provided for a write operation to complete before the transport raises an exception.(Inherited from Binding.)

System_CAPS_pubpropertyTextEncoding

Gets or sets the character encoding that is used for the message text.(Inherited from WSHttpBindingBase.)

System_CAPS_pubpropertyTransactionFlow

Gets or sets a value that indicates whether this binding should support flowing WS-Transactions.(Inherited from WSHttpBindingBase.)

System_CAPS_pubpropertyUseDefaultWebProxy

Gets or sets a value that indicates whether the auto-configured HTTP proxy of the system should be used, if available.(Inherited from WSHttpBindingBase.)

NameDescription
System_CAPS_pubmethodBuildChannelFactory(Of TChannel)(BindingParameterCollection)

Builds the channel factory stack on the client that creates a specified type of channel and that satisfies the features specified by a collection of binding parameters.(Overrides Binding.BuildChannelFactory(Of TChannel)(BindingParameterCollection).)

System_CAPS_pubmethodBuildChannelFactory(Of TChannel)(Object())

Builds the channel factory stack on the client that creates a specified type of channel and that satisfies the features specified by an object array.(Inherited from Binding.)

System_CAPS_pubmethodBuildChannelListener(Of TChannel)(BindingParameterCollection)

Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified by a collection of binding parameters.(Inherited from Binding.)

System_CAPS_pubmethodBuildChannelListener(Of TChannel)(Object())

Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified.(Inherited from Binding.)

System_CAPS_pubmethodBuildChannelListener(Of TChannel)(Uri, BindingParameterCollection)

Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified.(Inherited from Binding.)

System_CAPS_pubmethodBuildChannelListener(Of TChannel)(Uri, Object())

Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified.(Inherited from Binding.)

System_CAPS_pubmethodBuildChannelListener(Of TChannel)(Uri, String, BindingParameterCollection)

Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified.(Inherited from Binding.)

System_CAPS_pubmethodBuildChannelListener(Of TChannel)(Uri, String, ListenUriMode, BindingParameterCollection)

Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified.(Inherited from Binding.)

System_CAPS_pubmethodBuildChannelListener(Of TChannel)(Uri, String, ListenUriMode, Object())

Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified.(Inherited from Binding.)

System_CAPS_pubmethodBuildChannelListener(Of TChannel)(Uri, String, Object())

Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified.(Inherited from Binding.)

System_CAPS_pubmethodCanBuildChannelFactory(Of TChannel)(BindingParameterCollection)

Returns a value that indicates whether the current binding can build a channel factory stack on the client that satisfies the collection of binding parameters specified.(Inherited from Binding.)

System_CAPS_pubmethodCanBuildChannelFactory(Of TChannel)(Object())

Returns a value that indicates whether the current binding can build a channel factory stack on the client that satisfies the requirements specified by an object array.(Inherited from Binding.)

System_CAPS_pubmethodCanBuildChannelListener(Of TChannel)(BindingParameterCollection)

Returns a value that indicates whether the current binding can build a channel listener stack on the service that satisfies the collection of binding parameters specified.(Inherited from Binding.)

System_CAPS_pubmethodCanBuildChannelListener(Of TChannel)(Object())

Returns a value that indicates whether the current binding can build a channel listener stack on the service that satisfies the criteria specified in an array of objects.(Inherited from Binding.)

System_CAPS_pubmethodCreateBindingElements()

Returns an ordered collection of binding elements contained in the current binding.(Overrides WSHttpBindingBase.CreateBindingElements().)

System_CAPS_protmethodCreateMessageSecurity()

Returns the security binding element from the current binding.(Overrides WSHttpBindingBase.CreateMessageSecurity().)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetProperty(Of T)(BindingParameterCollection)

Returns a typed object requested, if present, from the appropriate layer in the binding stack.(Inherited from Binding.)

System_CAPS_protmethodGetTransport()

Returns the transport binding element from the current binding.(Overrides WSHttpBindingBase.GetTransport().)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodShouldSerializeName()

Returns whether the name of the binding should be serialized.(Inherited from Binding.)

System_CAPS_pubmethodShouldSerializeNamespace()

Returns whether the namespace of the binding should be serialized.(Inherited from Binding.)

System_CAPS_pubmethodShouldSerializeReaderQuotas()

Returns a value that indicates whether the ReaderQuotas property has changed from its default value and should be serialized.(Inherited from WSHttpBindingBase.)

System_CAPS_pubmethodShouldSerializeReliableSession()

Returns a value that indicates whether the ReliableSession property has changed from its default value and should be serialized.(Inherited from WSHttpBindingBase.)

System_CAPS_pubmethodShouldSerializeSecurity()

Returns a value that indicates whether the Security property has changed from its default value and should be serialized.

System_CAPS_pubmethodShouldSerializeTextEncoding()

Returns a value that indicates whether the TextEncoding property has changed from its default value and should be serialized.(Inherited from WSHttpBindingBase.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privpropertyIBindingRuntimePreferences.ReceiveSynchronously

Gets a value that indicates whether incoming requests are handled synchronously or asynchronously.(Inherited from WSHttpBindingBase.)

The WSHttpBinding is similar to the BasicHttpBinding but provides more Web service features. It uses the HTTP transport and provides message security, as does BasicHttpBinding, but it also provides transactions, reliable messaging, and WS-Addressing, either enabled by default or available through a single control setting.

The following sample code shows how to use the WSHttpBinding class.


Imports System
Imports System.ServiceModel
Imports System.Collections.Generic
Imports System.IdentityModel.Tokens
Imports System.Security.Cryptography.X509Certificates
Imports System.ServiceModel.Channels
Imports System.ServiceModel.Security
Imports System.ServiceModel.Security.Tokens
Imports System.Security.Permissions

' Define a service contract for the calculator. 
<ServiceContract()> _
Public Interface ICalculator
	<OperationContract(IsOneWay := False)> _
	Function Add(ByVal n1 As Double, ByVal n2 As Double) As Double
	<OperationContract(IsOneWay := False)> _
	Function Subtract(ByVal n1 As Double, ByVal n2 As Double) As Double
	<OperationContract(IsOneWay := False)> _
	Function Multiply(ByVal n1 As Double, ByVal n2 As Double) As Double
	<OperationContract(IsOneWay := False)> _
	Function Divide(ByVal n1 As Double, ByVal n2 As Double) As Double
End Interface

Public NotInheritable Class CustomBindingCreator

	Public Shared Sub snippetSecurity()
		Dim wsHttpBinding As New WSHttpBinding()
		Dim whSecurity As WSHttpSecurity = wsHttpBinding.Security
	End Sub


	Public Shared Sub snippetCreateBindingElements()
		Dim wsHttpBinding As New WSHttpBinding()
		Dim beCollection As BindingElementCollection = wsHttpBinding.CreateBindingElements()
	End Sub


	Private Sub snippetCreateMessageSecurity()
		Dim wsHttpBinding As New WSHttpBinding()
	End Sub

	Public Shared Sub snippetGetTransport()
		Dim wsHttpBinding As New WSHttpBinding()
	End Sub

	Public Shared Sub snippetAllowCookies()
		Dim wsHttpBinding As New WSHttpBinding()
		wsHttpBinding.AllowCookies = True
	End Sub

	Public Shared Function GetBinding() As Binding
		' securityMode is Message
		' reliableSessionEnabled is true
		Dim binding As New WSHttpBinding(SecurityMode.Message, True)
		binding.Security.Message.ClientCredentialType = MessageCredentialType.Windows

		Dim security As WSHttpSecurity = binding.Security
		Return binding

	End Function

	Public Shared Function GetBinding2() As Binding

		' The security mode is set to Message.
		Dim binding As New WSHttpBinding(SecurityMode.Message)
		binding.Security.Message.ClientCredentialType = MessageCredentialType.Windows
		Return binding

	End Function

	' This method creates a WSFederationHttpBinding.
	Public Shared Function CreateWSFederationHttpBinding() As WSFederationHttpBinding
		' Create an instance of the WSFederationHttpBinding
		Dim b As New WSFederationHttpBinding()

		' Set the security mode to Message
		b.Security.Mode = WSFederationHttpSecurityMode.Message

		' Set the Algorithm Suite to Basic256Rsa15
		b.Security.Message.AlgorithmSuite = SecurityAlgorithmSuite.Basic256Rsa15

		' Set NegotiateServiceCredential to true
		b.Security.Message.NegotiateServiceCredential = True

		' Set IssuedKeyType to Symmetric
		b.Security.Message.IssuedKeyType = SecurityKeyType.SymmetricKey

		' Set IssuedTokenType to SAML 1.1
		b.Security.Message.IssuedTokenType = "http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#samlv1.1"

		' Extract the STS certificate from the certificate store
		Dim store As New X509Store(StoreName.TrustedPeople, StoreLocation.CurrentUser)
		store.Open(OpenFlags.ReadOnly)
        Dim certs As X509Certificate2Collection = store.Certificates.Find(X509FindType.FindByThumbprint, "cd 54 88 85 0d 63 db ac 92 59 05 af ce b8 b1 de c3 67 9e 3f", False)
		store.Close()

		' Create an EndpointIdentity from the STS certificate
		Dim identity As EndpointIdentity = EndpointIdentity.CreateX509CertificateIdentity(certs(0))

		' Set the IssuerAddress using the address of the STS and the previously created EndpointIdentity
		b.Security.Message.IssuerAddress = New EndpointAddress(New Uri("http://localhost:8000/sts/x509"), identity)

		' Set the IssuerBinding to a WSHttpBinding loaded from config
		b.Security.Message.IssuerBinding = New WSHttpBinding("Issuer")

		' Set the IssuerMetadataAddress using the metadata address of the STS and the previously created EndpointIdentity
		b.Security.Message.IssuerMetadataAddress = New EndpointAddress(New Uri("http://localhost:8001/sts/mex"), identity)

		' Create a ClaimTypeRequirement
		Dim ctr As New ClaimTypeRequirement("http://example.org/claim/c1", False)

		' Add the ClaimTypeRequirement to ClaimTypeRequirements
		b.Security.Message.ClaimTypeRequirements.Add(ctr)

		' Return the created binding
		Return b
	End Function

End Class

' Service class which implements the service contract. 
Public Class CalculatorService
	Implements ICalculator
	Public Function Add(ByVal n1 As Double, ByVal n2 As Double) As Double Implements ICalculator.Add
        Dim result = n1 + n2
		Return result
	End Function
	Public Function Subtract(ByVal n1 As Double, ByVal n2 As Double) As Double Implements ICalculator.Subtract
        Dim result = n1 - n2
		Return result
	End Function
	Public Function Multiply(ByVal n1 As Double, ByVal n2 As Double) As Double Implements ICalculator.Multiply
        Dim result = n1 * n2
		Return result
	End Function
	Public Function Divide(ByVal n1 As Double, ByVal n2 As Double) As Double Implements ICalculator.Divide
        Dim result = n1 / n2
		Return result
	End Function


	' Host the service within this EXE console application. 
	Public Shared Sub Main()
		' Create a WSHttpBinding and set its property values. 
        Dim binding As New WSHttpBinding()
        With binding
            .Name = "binding1"
            .HostNameComparisonMode = HostNameComparisonMode.StrongWildcard
            .Security.Mode = SecurityMode.Message
            .ReliableSession.Enabled = False
            .TransactionFlow = False
        End With

		'Specify a base address for the service endpoint. 
		Dim baseAddress As New Uri("http://localhost:8000/servicemodelsamples/service")
		' Create a ServiceHost for the CalculatorService type 
		' and provide it with a base address. 
		Dim serviceHost As New ServiceHost(GetType(CalculatorService), baseAddress)
		serviceHost.AddServiceEndpoint(GetType(ICalculator), binding, baseAddress)
		' Open the ServiceHostBase to create listeners 
		' and start listening for messages. 
		serviceHost.Open()
		' The service can now be accessed. 
		Console.WriteLine("The service is ready.")
		Console.WriteLine("Press <ENTER> to terminate service.")
		Console.WriteLine()
		Console.ReadLine()
		' Close the ServiceHost to shutdown the service. 
		serviceHost.Close()
	End Sub
End Class

.NET Framework
Available since 3.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: