Class HttpRelayTransportBindingElement

Namespace

Microsoft.ServiceBus

Assembly

Microsoft.ServiceBus.dll

Represents the binding element used to specify an HTTP transport for transmitting messages on the Azure Service Bus.

public class HttpRelayTransportBindingElement : TransportBindingElement, IPolicyExportExtension, IWsdlExportExtension, ITransportTokenAssertionProvider

Inheritance

object

HttpRelayTransportBindingElement

Implements

IPolicyExportExtension

IWsdlExportExtension

ITransportTokenAssertionProvider

Derived

HttpsRelayTransportBindingElement

Constructors

HttpRelayTransportBindingElement()

Initializes a new instance of the HttpRelayTransportBindingElement class.

public HttpRelayTransportBindingElement()

HttpRelayTransportBindingElement(HttpRelayTransportBindingElement)

Initializes a new instance of the HttpRelayTransportBindingElement class, using the specified element to be cloned.

protected HttpRelayTransportBindingElement(HttpRelayTransportBindingElement elementToBeCloned)

Parameters

elementToBeCloned HttpRelayTransportBindingElement

The element to be cloned.

HttpRelayTransportBindingElement(RelayClientAuthenticationType)

Initializes a new instance of the HttpRelayTransportBindingElement class using the specified client authentication type.

public HttpRelayTransportBindingElement(RelayClientAuthenticationType relayClientAuthenticationType)

Parameters

relayClientAuthenticationType RelayClientAuthenticationType

The client authentication type.

Properties

AllowCookies

Gets or sets a value that indicates whether the client accepts cookies and propagates them on future requests.

public bool AllowCookies { get; set; }

Property Value

bool

true if cookies are allowed; otherwise, false. The default is false.

HostNameComparisonMode

Gets or sets the comparison mode use in the host name.

public HostNameComparisonMode HostNameComparisonMode { get; set; }

Property Value

HostNameComparisonMode

The comparison mode use 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.

KeepAliveEnabled

Gets or sets a value that indicates whether to make a persistent connection to a service endpoint.

public bool KeepAliveEnabled { get; set; }

Property Value

bool

true if the request to the service endpoint should contain a Connection HTTP header with the value Keep-alive; otherwise, false. The default is true.

MaxBufferSize

Gets or sets the maximum size of the buffer to use.

public int MaxBufferSize { get; set; }

Property Value

int

Returns the maximum size, in bytes, of the buffer.

ProxyAddress

Gets or sets a URI that contains the address of the proxy to use for HTTP requests.

public Uri ProxyAddress { get; set; }

Property Value

Uri

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

ProxyAuthenticationScheme

Gets or sets the authentication scheme used to authenticate client requests being processed by an HTTP proxy.

public AuthenticationSchemes ProxyAuthenticationScheme { get; set; }

Property Value

AuthenticationSchemes

One of the values of the AuthenticationSchemes enumeration that specifies the protocols used for client authentication on the proxy. The default is Anonymous.

RelayClientAuthenticationType

Gets or sets the relay client authentication type.

public RelayClientAuthenticationType RelayClientAuthenticationType { get; set; }

Property Value

RelayClientAuthenticationType

Returns RelayClientAuthenticationType.Contains the authentication type. The default value is RelayClientAuthenticationType.RelayAccessToken

Scheme

Gets the URI scheme for the transport.

public override string Scheme { get; }

Property Value

string

Returns the URI scheme.

TransferMode

Gets or sets the transfer mode.

public TransferMode TransferMode { get; set; }

Property Value

TransferMode

Returns a System.ServiceModel.TransferMode that contains the transfer mode.

UseDefaultWebProxy

Gets or sets a value that indicates whether the machine-wide proxy settings are used rather than the user specific settings.

public bool UseDefaultWebProxy { get; set; }

Property Value

bool

true if the machine-wide proxy settings are used; otherwise, false. The default is true.

Methods

BuildChannelFactory<TChannel>(BindingContext)

Creates a channel factory that can be used to create a channel.

public override IChannelFactory<TChannel> BuildChannelFactory<TChannel>(BindingContext context)

Parameters

context BindingContext

The binding context for the channel.

Returns

IChannelFactory<TChannel>

The channel factory of the specified type.

Type Parameters

TChannel

BuildChannelListener<TChannel>(BindingContext)

Creates a channel listener for channels of the specified generic type.

public override IChannelListener<TChannel> BuildChannelListener<TChannel>(BindingContext context) where TChannel : class, IChannel

Parameters

context BindingContext

The binding context.

Returns

IChannelListener<TChannel>

A channel listener.

Type Parameters

TChannel

CanBuildChannelFactory<TChannel>(BindingContext)

Determines whether a channel factory of the specified type can be built.

public override bool CanBuildChannelFactory<TChannel>(BindingContext context)

Parameters

context BindingContext

The binding context for the channel.

Returns

bool

true if a channel factory can be built; otherwise, false.

Type Parameters

TChannel

CanBuildChannelListener<TChannel>(BindingContext)

Returns a value that indicates whether the binding element can build a listener for a specific type of channel.

public override bool CanBuildChannelListener<TChannel>(BindingContext context) where TChannel : class, IChannel

Parameters

context BindingContext

The binding context that provides context for the binding element.

Returns

bool

true if the IChannelListener<TChannel> of type IChannel can be built by the binding element; otherwise, false.

Type Parameters

TChannel

Exceptions

ArgumentNullException

context is null.

Clone()

Returns a copy of the binding element object.

public override BindingElement Clone()

Returns

BindingElement

Returns a System.ServiceModel.Channels.BindingElement that contains a deep clone of the original.

CreateInnerChannelBindingElement()

Creates a System.ServiceModel.Channels.HttpTransportBindingElement for the inner channel.

protected virtual HttpTransportBindingElement CreateInnerChannelBindingElement()

Returns

HttpTransportBindingElement

A System.ServiceModel.Channels.HttpTransportBindingElement for the inner channel.

GetProperty<T>(BindingContext)

Gets the specified property from the specified binding context.

public override T GetProperty<T>(BindingContext context) where T : class

Parameters

context BindingContext

The binding context.

Returns

T

The property from the specified binding context.

Type Parameters

T

GetTransportTokenAssertion()

Gets the XML element that represents the transport token used in the security binding.

public XmlElement GetTransportTokenAssertion()

Returns

XmlElement

The transport token used in the security binding.

InitializeInnerChannelBindingElement(HttpTransportBindingElement)

Initializes the specified binding element with the settings from the current instance of theHttpRelayTransportBindingElement binding element.

protected virtual void InitializeInnerChannelBindingElement(HttpTransportBindingElement httpTransportElement)

Parameters

httpTransportElement HttpTransportBindingElement

The binding element to initialize.