Export (0) Print
Expand All

WebHttpRelayBindingElement Class

A binding element used to configure endpoints for an Windows Azure Service Bus relay service that responds to HTTP requests instead of SOAP messages.


Namespace:  Microsoft.ServiceBus.Configuration
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)

public class WebHttpRelayBindingElement : StandardBindingElement

The WebHttpRelayBindingElement type exposes the following members.

Public methodWebHttpRelayBindingElement()Initializes a new instance of the WebHttpRelayBindingElement class.
Public methodWebHttpRelayBindingElement(String)Initializes a new instance of the WebHttpRelayBindingElement class using the specified name.

Public propertyAllowCookiesGets or sets a value that indicates whether the client accepts cookies and propagates them on future requests.
Protected propertyBindingElementTypeGets the type of binding that this configuration element represents. (Overrides StandardBindingElement.BindingElementType.)
Public propertyCloseTimeout (Inherited from StandardBindingElement.)
Public propertyCurrentConfiguration (Inherited from ConfigurationElement.)
Public propertyElementInformation (Inherited from ConfigurationElement.)
Protected propertyElementProperty (Inherited from ConfigurationElement.)
Protected propertyEvaluationContext (Inherited from ConfigurationElement.)
Protected propertyHasContext (Inherited from ConfigurationElement.)
Public propertyIsDynamicGets or sets whether the binding element is dynamic.
Protected propertyItem[ConfigurationProperty] (Inherited from ConfigurationElement.)
Protected propertyItem[String] (Inherited from ConfigurationElement.)
Public propertyLockAllAttributesExcept (Inherited from ConfigurationElement.)
Public propertyLockAllElementsExcept (Inherited from ConfigurationElement.)
Public propertyLockAttributes (Inherited from ConfigurationElement.)
Public propertyLockElements (Inherited from ConfigurationElement.)
Public propertyLockItem (Inherited from ConfigurationElement.)
Public propertyMaxBufferPoolSizeGets or sets the maximum amount of memory allocated for the buffer manager that manages the buffers required by endpoints that use this binding.
Public propertyMaxBufferSizeGets or sets the maximum amount of memory that is allocated for use by the manager of the message buffers that receive messages from the channel.
Public propertyMaxReceivedMessageSizeGets or sets the maximum size for a message that can be processed by the binding.
Public propertyName (Inherited from StandardBindingElement.)
Public propertyOpenTimeout (Inherited from StandardBindingElement.)
Protected propertyPropertiesGets a collection of objects that can be attributes or configuration element objects of this configuration element. (Overrides StandardBindingElement.Properties.)
Public propertyProxyAddressGets or sets the URI address of the HTTP proxy.
Public propertyReaderQuotasGets or sets the configuration element that contains the constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding.
Public propertyReceiveTimeout (Inherited from StandardBindingElement.)
Public propertySecurityGets the configuration element that contains the security settings used with this binding.
Public propertySendTimeout (Inherited from StandardBindingElement.)
Public propertyTransferModeGets or sets a value that indicates whether the service configured with the associated binding uses streamed or buffered (or both) modes of message transfer.
Public propertyUseDefaultWebProxyGets or sets a value that indicates whether the auto-configured HTTP proxy of the system should be used with the associated binding, if available.
Public propertyWriteEncodingGets or sets the character encoding that is used for the message text in the associated binding.

Public methodApplyConfiguration (Inherited from StandardBindingElement.)
Protected methodDeserializeElement (Inherited from ConfigurationElement.)
Public methodEquals (Inherited from ConfigurationElement.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from ConfigurationElement.)
Protected methodGetTransformedAssemblyString (Inherited from ConfigurationElement.)
Protected methodGetTransformedTypeString (Inherited from ConfigurationElement.)
Public methodGetType (Inherited from Object.)
Protected methodInit (Inherited from ConfigurationElement.)
Protected methodInitializeDefault (Inherited from ConfigurationElement.)
Protected methodInitializeFromInitializes the contents of this binding configuration element from the property values of a specified binding. (Overrides StandardBindingElement.InitializeFrom(Binding).)
Protected methodIsModified (Inherited from ConfigurationElement.)
Public methodIsReadOnly (Inherited from ConfigurationElement.)
Protected methodListErrors (Inherited from ConfigurationElement.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodOnApplyConfigurationApplies the settings of this configuration element to the specified binding. (Overrides StandardBindingElement.OnApplyConfiguration(Binding).)
Protected methodOnDeserializeUnrecognizedAttribute (Inherited from ConfigurationElement.)
Protected methodOnDeserializeUnrecognizedElement (Inherited from ConfigurationElement.)
Protected methodOnRequiredPropertyNotFound (Inherited from ConfigurationElement.)
Protected methodPostDeserialize (Inherited from ConfigurationElement.)
Protected methodPreSerialize (Inherited from ConfigurationElement.)
Protected methodResetSecurity Critical. (Inherited from StandardBindingElement.)
Protected methodResetModified (Inherited from ConfigurationElement.)
Protected methodSerializeElement (Inherited from ConfigurationElement.)
Protected methodSerializeToXmlElement (Inherited from ConfigurationElement.)
Protected methodSetPropertyValue (Inherited from ConfigurationElement.)
Protected methodSetPropertyValueIfNotDefaultValue``1 (Inherited from ServiceModelConfigurationElement.)
Protected methodSetReadOnly (Inherited from ConfigurationElement.)
Public methodToString (Inherited from Object.)
Protected methodUnmerge (Inherited from ConfigurationElement.)

Windows Azure Service Bus supports only Full Trust code access security.

This type is used by Windows Azure Service Bus to read information from an App.config file and create the corresponding binding. You can also access the binding programmatically, through WebHttpRelayBinding. As such, you will not likely to use WebHttpRelayBindingElement directly, but instead use it indirectly whenever you configure a binding in an App.config file. For more information on setting Windows Azure Service Bus configuration values, see Configuring an AppFabric Service Bus Application.

However, you can use WebHttpRelayBindingElement to create your own custom relay bindings, based on WebHttpRelayBinding. Custom bindings are optimized collections of transport, encoding, and security elements, along with other features. For more information, see Creating a Custom AppFabric Service Bus Binding.

The Windows Azure Service Bus programming model allows developers to expose a service through HTTP requests that use "plain old XML" (POX) style messaging instead of SOAP-based messaging. For a client to communicate with a service using HTTP requests, an endpoint of the service must be configured with the WebHttpRelayBinding that has the WebHttpBehavior attached to it. The Web model also requires that the individual operations are annotated with either the WebGetAttribute or the WebInvokeAttribute to bind them to a unique combination of HTTP method, such as POST (the default) or GET, and a URI path suffix, which defaults to the operation name.

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

Community Additions

© 2014 Microsoft