ListenUriEndpointBehavior
The next step is to create the ListenUriEndpointBehavior. This topic lists the code to create the ListenUriEndpointBehavior.
ListenUriEndpointBehavior
This whitepaper demonstrates how to define a WCF-Custom receive location to read messages from a Service Bus queue or subscription. When defining a WCF service endpoint to consume messages from a subscription, you specify the topic URL as the address of the service endpoint and the subscription URL as its listenUri. When configuring a WCF receive location using the WCF-Custom adapter, the General tab has a textbox for specifying the service endpoint address. However, there is no field to specify the listenUri and ListenUriMode properties. For this reason, a custom endpoint behavior is created so at runtime, you can set these values for a WCF-Custom receive location. In the first attempt, AddBindingParameters and ApplyDispatchBehavior methods exposed by the custom endpoint behavior are used to set the listenUri and ListenUriMode of the service endpoint passed as a parameter to both methods. However, this technique didn't work as expected.
Next, a binding extension element class called ListenUriBehaviorExtensionElement to register the custom endpoint behavior in the machine.config file is created. This component exposes a property called listenUri that allows a user to specify the URL of a subscription when configuring a WCF-Custom receive location. At runtime, the ListenUriBehaviorExtensionElement component creates an instance of the ListenUriEndpointBehavior class. The AddBindingParameters method of the custom endpoint behavior replaces the original binding with a CustomBinding that contains the same binding elements and injects an instance of the ListenUriBindingElement at the top of the binding. This way, at runtime, the custom binding executes first. Finally, the BuildChannelListener method of the ListenUriBindingElement assigns the URL specified in the configuration of the receive location to the ListenUriBaseAddress property of the BindingContext and sets the value of its ListenUriMode property to Explicit. For convenience, the following code is for these three classes. Later in the solution, we show you how to use this component when defining a WCF-Custom receive location that receives messages from a Service Bus subscription.
public class ListenUriBehaviorExtensionElement : IEndpointBehavior
{
#region Private Constants
//***************************
// Constants
//***************************
private const string ListenUriName = "listenUri";
private const string IsTrackingEnabledName = "isTrackingEnabled";
private const string ListenUriDescription = "Gets or sets the URI at which the service endpoint listens.";
private const string IsTrackingEnabledDescription = "Gets or sets a value indicating whether tracking is enabled.";
#endregion
#region BehaviorExtensionElement Members
//***************************
// Protected Methods
//***************************
/// <summary>
/// Creates a behavior extension based on the current configuration settings.
/// </summary>
/// <returns>The behavior extension.</returns>
protected override object CreateBehavior()
{
return new ListenUriEndpointBehavior(ListenUri, IsTrackingEnabled);
}
/// <summary>
/// Gets the type of behavior.
/// </summary>
public override Type BehaviorType
{
get
{
return typeof(ListenUriEndpointBehavior);
}
}
#endregion
#region Public Properties
/// <summary>
/// Gets or sets the URI at which the service endpoint listens.
/// </summary>
[ConfigurationProperty(ListenUriName, IsRequired = true)]
[SettingsDescription(ListenUriDescription)]
public string ListenUri
{
get
{
return (string)base[ListenUriName];
}
set
{
base[ListenUriName] = value;
}
}
/// <summary>
/// Gets or sets a value indicating whether the message inspector is enabled.
/// </summary>
[ConfigurationProperty(IsTrackingEnabledName, DefaultValue = true, IsRequired = false)]
[SettingsDescription(IsTrackingEnabledDescription)]
public bool IsTrackingEnabled
{
get
{
return (bool)base[IsTrackingEnabledName];
}
set
{
base[IsTrackingEnabledName] = value;
}
}
#endregion
}
public class ListenUriEndpointBehavior : IEndpointBehavior
{
#region Private Constants
//***************************
// Constants
//***************************
private const string ListerUriMessageFormat = "[ListenUriEndpointBehavior] ListenUri = [{0}].";
#endregion
#region Public Constructors
private readonly string listenUri;
private readonly bool isTrackingEnabled;
#endregion
#region Public Constructors
/// <summary>
/// Initializes a new instance of the ListenUriEndpointBehavior class.
/// </summary>
/// <param name="listenUri">The URI at which the service endpoint listens</param>
/// <param name="isTrackingEnabled">A boolean value indicating whether tracking is enabled</param>
public ListenUriEndpointBehavior(string listenUri, bool isTrackingEnabled)
{
this.listenUri = listenUri;
this.isTrackingEnabled = isTrackingEnabled;
}
#endregion
#region IEndpointBehavior Members
/// <summary>
/// Implement to pass data at runtime to bindings to support custom behavior.
/// </summary>
/// <param name="endpoint">The endpoint to modify.</param>
/// <param name="bindingParameters">The objects that binding elements require to support the behavior.</param>
void IEndpointBehavior.AddBindingParameters(ServiceEndpoint endpoint, BindingParameterCollection bindingParameters)
{
if (endpoint != null &&
!String.IsNullOrEmpty(listenUri))
{
// Read the binding elements from the original binding
var bindingElementCollection = endpoint.Binding.CreateBindingElements();
// Create an array of binding elements
var bindingElementArray = new BindingElement[bindingElementCollection.Count + 1];
// Add an instance of the ListenUriBindingElement as first binding element of the array
bindingElementArray[0] = new ListenUriBindingElement(listenUri);
// Copy the binding elements of the original binding to the array
bindingElementCollection.CopyTo(bindingElementArray, 1);
// Create a custom binding with the same binding elements as the original
// binding with the addition of the custom binding as first item
var customBinding = new CustomBinding(bindingElementArray)
{
CloseTimeout = endpoint.Binding.CloseTimeout,
OpenTimeout = endpoint.Binding.OpenTimeout,
ReceiveTimeout = endpoint.Binding.ReceiveTimeout,
SendTimeout = endpoint.Binding.SendTimeout,
Name = endpoint.Binding.Name,
Namespace = endpoint.Binding.Namespace
};
//Replace the original binding with the newly created binding
endpoint.Binding = customBinding;
Trace.WriteLineIf(isTrackingEnabled,
string.Format(ListerUriMessageFormat,
listenUri));
}
}
/// <summary>
/// Implements a modification or extension of the client across an endpoint.
/// </summary>
/// <param name="endpoint">The endpoint that is to be customized.</param>
/// <param name="clientRuntime">The client runtime to be customized.</param>
void IEndpointBehavior.ApplyClientBehavior(ServiceEndpoint endpoint, ClientRuntime clientRuntime)
{
}
/// <summary>
/// Implements a modification or extension of the service across an endpoint.
/// </summary>
/// <param name="endpoint">The endpoint that exposes the contract.</param>
/// <param name="endpointDispatcher">The endpoint dispatcher to be modified or extended.</param>
void IEndpointBehavior.ApplyDispatchBehavior(ServiceEndpoint endpoint, EndpointDispatcher endpointDispatcher)
{
}
/// <summary>
/// Implement to confirm that the endpoint meets some intended criteria.
/// </summary>
/// <param name="endpoint">The endpoint to validate.</param>
void IEndpointBehavior.Validate(ServiceEndpoint endpoint)
{
}
#endregion
}
public class ListenUriBindingElement : BindingElement
{
#region Private Fields
private readonly string listenUri;
#endregion
#region Public Constructor
/// <summary>
/// Initializes a new instance of the ListenUriBindingElement class.
/// </summary>
/// <param name="listenUri">A BindingElement object that is a deep clone of the original.</param>
public ListenUriBindingElement(string listenUri)
{
this.listenUri = listenUri;
}
#endregion
#region BindingElement Members
/// <summary>
/// returns a copy of the binding element object.
/// </summary>
/// <returns></returns>
public override BindingElement Clone()
{
return new ListenUriBindingElement(listenUri);
}
/// <summary>
/// Returns a typed object requested, if present, from the appropriate layer in the binding stack.
/// </summary>
/// <typeparam name="T">The typed object for which the method is querying.</typeparam>
/// <param name="context">The BindingContext for the binding element.</param>
/// <returns>The typed object T requested if it is present or nullif it is not present.</returns>
public override T GetProperty<T>(BindingContext context)
{
return context.GetInnerProperty<T>();
}
/// <summary>
/// Returns a value that indicates whether the binding element can build a
/// channel factory for a specific type of channel.
/// </summary>
/// <typeparam name="TChannel">The type of channel the channel factory produces.</typeparam>
/// <param name="context">The BindingContext that provides context for the binding element.</param>
/// <returns>true if the IChannelFactory<TChannel/>of type TChannel can be built by
/// the binding element; otherwise, false.</returns>
public override bool CanBuildChannelFactory<TChannel>(BindingContext context)
{
return false;
}
/// <summary>
/// Initializes a channel factory for producing channels of a specified type from the binding context.
/// </summary>
/// <typeparam name="TChannel">The type of channel the factory builds.</typeparam>
/// <param name="context">The BindingContext that provides context for the binding element.</param>
/// <returns>The IChannelFactory<TChannel/>of type TChannel initialized from the context. </returns>
public override IChannelFactory<TChannel> BuildChannelFactory<TChannel>(BindingContext context)
{
throw new NotSupportedException();
}
/// <summary>
/// Returns a value that indicates whether the binding element can build a channel
/// listener for a specific type of channel.
/// </summary>
/// <typeparam name="TChannel">The type of channel listener to build.</typeparam>
/// <param name="context">The BindingContext for the binding element.</param>
/// <returns>true if a channel listener of the specified type can be built;
/// otherwise, false. The default is false. </returns>
public override bool CanBuildChannelListener<TChannel>(BindingContext context)
{
return context.CanBuildInnerChannelListener<TChannel>();
}
/// <summary>
/// Initializes a channel listener for producing channels of a specified type from the binding context.
/// </summary>
/// <typeparam name="TChannel">The type of channel that the listener is built to accept.</typeparam>
/// <param name="context">The BindingContext for the binding element.</param>
/// <returns>The IChannelListener<TChannel/>of type IChannel initialized from the context.</returns>
public override IChannelListener<TChannel> BuildChannelListener<TChannel>(BindingContext context)
{
if (!string.IsNullOrEmpty(listenUri))
{
context.ListenUriBaseAddress = new Uri(listenUri);
context.ListenUriMode = ListenUriMode.Explicit;
}
return context.BuildInnerChannelListener<TChannel>();
}
#endregion
}
You can enable the component tracking and use DebugView to monitor its runtime behavior.
Next Step
SessionChannelEndpointBehavior
See Also
Concepts
ListenUriEndpointBehavior
SessionChannelEndpointBehavior
ServiceBusMessageInspector
TokenProviderEndpointBehavior
Create the Endpoint Behaviors