Merge pull request #234 from sharwell/AsyncIdentityService

Asynchronous IIdentityService

Author: sharwell

src/corelib/Core/Providers/IIdentityService.cs

@@ -0,0 +1,68 @@
+namespace net.openstack.Core.Providers
+{
+    using System;
+    using System.Threading.Tasks;
+    using net.openstack.Core.Domain;
+    using net.openstack.Core.Exceptions.Response;
+    using CancellationToken = System.Threading.CancellationToken;
+
+    /// <summary>
+    /// Represents a provider for asynchronous operations on the OpenStack Identity Service.
+    /// </summary>
+    /// <seealso href="http://docs.openstack.org/api/openstack-identity-service/2.0/content/">OpenStack Identity Service API v2.0 Reference</seealso>
+    /// <preliminary/>
+    public interface IIdentityService
+    {
+        /// <summary>
+        /// Authenticates the user for the specified identity.
+        /// </summary>
+        /// <remarks>
+        /// This method always authenticates to the server, even if an unexpired, cached <see cref="UserAccess"/>
+        /// is available for the specified identity.
+        /// </remarks>
+        /// <param name="identity">The identity of the user to authenticate.</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/> that the task will observe.</param>
+        /// <returns>A <see cref="Task"/> object representing the asynchronous operation. When the task completes successfully, the <see cref="Task{TResult}.Result"/> property will contain a <see cref="UserAccess"/> object containing the authentication token, service catalog and user data.</returns>
+        /// <exception cref="NotSupportedException">If the provider does not support the given <paramref name="identity"/> type.</exception>
+        /// <exception cref="InvalidOperationException">If <paramref name="identity"/> is <c>null</c> and no default identity is available for the provider.</exception>
+        /// <exception cref="ResponseException">If the authentication request failed.</exception>
+        /// <seealso href="http://docs.openstack.org/api/openstack-identity-service/2.0/content/POST_authenticate_v2.0_tokens_.html">Authenticate (OpenStack Identity Service API v2.0 Reference)</seealso>
+        Task<UserAccess> AuthenticateAsync(CloudIdentity identity, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Gets the user access details, authenticating with the server if necessary.
+        /// </summary>
+        /// <remarks>
+        /// If <paramref name="forceCacheRefresh"/> is <c>false</c> and a cached <see cref="UserAccess"/>
+        /// is available for the specified <paramref name="identity"/>, this method may return the cached
+        /// value without performing an authentication against the server. If <paramref name="forceCacheRefresh"/>
+        /// is <c>true</c>, this method is equivalent to <see cref="AuthenticateAsync"/>.
+        /// </remarks>
+        /// <param name="identity">The identity of the user to authenticate.</param>
+        /// <param name="forceCacheRefresh">If <c>true</c>, the user is always authenticated against the server; otherwise a cached <see cref="IdentityToken"/> may be returned.</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/> that the task will observe.</param>
+        /// <returns>A <see cref="Task"/> object representing the asynchronous operation. When the task completes successfully, the <see cref="Task{TResult}.Result"/> property will contain a <see cref="UserAccess"/> object containing the authentication token, service catalog and user data.</returns>
+        /// <exception cref="NotSupportedException">If the provider does not support the given <paramref name="identity"/> type.</exception>
+        /// <exception cref="InvalidOperationException">If <paramref name="identity"/> is <c>null</c> and no default identity is available for the provider.</exception>
+        /// <exception cref="ResponseException">If the REST API request failed.</exception>
+        /// <seealso href="http://docs.openstack.org/api/openstack-identity-service/2.0/content/POST_authenticate_v2.0_tokens_.html">Authenticate (OpenStack Identity Service API v2.0 Reference)</seealso>
+        Task<UserAccess> GetUserAccessAsync(CloudIdentity identity, bool forceCacheRefresh, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Gets the authentication token for the specified identity. If necessary, the identity is authenticated
+        /// on the server to obtain a token.
+        /// </summary>
+        /// <remarks>
+        /// If a cached <see cref="IdentityToken"/> is available for the specified <paramref name="identity"/>,
+        /// this method may return the cached value without performing an authentication against the server.
+        /// </remarks>
+        /// <param name="identity">The identity of the user to authenticate.</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/> that the task will observe.</param>
+        /// <returns>A <see cref="Task"/> object representing the asynchronous operation. When the task completes successfully, the <see cref="Task{TResult}.Result"/> property will contain the user's authentication token.</returns>
+        /// <exception cref="NotSupportedException">If the provider does not support the given <paramref name="identity"/> type.</exception>
+        /// <exception cref="InvalidOperationException">If <paramref name="identity"/> is <c>null</c> and no default identity is available for the provider.</exception>
+        /// <exception cref="ResponseException">If the authentication request failed.</exception>
+        /// <seealso href="http://docs.openstack.org/api/openstack-identity-service/2.0/content/POST_authenticate_v2.0_tokens_.html">Authenticate (OpenStack Identity Service API v2.0 Reference)</seealso>
+        Task<IdentityToken> GetTokenAsync(CloudIdentity identity, CancellationToken cancellationToken);
+    }
+}

src/corelib/Providers/Rackspace/CloudIdentityProvider.cs

@@ -2,19 +2,20 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Net;
+using System.Threading.Tasks;
 using JSIStudios.SimpleRESTServices.Client;
 using JSIStudios.SimpleRESTServices.Client.Json;
 using net.openstack.Core;
 using net.openstack.Core.Caching;
 using net.openstack.Core.Domain;
 using net.openstack.Core.Exceptions.Response;
 using net.openstack.Core.Providers;
-using net.openstack.Core.Validators;
 using net.openstack.Providers.Rackspace.Objects;
 using net.openstack.Providers.Rackspace.Objects.Request;
 using net.openstack.Providers.Rackspace.Objects.Response;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
+using CancellationToken = System.Threading.CancellationToken;
 
 namespace net.openstack.Providers.Rackspace
 {
@@ -25,7 +26,7 @@ namespace net.openstack.Providers.Rackspace
     /// <seealso href="http://docs.openstack.org/api/openstack-identity-service/2.0/content/">OpenStack Identity Service API v2.0 Reference</seealso>
     /// <seealso href="http://docs.rackspace.com/auth/api/v2.0/auth-client-devguide/content/index.html">Rackspace Cloud Identity Client Developer Guide - API v2.0</seealso>
     /// <threadsafety static="true" instance="false"/>
-    public class CloudIdentityProvider : ProviderBase<IIdentityProvider>, IExtendedCloudIdentityProvider, IIdentityProvider
+    public class CloudIdentityProvider : ProviderBase<IIdentityProvider>, IExtendedCloudIdentityProvider, IIdentityProvider, IIdentityService
     {
         /// <summary>
         /// This is the backing field for the <see cref="TokenCache"/> property.
@@ -694,6 +695,13 @@ public virtual IdentityToken GetToken(CloudIdentity identity, bool forceCacheRef
             return auth.Token;
         }
 
+        /// <inheritdoc/>
+        public virtual Task<IdentityToken> GetTokenAsync(CloudIdentity identity, CancellationToken cancellationToken)
+        {
+            return GetUserAccessAsync(identity, false, cancellationToken)
+                .ContinueWith(task => task.Result.Token, TaskContinuationOptions.ExecuteSynchronously);
+        }
+
         /// <inheritdoc/>
         public virtual UserAccess Authenticate(CloudIdentity identity)
         {
@@ -702,6 +710,13 @@ public virtual UserAccess Authenticate(CloudIdentity identity)
             return GetUserAccess(identity, true);
         }
 
+        /// <inheritdoc/>
+        public virtual Task<UserAccess> AuthenticateAsync(CloudIdentity identity, CancellationToken cancellationToken)
+        {
+            CheckIdentity(identity);
+            return GetUserAccessAsync(identity, true, cancellationToken);
+        }
+
         /// <inheritdoc/>
         public virtual UserAccess GetUserAccess(CloudIdentity identity, bool forceCacheRefresh = false)
         {
@@ -733,6 +748,12 @@ public virtual UserAccess GetUserAccess(CloudIdentity identity, bool forceCacheR
             return userAccess;
         }
 
+        /// <inheritdoc/>
+        public virtual Task<UserAccess> GetUserAccessAsync(CloudIdentity identity, bool forceCacheRefresh, CancellationToken cancellationToken)
+        {
+            return Task.Factory.StartNew(() => GetUserAccess(identity, forceCacheRefresh), cancellationToken);
+        }
+
         /// <summary>
         /// Gets the authentication token for the specified impersonation identity. If necessary, the
         /// identity is authenticated on the server to obtain a token.

src/corelib/Providers/Rackspace/ProviderBase`1.cs

@@ -994,7 +994,12 @@ protected virtual Task<Uri> GetBaseUriAsync(CancellationToken cancellationToken)
         /// <preliminary/>
         protected virtual Task<Tuple<IdentityToken, Uri>> AuthenticateServiceAsync(CancellationToken cancellationToken)
         {
-            Task<IdentityToken> authenticate = Task.Factory.StartNew(() => IdentityProvider.GetToken(GetDefaultIdentity(null)));
+            Task<IdentityToken> authenticate;
+            IIdentityService identityService = IdentityProvider as IIdentityService;
+            if (identityService != null)
+                authenticate = identityService.GetTokenAsync(GetDefaultIdentity(null), cancellationToken);
+            else
+                authenticate = Task.Factory.StartNew(() => IdentityProvider.GetToken(GetDefaultIdentity(null)));
 
             Func<Task<IdentityToken>, Task<Tuple<IdentityToken, Uri>>> getBaseUri =
                 task =>

src/corelib/corelib.v3.5.csproj

@@ -118,6 +118,7 @@
     <Compile Include="Core\ParallelExtensionsExtras\TaskFactoryExtensions_ContinueWhenAllAny.cs" />
     <Compile Include="Core\ParallelExtensionsExtras\TaskFactoryExtensions_Delayed.cs" />
     <Compile Include="Core\ParallelExtensionsExtras\TaskFactoryExtensions_From.cs" />
+    <Compile Include="Core\Providers\IIdentityService.cs" />
     <Compile Include="Core\Providers\NamespaceDoc.cs" />
     <Compile Include="Core\ResourceIdentifier`1.cs" />
     <Compile Include="Core\ResponseExtensions.cs" />

src/corelib/corelib.v4.0.csproj

@@ -108,6 +108,7 @@
     <Compile Include="Core\ParallelExtensionsExtras\TaskFactoryExtensions_ContinueWhenAllAny.cs" />
     <Compile Include="Core\ParallelExtensionsExtras\TaskFactoryExtensions_Delayed.cs" />
     <Compile Include="Core\ParallelExtensionsExtras\TaskFactoryExtensions_From.cs" />
+    <Compile Include="Core\Providers\IIdentityService.cs" />
     <Compile Include="Core\Providers\NamespaceDoc.cs" />
     <Compile Include="Core\ResourceIdentifier`1.cs" />
     <Compile Include="Core\ResponseExtensions.cs" />