5 // Atsushi Enomoto <atsushi@ximian.com>
7 // Copyright (C) 2005-2006 Novell, Inc. http://www.novell.com
9 // Permission is hereby granted, free of charge, to any person obtaining
10 // a copy of this software and associated documentation files (the
11 // "Software"), to deal in the Software without restriction, including
12 // without limitation the rights to use, copy, modify, merge, publish,
13 // distribute, sublicense, and/or sell copies of the Software, and to
14 // permit persons to whom the Software is furnished to do so, subject to
15 // the following conditions:
17 // The above copyright notice and this permission notice shall be
18 // included in all copies or substantial portions of the Software.
20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 using System.Collections.Generic;
30 using System.Collections.ObjectModel;
31 using System.ServiceModel.Channels;
32 using System.ServiceModel.Configuration;
33 using System.ServiceModel.Description;
34 using System.ServiceModel.Dispatcher;
35 using System.ServiceModel.Security;
36 using System.Reflection;
38 namespace System.ServiceModel
40 public abstract partial class ServiceHostBase
41 : CommunicationObject, IExtensibleObject<ServiceHostBase>, IDisposable
43 ServiceCredentials credentials;
44 ServiceDescription description;
45 UriSchemeKeyedCollection base_addresses;
46 TimeSpan open_timeout, close_timeout, instance_idle_timeout;
47 ServiceThrottle throttle;
48 List<InstanceContext> contexts;
49 ReadOnlyCollection<InstanceContext> exposed_contexts;
50 ChannelDispatcherCollection channel_dispatchers;
51 IDictionary<string,ContractDescription> contracts;
52 int flow_limit = int.MaxValue;
53 IExtensionCollection<ServiceHostBase> extensions;
55 protected ServiceHostBase ()
57 open_timeout = DefaultOpenTimeout;
58 close_timeout = DefaultCloseTimeout;
60 credentials = new ServiceCredentials ();
61 throttle = new ServiceThrottle ();
62 contexts = new List<InstanceContext> ();
63 exposed_contexts = new ReadOnlyCollection<InstanceContext> (contexts);
64 channel_dispatchers = new ChannelDispatcherCollection (this);
67 public event EventHandler<UnknownMessageReceivedEventArgs>
68 UnknownMessageReceived;
70 internal void OnUnknownMessageReceived (Message message)
72 if (UnknownMessageReceived != null)
73 UnknownMessageReceived (this, new UnknownMessageReceivedEventArgs (message));
75 // FIXME: better be logged
76 throw new EndpointNotFoundException (String.Format ("The request message has the target '{0}' with action '{1}' which is not reachable in this service contract", message.Headers.To, message.Headers.Action));
79 public ReadOnlyCollection<Uri> BaseAddresses {
81 if (base_addresses == null)
82 base_addresses = new UriSchemeKeyedCollection ();
83 return new ReadOnlyCollection<Uri> (base_addresses.InternalItems);
87 internal Uri CreateUri (string sheme, Uri relatieUri) {
88 Uri baseUri = base_addresses.Contains (sheme) ? base_addresses [sheme] : null;
90 if (relatieUri == null)
92 if (relatieUri.IsAbsoluteUri)
96 return new Uri (baseUri, relatieUri);
99 public ChannelDispatcherCollection ChannelDispatchers {
100 get { return channel_dispatchers; }
103 public ServiceAuthorizationBehavior Authorization {
109 public ServiceCredentials Credentials {
110 get { return credentials; }
113 public ServiceDescription Description {
114 get { return description; }
117 protected IDictionary<string,ContractDescription> ImplementedContracts {
118 get { return contracts; }
122 public IExtensionCollection<ServiceHostBase> Extensions {
124 if (extensions == null)
125 extensions = new ExtensionCollection<ServiceHostBase> (this);
130 protected internal override TimeSpan DefaultCloseTimeout {
131 get { return DefaultCommunicationTimeouts.Instance.CloseTimeout; }
134 protected internal override TimeSpan DefaultOpenTimeout {
135 get { return DefaultCommunicationTimeouts.Instance.OpenTimeout; }
138 public TimeSpan CloseTimeout {
139 get { return close_timeout; }
140 set { close_timeout = value; }
143 public TimeSpan OpenTimeout {
144 get { return open_timeout; }
145 set { open_timeout = value; }
148 public int ManualFlowControlLimit {
149 get { return flow_limit; }
150 set { flow_limit = value; }
153 protected void AddBaseAddress (Uri baseAddress)
155 if (Description != null)
156 throw new InvalidOperationException ("Base addresses must be added before the service description is initialized");
157 base_addresses.Add (baseAddress);
160 public ServiceEndpoint AddServiceEndpoint (
161 string implementedContract, Binding binding, string address)
163 return AddServiceEndpoint (implementedContract,
165 new Uri (address, UriKind.RelativeOrAbsolute));
168 public ServiceEndpoint AddServiceEndpoint (
169 string implementedContract, Binding binding,
170 string address, Uri listenUri)
172 Uri uri = new Uri (address, UriKind.RelativeOrAbsolute);
173 return AddServiceEndpoint (
174 implementedContract, binding, uri, listenUri);
177 public ServiceEndpoint AddServiceEndpoint (
178 string implementedContract, Binding binding,
181 return AddServiceEndpoint (implementedContract, binding, address, address);
184 public ServiceEndpoint AddServiceEndpoint (
185 string implementedContract, Binding binding,
186 Uri address, Uri listenUri)
188 EndpointAddress ea = BuildEndpointAddress (address, binding);
189 ContractDescription cd = GetContract (implementedContract);
191 throw new InvalidOperationException (String.Format ("Contract '{0}' was not found in the implemented contracts in this service host.", implementedContract));
192 return AddServiceEndpointCore (cd, binding, ea, listenUri);
195 Type PopulateType (string typeName)
197 Type type = Type.GetType (typeName);
200 foreach (ContractDescription cd in ImplementedContracts.Values) {
201 type = cd.ContractType.Assembly.GetType (typeName);
208 ContractDescription GetContract (string name)
210 //FIXME: hack hack hack
211 ImplementedContracts ["IHttpGetHelpPageAndMetadataContract"] =
212 ContractDescription.GetContract (typeof (IHttpGetHelpPageAndMetadataContract));
214 // FIXME: As long as I tried, *only* IMetadataExchange
215 // is the exception case that does not require full
216 // type name. Hence I treat it as a special case.
217 if (name == ServiceMetadataBehavior.MexContractName) {
218 if (!Description.Behaviors.Contains (typeof (ServiceMetadataBehavior)) && Array.IndexOf (Description.ServiceType.GetInterfaces (), typeof (IMetadataExchange)) < 0)
219 throw new InvalidOperationException (
220 "Add ServiceMetadataBehavior to the ServiceHost to add a endpoint for IMetadataExchange contract.");
222 ImplementedContracts [ServiceMetadataBehavior.MexContractName] =
223 ContractDescription.GetContract (typeof (IMetadataExchange));
225 foreach (ContractDescription cd in ImplementedContracts.Values)
226 if (cd.ContractType == typeof (IMetadataExchange))
231 Type type = PopulateType (name);
233 foreach (ContractDescription cd in ImplementedContracts.Values) {
234 // FIXME: This check is a negative side effect
235 // of the above hack.
236 if (cd.ContractType == typeof (IMetadataExchange))
245 if (cd.ContractType == type ||
246 cd.ContractType.IsSubclassOf (type) ||
247 type.IsInterface && cd.ContractType.GetInterface (type.FullName) == type)
253 internal EndpointAddress BuildEndpointAddress (Uri address, Binding binding)
255 if (!address.IsAbsoluteUri) {
256 // Find a Base address with matching scheme,
257 // and build new absolute address
258 if (!base_addresses.Contains (binding.Scheme))
259 throw new InvalidOperationException (String.Format ("Could not find base address that matches Scheme {0} for endpoint {1}", binding.Scheme, binding.Name));
261 Uri baseaddr = base_addresses [binding.Scheme];
263 if (!baseaddr.AbsoluteUri.EndsWith ("/") && address.OriginalString.Length > 0) // with empty URI it should not add '/' to possible file name of the absolute URI
264 baseaddr = new Uri (baseaddr.AbsoluteUri + "/");
265 address = new Uri (baseaddr, address);
267 return new EndpointAddress (address);
270 internal ServiceEndpoint AddServiceEndpointCore (
271 ContractDescription cd, Binding binding, EndpointAddress address, Uri listenUri)
273 foreach (ServiceEndpoint e in Description.Endpoints)
274 if (e.Contract == cd)
276 ServiceEndpoint se = new ServiceEndpoint (cd, binding, address);
277 se.ListenUri = listenUri.IsAbsoluteUri ? listenUri : new Uri (address.Uri, listenUri);
278 Description.Endpoints.Add (se);
283 protected virtual void ApplyConfiguration ()
285 if (Description == null)
286 throw new InvalidOperationException ("ApplyConfiguration requires that the Description property be initialized. Either provide a valid ServiceDescription in the CreateDescription method or override the ApplyConfiguration method to provide an alternative implementation");
288 ServiceElement service = GetServiceElement ();
290 //TODO: Should we call here LoadServiceElement ?
291 if (service != null) {
294 HostElement host = service.Host;
295 foreach (BaseAddressElement baseAddress in host.BaseAddresses) {
296 AddBaseAddress (new Uri (baseAddress.BaseAddress));
300 foreach (ServiceEndpointElement endpoint in service.Endpoints) {
301 // FIXME: consider BindingName as well
302 ServiceEndpoint se = AddServiceEndpoint (
304 ConfigUtil.CreateBinding (endpoint.Binding, endpoint.BindingConfiguration),
305 endpoint.Address.ToString ());
308 // TODO: use EvaluationContext of ServiceElement.
309 ServiceBehaviorElement behavior = ConfigUtil.BehaviorsSection.ServiceBehaviors.Find (service.BehaviorConfiguration);
310 if (behavior != null) {
311 for (int i = 0; i < behavior.Count; i++) {
312 BehaviorExtensionElement bxel = behavior [i];
313 IServiceBehavior b = (IServiceBehavior) behavior [i].CreateBehavior ();
315 Description.Behaviors.Add (b);
319 // TODO: consider commonBehaviors here
321 // ensure ServiceAuthorizationBehavior
322 Authorization = Description.Behaviors.Find<ServiceAuthorizationBehavior> ();
323 if (Authorization == null) {
324 Authorization = new ServiceAuthorizationBehavior ();
325 Description.Behaviors.Add (Authorization);
328 // ensure ServiceDebugBehavior
329 ServiceDebugBehavior debugBehavior = Description.Behaviors.Find<ServiceDebugBehavior> ();
330 if (debugBehavior == null) {
331 debugBehavior = new ServiceDebugBehavior ();
332 Description.Behaviors.Add (debugBehavior);
336 private ServiceElement GetServiceElement() {
337 Type serviceType = Description.ServiceType;
338 if (serviceType == null)
341 return ConfigUtil.ServicesSection.Services [serviceType.FullName];
344 internal ContractDescription GetContract (string name, string ns)
346 foreach (ContractDescription d in ImplementedContracts.Values)
347 if (d.Name == name && d.Namespace == ns)
352 protected abstract ServiceDescription CreateDescription (
353 out IDictionary<string,ContractDescription> implementedContracts);
355 protected void InitializeDescription (UriSchemeKeyedCollection baseAddresses)
357 this.base_addresses = baseAddresses;
358 IDictionary<string,ContractDescription> retContracts;
359 description = CreateDescription (out retContracts);
360 contracts = retContracts;
362 ApplyConfiguration ();
365 protected virtual void InitializeRuntime ()
367 //First validate the description, which should call all behaviors
369 ValidateDescription ();
371 //Build all ChannelDispatchers, one dispatcher per user configured EndPoint.
372 //We must keep thet ServiceEndpoints as a seperate collection, since the user
373 //can change the collection in the description during the behaviors events.
374 Dictionary<ServiceEndpoint, ChannelDispatcher> endPointToDispatcher = new Dictionary<ServiceEndpoint,ChannelDispatcher>();
375 ServiceEndpoint[] endPoints = new ServiceEndpoint[Description.Endpoints.Count];
376 Description.Endpoints.CopyTo (endPoints, 0);
377 foreach (ServiceEndpoint se in endPoints) {
379 var commonParams = new BindingParameterCollection ();
380 foreach (IServiceBehavior b in Description.Behaviors)
381 b.AddBindingParameters (Description, this, Description.Endpoints, commonParams);
383 ChannelDispatcher channel = BuildChannelDispatcher (se, commonParams);
384 ChannelDispatchers.Add (channel);
385 endPointToDispatcher[se] = channel;
388 //After the ChannelDispatchers are created, and attached to the service host
389 //Apply dispatching behaviors.
390 foreach (IServiceBehavior b in Description.Behaviors)
391 b.ApplyDispatchBehavior (Description, this);
393 foreach(KeyValuePair<ServiceEndpoint, ChannelDispatcher> val in endPointToDispatcher)
394 foreach (var ed in val.Value.Endpoints)
395 ApplyDispatchBehavior (ed, val.Key);
398 private void ValidateDescription ()
400 foreach (IServiceBehavior b in Description.Behaviors)
401 b.Validate (Description, this);
402 foreach (ServiceEndpoint endPoint in Description.Endpoints)
403 endPoint.Validate ();
406 private void ApplyDispatchBehavior (EndpointDispatcher ed, ServiceEndpoint endPoint)
408 foreach (IContractBehavior b in endPoint.Contract.Behaviors)
409 b.ApplyDispatchBehavior (endPoint.Contract, endPoint, ed.DispatchRuntime);
410 foreach (IEndpointBehavior b in endPoint.Behaviors)
411 b.ApplyDispatchBehavior (endPoint, ed);
412 foreach (OperationDescription operation in endPoint.Contract.Operations) {
413 foreach (IOperationBehavior b in operation.Behaviors)
414 b.ApplyDispatchBehavior (operation, ed.DispatchRuntime.Operations [operation.Name]);
419 internal ChannelDispatcher BuildChannelDispatcher (ServiceEndpoint se, BindingParameterCollection commonParams)
421 return new DispatcherBuilder ().BuildChannelDispatcher (Description.ServiceType, se, commonParams);
425 protected void LoadConfigurationSection (ServiceElement element)
427 ServicesSection services = ConfigUtil.ServicesSection;
430 void DoOpen (TimeSpan timeout)
432 foreach (var cd in ChannelDispatchers) {
434 // This is likely hack.
435 if (cd is ChannelDispatcher)
436 ((ChannelDispatcher) cd).StartLoop ();
441 protected override sealed void OnAbort ()
445 Action<TimeSpan> close_delegate;
446 Action<TimeSpan> open_delegate;
448 protected override sealed IAsyncResult OnBeginClose (
449 TimeSpan timeout, AsyncCallback callback, object state)
451 if (close_delegate != null)
452 close_delegate = new Action<TimeSpan> (OnClose);
453 return close_delegate.BeginInvoke (timeout, callback, state);
456 protected override sealed IAsyncResult OnBeginOpen (
457 TimeSpan timeout, AsyncCallback callback, object state)
459 if (open_delegate == null)
460 open_delegate = new Action<TimeSpan> (OnOpen);
461 return open_delegate.BeginInvoke (timeout, callback, state);
464 protected override void OnClose (TimeSpan timeout)
466 DateTime start = DateTime.Now;
467 ReleasePerformanceCounters ();
468 List<ChannelDispatcherBase> l = new List<ChannelDispatcherBase> (ChannelDispatchers);
469 foreach (ChannelDispatcherBase e in l) {
471 TimeSpan ts = timeout - (DateTime.Now - start);
472 if (ts < TimeSpan.Zero)
476 } catch (Exception ex) {
477 Console.WriteLine ("ServiceHostBase failed to close the channel dispatcher:");
478 Console.WriteLine (ex);
483 protected override sealed void OnOpen (TimeSpan timeout)
485 InitializeRuntime ();
489 protected override void OnEndClose (IAsyncResult result)
491 if (close_delegate == null)
492 throw new InvalidOperationException ("Async close operation has not started");
493 close_delegate.EndInvoke (result);
496 protected override sealed void OnEndOpen (IAsyncResult result)
498 if (open_delegate == null)
499 throw new InvalidOperationException ("Aync open operation has not started");
500 open_delegate.EndInvoke (result);
503 protected override void OnOpened ()
508 protected void ReleasePerformanceCounters ()
512 void IDisposable.Dispose ()
518 class SyncMethodInvoker : IOperationInvoker
520 readonly MethodInfo _methodInfo;
521 public SyncMethodInvoker (MethodInfo methodInfo) {
522 _methodInfo = methodInfo;
525 #region IOperationInvoker Members
527 public bool IsSynchronous {
531 public object [] AllocateParameters () {
532 return new object [_methodInfo.GetParameters ().Length];
535 public object Invoke (object instance, object [] parameters)
537 return _methodInfo.Invoke (instance, parameters);
540 public IAsyncResult InvokeBegin (object instance, object [] inputs, AsyncCallback callback, object state) {
541 throw new NotSupportedException ();
544 public object InvokeEnd (object instance, out object [] outputs, IAsyncResult result) {
545 throw new NotSupportedException ();
551 class AsyncMethodInvoker : IOperationInvoker
553 readonly MethodInfo _beginMethodInfo, _endMethodInfo;
554 public AsyncMethodInvoker (MethodInfo beginMethodInfo, MethodInfo endMethodInfo) {
555 _beginMethodInfo = beginMethodInfo;
556 _endMethodInfo = endMethodInfo;
559 #region IOperationInvoker Members
561 public bool IsSynchronous {
562 get { return false; }
565 public object [] AllocateParameters () {
566 return new object [_beginMethodInfo.GetParameters ().Length - 2 + _endMethodInfo.GetParameters().Length-1];
569 public object Invoke (object instance, object [] parameters) {
570 throw new NotImplementedException ("Can't invoke async method synchronously");
571 //BUGBUG: need to differentiate between input and output parameters.
572 IAsyncResult asyncResult = InvokeBegin(instance, parameters, delegate(IAsyncResult ignore) { }, null);
573 asyncResult.AsyncWaitHandle.WaitOne();
574 return InvokeEnd(instance, out parameters, asyncResult);
577 public IAsyncResult InvokeBegin (object instance, object [] inputs, AsyncCallback callback, object state) {
578 if (inputs.Length + 2 != _beginMethodInfo.GetParameters ().Length)
579 throw new ArgumentException ("Wrong number of input parameters");
580 object [] fullargs = new object [_beginMethodInfo.GetParameters ().Length];
581 Array.Copy (inputs, fullargs, inputs.Length);
582 fullargs [inputs.Length] = callback;
583 fullargs [inputs.Length + 1] = state;
584 return (IAsyncResult) _beginMethodInfo.Invoke (instance, fullargs);
587 public object InvokeEnd (object instance, out object [] outputs, IAsyncResult asyncResult) {
588 outputs = new object [_endMethodInfo.GetParameters ().Length - 1];
589 object [] fullargs = new object [_endMethodInfo.GetParameters ().Length];
590 fullargs [outputs.Length] = asyncResult;
591 object result = _endMethodInfo.Invoke (instance, fullargs);
592 Array.Copy (fullargs, outputs, outputs.Length);
601 partial class DispatcherBuilder
603 internal ChannelDispatcher BuildChannelDispatcher (Type serviceType, ServiceEndpoint se, BindingParameterCollection commonParams)
605 //Let all behaviors add their binding parameters
606 AddBindingParameters (commonParams, se);
607 //User the binding parameters to build the channel listener and Dispatcher
608 IChannelListener lf = BuildListener (se, commonParams);
609 ChannelDispatcher cd = new ChannelDispatcher (
610 lf, se.Binding.Name);
611 cd.InitializeServiceEndpoint (serviceType, se);
615 private void AddBindingParameters (BindingParameterCollection commonParams, ServiceEndpoint endPoint) {
617 commonParams.Add (ChannelProtectionRequirements.CreateFromContract (endPoint.Contract));
619 foreach (IContractBehavior b in endPoint.Contract.Behaviors)
620 b.AddBindingParameters (endPoint.Contract, endPoint, commonParams);
621 foreach (IEndpointBehavior b in endPoint.Behaviors)
622 b.AddBindingParameters (endPoint, commonParams);
623 foreach (OperationDescription operation in endPoint.Contract.Operations) {
624 foreach (IOperationBehavior b in operation.Behaviors)
625 b.AddBindingParameters (operation, commonParams);
629 static IChannelListener BuildListener (ServiceEndpoint se,
630 BindingParameterCollection pl)
632 Binding b = se.Binding;
633 if (b.CanBuildChannelListener<IReplySessionChannel> (pl))
634 return b.BuildChannelListener<IReplySessionChannel> (se.ListenUri, "", se.ListenUriMode, pl);
635 if (b.CanBuildChannelListener<IReplyChannel> (pl))
636 return b.BuildChannelListener<IReplyChannel> (se.ListenUri, "", se.ListenUriMode, pl);
637 if (b.CanBuildChannelListener<IInputSessionChannel> (pl))
638 return b.BuildChannelListener<IInputSessionChannel> (se.ListenUri, "", se.ListenUriMode, pl);
639 if (b.CanBuildChannelListener<IInputChannel> (pl))
640 return b.BuildChannelListener<IInputChannel> (se.ListenUri, "", se.ListenUriMode, pl);
642 if (b.CanBuildChannelListener<IDuplexChannel> (pl))
643 return b.BuildChannelListener<IDuplexChannel> (se.ListenUri, "", se.ListenUriMode, pl);
644 if (b.CanBuildChannelListener<IDuplexSessionChannel> (pl))
645 return b.BuildChannelListener<IDuplexSessionChannel> (se.ListenUri, "", se.ListenUriMode, pl);
646 throw new InvalidOperationException ("None of the listener channel types is supported");