Class BasicHttpRelayBinding

Namespace

Microsoft.ServiceBus

Assembly

Microsoft.ServiceBus.dll

Represents a binding that a client can use to configure endpoints that can communicate with ASMX-based Web services and other services that conform to the WS-I Basic Profile 1.1.

public class BasicHttpRelayBinding : Binding, IBindingRuntimePreferences

Inheritance

object

BasicHttpRelayBinding

Implements

IBindingRuntimePreferences

Constructors

BasicHttpRelayBinding()

Initializes a new instance of the BasicHttpRelayBinding class.

public BasicHttpRelayBinding()

BasicHttpRelayBinding(EndToEndBasicHttpSecurityMode, RelayClientAuthenticationType)

Initializes a new instance of the BasicHttpRelayBinding class with a specified type of security used by the binding and the authentication type used by the client.

public BasicHttpRelayBinding(EndToEndBasicHttpSecurityMode securityMode, RelayClientAuthenticationType relayClientAuthenticationType)

Parameters

securityMode EndToEndBasicHttpSecurityMode

The type of security used with the SOAP message and for the client.

relayClientAuthenticationType RelayClientAuthenticationType

The type of authentication used by the client.

BasicHttpRelayBinding(string)

Initializes a new instance of the BasicHttpRelayBinding class using the specified configuration.

public BasicHttpRelayBinding(string configurationName)

Parameters

configurationName string

The configuration to use.

Properties

AllowCookies

Gets or sets a value that determines if the client allows cookies.

public bool AllowCookies { get; set; }

Property Value

bool

Returns bool.true to allow cookies; otherwise, false. The default value is false.

EnvelopeVersion

Gets the version of SOAP that is used for messages that are processed by this binding.

public EnvelopeVersion EnvelopeVersion { get; }

Property Value

EnvelopeVersion

Returns System.ServiceModel.EnvelopeVersion.The value that is used with this binding.

HostNameComparisonMode

Gets or sets how the host name should be compared.

public HostNameComparisonMode HostNameComparisonMode { get; set; }

Property Value

HostNameComparisonMode

The comparison method used in the host name.

IsDynamic

Gets or sets whether the binding element is dynamic.

public bool IsDynamic { get; set; }

Property Value

bool

true if the binding element is dynamic; otherwise, false.

MaxBufferPoolSize

Gets or sets the maximum size allowed for a buffer pool that stores TCP messages processed by the binding.

public long MaxBufferPoolSize { get; set; }

Property Value

long

The maximum size allowed for a buffer pool that stores TCP messages processed by the binding.

MaxBufferSize

Gets or sets the maximum size for a buffer that receives messages from the channel.

public int MaxBufferSize { get; set; }

Property Value

int

Returns int.The maximum size, in bytes, of a buffer that stores messages while they are processed for an endpoint configured with this binding. The default value is 65,536 bytes.

MaxReceivedMessageSize

Gets or sets the maximum size for a message that can be received on a channel configured with this binding.

public long MaxReceivedMessageSize { get; set; }

Property Value

long

Returns long.The maximum size, in bytes, for a message that is processed by the binding. The default value is 65,536 bytes.

MessageEncoding

Gets or sets the type of message encoding.

public WSMessageEncoding MessageEncoding { get; set; }

Property Value

WSMessageEncoding

Returns a System.ServiceModel.WSMessageEncoding that contains the type of message encoding. The default value is Text.

ProxyAddress

Gets or sets the proxy address.

public Uri ProxyAddress { get; set; }

Property Value

Uri

Returns a System.Uri that contains the proxy address. The default value is null.

ReaderQuotas

Gets or sets the reader quotas.

public XmlDictionaryReaderQuotas ReaderQuotas { get; set; }

Property Value

XmlDictionaryReaderQuotas

Returns a System.Xml.XmlDictionaryReaderQuotas that specifies the complexity constraints on SOAP messages exchanged. The default values for these constraints are provided in the following Remarks section.

Scheme

Gets the URI transport scheme for the channels and listeners that are configured with this binding.

public override string Scheme { get; }

Property Value

string

The URI transport scheme for the channels and listeners that are configured with this binding.

Security

Gets the collection of security bindings used with this binding.

public BasicHttpRelaySecurity Security { get; }

Property Value

BasicHttpRelaySecurity

Returns a BasicHttpRelaySecurity that contains the security settings used in the binding. The default value has EndToEndBasicSecurityMode set to Transport, RelayClientAuthenticationType set to RelayAccessToken, HttpRelayTransportSecurity with HttypProxyCredentialType of None, and BasicHttpRelayMessageSecurity with ClientCredentialType of BasicHttpMessageCredentialType.UserName and an AlgorithmSuite of SecurityAlgorithmSuite.Basic256.

TextEncoding

Gets or sets the character encoding that is used for the message text.

public Encoding TextEncoding { get; set; }

Property Value

Encoding

Returns a Encoding that indicates the character encoding that is used. The default is UTF8Encoding.

TransferMode

Gets or sets the transfer mode.

public TransferMode TransferMode { get; set; }

Property Value

TransferMode

Returns a System.ServiceModel.TransferMode that indicates whether the service configured with the binding uses streamed or buffered (or both) modes of message transfer. By default, the HTTP, TCP/IP, and named pipe transports use buffered message transfers. The default value is buffered.

UseDefaultWebProxy

Gets or sets a value that determines if the client uses the default web proxy.

public bool UseDefaultWebProxy { get; set; }

Property Value

bool

Returns true if the client uses the default web proxy; otherwise, false. The default is true.

Methods

CreateBindingElements()

Returns an ordered collection of binding elements contained in the current binding.

public override BindingElementCollection CreateBindingElements()

Returns

BindingElementCollection

Returns System.ServiceModel.Channels.BindingElementCollection.Contains the ordered stack of binding elements described by the BasicHttpRelayBinding. The order of the binding elements starting from the bottom is transport, encoding, and security.