StorageNode and Domain become ISessionSource-es

Author: alex-kulakov

Orm/Xtensive.Orm/Orm/Domain.cs

@@ -35,7 +35,7 @@ namespace Xtensive.Orm
   /// <code lang="cs" source="..\Xtensive.Orm\Xtensive.Orm.Manual\DomainAndSession\DomainAndSessionSample.cs" region="Domain sample"></code>
   /// </sample>
   [UsedImplicitly(ImplicitUseTargetFlags.WithMembers)]
-  public sealed class Domain : IDisposable, IHasExtensions
+  public sealed class Domain : IDisposable, IHasExtensions, ISessionSource
   {
     private readonly object disposeGuard = new object();
     private readonly object singleConnectionGuard = new object();
@@ -116,13 +116,13 @@ public static Domain Demand()
     /// }
     /// </code></sample>
     /// <exception cref="ArgumentException"><see cref="StorageNode"/> with given identifier does not exist.</exception>
-    public ISelectedStorageNode SelectStorageNode([NotNull]string storageNodeId)
+    public ISessionSource SelectStorageNode([NotNull]string storageNodeId)
     {
       var node = StorageNodeManager.GetNode(storageNodeId);
       if (node == null) {
         throw new ArgumentException(string.Format(Strings.ExStorageNodeWithIdXIsNotFound, storageNodeId));
       }
-      return new SelectedStorageNode(this, node);
+      return node;
     }
 
     #region Private / internal members
@@ -284,22 +284,6 @@ internal Session OpenSessionInternal(SessionConfiguration configuration, Storage
       return session;
     }
 
-    /// <summary>
-    /// Opens new <see cref="Session"/> with default <see cref="SessionConfiguration"/> asynchronously.
-    /// </summary>
-    /// <returns>A task representing the asynchronous operation.</returns>
-    /// <sample><code>
-    /// using (var session = await Domain.OpenSessionAsync()) {
-    /// // work with persistent objects here.
-    /// }
-    /// </code></sample>
-    /// <seealso cref="Session"/>
-    public Task<Session> OpenSessionAsync()
-    {
-      var configuration = Configuration.Sessions.Default;
-      return OpenSessionAsync(configuration, CancellationToken.None);
-    }
-
     /// <summary>
     /// Opens new <see cref="Session"/> with default <see cref="SessionConfiguration"/> asynchronously.
     /// </summary>
@@ -312,27 +296,12 @@ public Task<Session> OpenSessionAsync()
     /// }
     /// </code></sample>
     /// <seealso cref="Session"/>
-    public Task<Session> OpenSessionAsync(CancellationToken cancellationToken)
+    public Task<Session> OpenSessionAsync(CancellationToken cancellationToken = default)
     {
       var configuration = Configuration.Sessions.Default;
       return OpenSessionAsync(configuration, cancellationToken);
     }
 
-    /// <summary>
-    /// Opens new <see cref="Session"/> of specified <see cref="SessionType"/> asynchronously.
-    /// </summary>
-    /// <param name="type">The type of session.</param>
-    /// <returns>A task representing the asynchronous operation.</returns>
-    /// <sample><code>
-    /// using (var session = await domain.OpenSessionAsync(sessionType)) {
-    /// // work with persistent objects here.
-    /// }
-    /// </code></sample>
-    public Task<Session> OpenSessionAsync(SessionType type)
-    {
-      return OpenSessionAsync(type, CancellationToken.None);
-    }
-
     /// <summary>
     /// Opens new <see cref="Session"/> of specified <see cref="SessionType"/> asynchronously.
     /// </summary>
@@ -345,7 +314,7 @@ public Task<Session> OpenSessionAsync(SessionType type)
     /// // work with persistent objects here.
     /// }
     /// </code></sample>
-    public Task<Session> OpenSessionAsync(SessionType type, CancellationToken cancellationToken)
+    public Task<Session> OpenSessionAsync(SessionType type, CancellationToken cancellationToken = default)
     {
       cancellationToken.ThrowIfCancellationRequested();
       switch (type) {
@@ -362,22 +331,6 @@ public Task<Session> OpenSessionAsync(SessionType type, CancellationToken cancel
       }
     }
 
-    /// <summary>
-    /// Opens new <see cref="Session"/> with specified <see cref="SessionConfiguration"/> asynchronously.
-    /// </summary>
-    /// <param name="configuration">The session configuration.</param>
-    /// <returns>A task representing the asynchronous operation.</returns>
-    /// <sample><code>
-    /// using (var session = await domain.OpenSessionAsync(configuration)) {
-    /// // work with persistent objects here
-    /// }
-    /// </code></sample>
-    /// <seealso cref="Session"/>
-    public Task<Session> OpenSessionAsync(SessionConfiguration configuration)
-    {
-      return OpenSessionAsync(configuration, CancellationToken.None);
-    }
-
     /// <summary>
     /// Opens new <see cref="Session"/> with specified <see cref="SessionConfiguration"/> asynchronously.
     /// </summary>
@@ -391,7 +344,7 @@ public Task<Session> OpenSessionAsync(SessionConfiguration configuration)
     /// }
     /// </code></sample>
     /// <seealso cref="Session"/>
-    public Task<Session> OpenSessionAsync(SessionConfiguration configuration, CancellationToken cancellationToken)
+    public Task<Session> OpenSessionAsync(SessionConfiguration configuration, CancellationToken cancellationToken = default)
     {
       return OpenSessionInternalAsync(configuration, null,
         configuration.Supports(SessionOptions.AutoActivation), cancellationToken);

…m/Orm/Interfaces/ISelectedStorageNode.cs …ive.Orm/Orm/Interfaces/ISessionSource.csOrm/Xtensive.Orm/Orm/Interfaces/ISelectedStorageNode.cs renamed to Orm/Xtensive.Orm/Orm/Interfaces/ISessionSource.cs Orm/Xtensive.Orm/Orm/Interfaces/ISelectedStorageNode.cs renamed to Orm/Xtensive.Orm/Orm/Interfaces/ISessionSource.cs

@@ -6,22 +6,16 @@
 namespace Xtensive.Orm.Interfaces
 {
   /// <summary>
-  /// Defines <see cref="StorageNode"/>-dependant operations.
+  /// Contract for types being able to open <see cref="Session"/>.
   /// </summary>
-  public interface ISelectedStorageNode
+  public interface ISessionSource
   {
     /// <summary>
     /// Opens new <see cref="Session"/> with default <see cref="SessionConfiguration"/>.
     /// </summary>
     /// <returns>
     /// New <see cref="Session"/> object.
     /// </returns>
-    /// <sample><code>
-    /// using (var session = domain.SelectStorageNode(nodeId).OpenSession()) {
-    ///   // work with persistent objects here.
-    /// }
-    /// </code></sample>
-    /// <seealso cref="Session"/>
     Session OpenSession();
 
     /// <summary>
@@ -31,11 +25,6 @@ public interface ISelectedStorageNode
     /// <returns>
     /// New <see cref="Session"/> object.
     /// </returns>
-    /// <sample><code>
-    /// using (var session = domain.SelectStorageNode(nodeId).OpenSession(sessionType)) {
-    ///   // work with persistent objects here.
-    /// }
-    /// </code></sample>
     Session OpenSession(SessionType type);
 
     /// <summary>
@@ -45,38 +34,20 @@ public interface ISelectedStorageNode
     /// <returns>
     /// New <see cref="Session"/> object.
     /// </returns>
-    /// <sample><code>
-    /// using (var session = domain.SelectStorageNode(nodeId).OpenSession(configuration)) {
-    ///   // work with persistent objects here
-    /// }
-    /// </code></sample>
-    /// <seealso cref="Session"/>
     Session OpenSession(SessionConfiguration configuration);
 
     /// <summary>
     /// Asynchronously opens new <see cref="Session"/> with default <see cref="SessionConfiguration"/>.
     /// </summary>
     /// <returns>A task representing the asynchronous operation.</returns>
-    /// <sample><code>
-    /// /// var ctSource = new CancellationTokenSource();
-    /// using (var session = await domain.SelectStorageNode(nodeId).OpenSessionAsync(ctSource.Token)) {
-    ///   // work with persistent objects here.
-    /// }
-    /// </code></sample>
-    /// <seealso cref="Session"/>
     Task<Session> OpenSessionAsync(CancellationToken cancellationToken = default);
 
     /// <summary>
     /// Asynchronously opens new <see cref="Session"/> of specified <see cref="SessionType"/> asynchronously.
     /// </summary>
     /// <param name="type">The type of session.</param>
+    /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
     /// <returns>A task representing the asynchronous operation.</returns>
-    /// <sample><code>
-    /// var ctSource = new CancellationTokenSource();
-    /// using (var session = await domain.SelectStorageNode(nodeId).OpenSessionAsync(sessionType, ctSource.Token)) {
-    ///   // work with persistent objects here.
-    /// }
-    /// </code></sample>
     Task<Session> OpenSessionAsync(SessionType type, CancellationToken cancellationToken = default);
 
     /// <summary>
@@ -85,13 +56,6 @@ public interface ISelectedStorageNode
     /// <param name="configuration">The session configuration.</param>
     /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
     /// <returns>A task representing the asynchronous operation.</returns>
-    /// <sample><code>
-    /// var ctSource = new CancellationTokenSource();
-    /// using (var session = await domain.SelectStorageNode(nodeId).OpenSessionAsync(configuration, ctSource.Token)) {
-    ///   // work with persistent objects here
-    /// }
-    /// </code></sample>
-    /// <seealso cref="Session"/>
     Task<Session> OpenSessionAsync(SessionConfiguration configuration, CancellationToken cancellationToken = default);
   }
 }

Orm/Xtensive.Orm/Orm/Internals/SelectedStorageNode.cs

@@ -1,13 +1,17 @@
-// Copyright (C) 2014 Xtensive LLC.
+// Copyright (C) 2014 Xtensive LLC.
 // All rights reserved.
 // For conditions of distribution and use, see license.
 // Created by: Denis Krjuchkov
 // Created:    2014.03.13
 
+using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
 using Xtensive.Core;
 using Xtensive.Orm.Configuration;
+using Xtensive.Orm.Interfaces;
 using Xtensive.Orm.Model;
 using Xtensive.Orm.Providers;
 
@@ -16,8 +20,10 @@ namespace Xtensive.Orm
   /// <summary>
   /// Storage node.
   /// </summary>
-  public sealed class StorageNode
+  public sealed class StorageNode : ISessionSource
   {
+    private readonly Domain domain;
+
     /// <summary>
     /// Gets node identifier.
     /// </summary>
@@ -44,15 +50,68 @@ public sealed class StorageNode
 
     internal ConcurrentDictionary<PersistRequestBuilderTask, ICollection<PersistRequest>> PersistRequestCache { get; private set; }
 
+    /// <inheritdoc/>
+    public Session OpenSession()
+    {
+      return OpenSession(domain.Configuration.Sessions.Default);
+    }
+
+    /// <inheritdoc/>
+    public Session OpenSession(SessionType type)
+    {
+      return type switch {
+        SessionType.User => OpenSession(domain.Configuration.Sessions.Default),
+        SessionType.System => OpenSession(domain.Configuration.Sessions.System),
+        SessionType.KeyGenerator => OpenSession(domain.Configuration.Sessions.KeyGenerator),
+        SessionType.Service => OpenSession(domain.Configuration.Sessions.Service),
+        _ => throw new ArgumentOutOfRangeException("type"),
+      };
+    }
+
+    /// <inheritdoc/>
+    public Session OpenSession(SessionConfiguration configuration)
+    {
+      ArgumentValidator.EnsureArgumentNotNull(configuration, nameof(configuration));
+      return domain.OpenSessionInternal(configuration, this, configuration.Supports(SessionOptions.AutoActivation));
+    }
+
+    /// <inheritdoc/>
+    public Task<Session> OpenSessionAsync(CancellationToken cancellationToken = default) =>
+      OpenSessionAsync(domain.Configuration.Sessions.Default, cancellationToken);
+
+    /// <inheritdoc/>
+    public Task<Session> OpenSessionAsync(SessionType type, CancellationToken cancellationToken = default)
+    {
+      return type switch {
+        SessionType.User => OpenSessionAsync(domain.Configuration.Sessions.Default),
+        SessionType.System => OpenSessionAsync(domain.Configuration.Sessions.System),
+        SessionType.KeyGenerator => OpenSessionAsync(domain.Configuration.Sessions.KeyGenerator),
+        SessionType.Service => OpenSessionAsync(domain.Configuration.Sessions.Service),
+        _ => throw new ArgumentOutOfRangeException("type"),
+      };
+    }
+
+    /// <inheritdoc/>
+    public Task<Session> OpenSessionAsync(SessionConfiguration configuration, CancellationToken cancellationToken = default)
+    {
+      ArgumentValidator.EnsureArgumentNotNull(configuration, nameof(configuration));
+
+      return domain.OpenSessionInternalAsync(configuration,
+        this,
+        configuration.Supports(SessionOptions.AllowSwitching),
+        cancellationToken);
+    }
 
     // Constructors
 
-    internal StorageNode(NodeConfiguration configuration, ModelMapping mapping, TypeIdRegistry typeIdRegistry)
+    internal StorageNode(Domain domain, NodeConfiguration configuration, ModelMapping mapping, TypeIdRegistry typeIdRegistry)
     {
-      ArgumentValidator.EnsureArgumentNotNull(configuration, "configuration");
-      ArgumentValidator.EnsureArgumentNotNull(mapping, "mapping");
-      ArgumentValidator.EnsureArgumentNotNull(typeIdRegistry, "typeIdRegistry");
+      ArgumentValidator.EnsureArgumentNotNull(domain, nameof(domain));
+      ArgumentValidator.EnsureArgumentNotNull(configuration, nameof(configuration));
+      ArgumentValidator.EnsureArgumentNotNull(mapping, nameof(mapping));
+      ArgumentValidator.EnsureArgumentNotNull(typeIdRegistry, nameof(typeIdRegistry));
 
+      this.domain = domain;
       Configuration = configuration;
       Mapping = mapping;
       TypeIdRegistry = typeIdRegistry;