Standardised how an ownerId is obtained so that changes are easier

Jon Nicholson · Jon Nicholson · commit ead45d1a7c22 · 2016-07-11T11:46:56.000+01:00
diff --git a/Code/Sif3Framework/Sif.Framework/Providers/FunctionalServiceProvider.cs b/Code/Sif3Framework/Sif.Framework/Providers/FunctionalServiceProvider.cs
@@ -33,7 +33,6 @@
 using System.Text;
 using System.Web.Http;
 using System.Linq;
-using Sif.Framework.Model.Settings;
 
 namespace Sif.Framework.Providers
 {
@@ -102,12 +101,12 @@ public virtual HttpResponseMessage Post([FromUri] string serviceName, [FromUri]
                 {
                     return Request.CreateErrorResponse(HttpStatusCode.BadRequest, "Request requires use of advisory id, but none has been supplied.");
                 }
-                
+
                 Guid id = service.Create(item, zone: (zone == null ? null : zone[0]), context: (context == null ? null : context[0]));
 
-                if(SettingsManager.ProviderSettings.JobBinding)
+                if (SettingsManager.ProviderSettings.JobBinding)
                 {
-                    service.Bind(sessionToken, id);
+                    service.Bind(getOwnerId(sessionToken), id);
                 }
 
                 jobType job = service.Retrieve(id, zone: (zone == null ? null : zone[0]), context: (context == null ? null : context[0]));
@@ -161,7 +160,8 @@ public virtual HttpResponseMessage Post([FromUri] string serviceName, [FromBody]
                 List<createType> creates = new List<createType>();
                 foreach (jobType job in items.job)
                 {
-                    try {
+                    try
+                    {
                         if (!service.AcceptJob(serviceName, job.name))
                         {
                             throw new ArgumentException("Service " + serviceName + " does not handle jobs named " + job.name);
@@ -170,16 +170,17 @@ public virtual HttpResponseMessage Post([FromUri] string serviceName, [FromBody]
 
                         if (SettingsManager.ProviderSettings.JobBinding)
                         {
-                            service.Bind(sessionToken, id);
+                            service.Bind(getOwnerId(sessionToken), id);
                         }
 
                         creates.Add(ProviderUtils.CreateCreate(HttpStatusCode.Created, id.ToString(), job.id));
-                    } catch(CreateException e)
+                    }
+                    catch (CreateException e)
                     {
                         ProviderUtils.CreateCreate(HttpStatusCode.Conflict, job.id, error: ProviderUtils.CreateError(HttpStatusCode.Conflict, HttpStatusCode.Conflict.ToString(), e.Message));
                     }
                 }
-                
+
                 createResponseType createResponse = ProviderUtils.CreateCreateResponse(creates.ToArray());
 
                 result = Request.CreateResponse<createResponseType>(HttpStatusCode.Created, createResponse);
@@ -244,7 +245,7 @@ public virtual ICollection<jobType> Get([FromUri] string serviceName, [MatrixPar
                 foreach (jobType job in jobs)
                 {
                     if (!SettingsManager.ProviderSettings.JobBinding
-                        || service.IsBound(sessionToken, Guid.Parse(job.id)))
+                        || service.IsBound(getOwnerId(sessionToken), Guid.Parse(job.id)))
                     {
                         items.Add(job);
                     }
@@ -283,7 +284,7 @@ public virtual HttpResponseMessage Get([FromUri] string serviceName, [FromUri] G
                 item = service.Retrieve(id, zone: (zone == null ? null : zone[0]), context: (context == null ? null : context[0]));
 
                 if (SettingsManager.ProviderSettings.JobBinding
-                    && !service.IsBound(sessionToken, Guid.Parse(item.id)))
+                    && !service.IsBound(getOwnerId(sessionToken), Guid.Parse(item.id)))
                 {
                     throw new InvalidSessionException("Request failed as one or more jobs referred to in this request do not belong to this consumer.");
                 }
@@ -343,7 +344,7 @@ public virtual HttpResponseMessage Delete([FromUri] string serviceName, [FromUri
                 IFunctionalService service = getService(serviceName);
 
                 if (SettingsManager.ProviderSettings.JobBinding
-                    && !service.IsBound(sessionToken, id))
+                    && !service.IsBound(getOwnerId(sessionToken), id))
                 {
                     throw new InvalidSessionException("Request failed as one or more jobs referred to in this request do not belong to this consumer.");
                 }
@@ -383,7 +384,7 @@ public virtual HttpResponseMessage Delete([FromUri] string serviceName, [FromBod
                 try
                 {
                     if (SettingsManager.ProviderSettings.JobBinding
-                        && !service.IsBound(sessionToken, Guid.Parse(deleteId.id)))
+                        && !service.IsBound(getOwnerId(sessionToken), Guid.Parse(deleteId.id)))
                     {
                         throw new InvalidSessionException("Request failed as one or more jobs referred to in this request do not belong to this consumer.");
                     }
@@ -443,7 +444,7 @@ public virtual HttpResponseMessage Post([FromUri] string serviceName, [FromUri]
             {
                 IFunctionalService service = getService(serviceName);
                 if (SettingsManager.ProviderSettings.JobBinding
-                    && !service.IsBound(sessionToken, id))
+                    && !service.IsBound(getOwnerId(sessionToken), id))
                 {
                     throw new InvalidSessionException("Request failed as the job referred to in this request does not belong to this consumer.");
                 }
@@ -484,7 +485,7 @@ public virtual HttpResponseMessage Get([FromUri] string serviceName, [FromUri] G
             {
                 IFunctionalService service = getService(serviceName);
                 if (SettingsManager.ProviderSettings.JobBinding
-                    && !service.IsBound(sessionToken, id))
+                    && !service.IsBound(getOwnerId(sessionToken), id))
                 {
                     throw new InvalidSessionException("Request failed as the job referred to in this request does not belong to this consumer.");
                 }
@@ -523,7 +524,7 @@ public virtual HttpResponseMessage Put([FromUri] string serviceName, [FromUri] G
             {
                 IFunctionalService service = getService(serviceName);
                 if (SettingsManager.ProviderSettings.JobBinding
-                    && !service.IsBound(sessionToken, id))
+                    && !service.IsBound(getOwnerId(sessionToken), id))
                 {
                     throw new InvalidSessionException("Request failed as the job referred to in this request does not belong to this consumer.");
                 }
@@ -564,7 +565,7 @@ public virtual HttpResponseMessage Delete([FromUri] string serviceName, [FromUri
             {
                 IFunctionalService service = getService(serviceName);
                 if (SettingsManager.ProviderSettings.JobBinding
-                    && !service.IsBound(sessionToken, id))
+                    && !service.IsBound(getOwnerId(sessionToken), id))
                 {
                     throw new InvalidSessionException("Request failed as the job referred to in this request does not belong to this consumer.");
                 }
@@ -608,7 +609,7 @@ public virtual HttpResponseMessage Post([FromUri] string serviceName, [FromUri]
             {
                 IFunctionalService service = getService(serviceName);
                 if (SettingsManager.ProviderSettings.JobBinding
-                    && !service.IsBound(sessionToken, id))
+                    && !service.IsBound(getOwnerId(sessionToken), id))
                 {
                     throw new InvalidSessionException("Request failed as the job referred to in this request does not belong to this consumer.");
                 }
@@ -634,7 +635,7 @@ public virtual HttpResponseMessage Post([FromUri] string serviceName, [FromUri]
             {
                 throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.InternalServerError, "Request failed for creating state for phase " + phaseName + " in job " + id + ".\n " + e.Message));
             }
-           
+
             return result;
         }
 
@@ -684,7 +685,7 @@ protected virtual string CheckAuthorisation(string[] zone, string[] context)
             {
                 throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.BadRequest, "Request failed as Zone and/or Context are invalid."));
             }
-            
+
             return sessionToken;
         }
 
@@ -751,7 +752,7 @@ where s.Type.Equals(ServiceType.FUNCTIONAL.ToString())
         /// <param name="right">The right to search for (the needle)</param>
         private void CheckRights(string serviceName, IDictionary<string, Right> rights, Right right)
         {
-            
+
         }
 
         /// <summary>
@@ -772,16 +773,22 @@ protected virtual void preventPagingHeaders()
         /// <returns>A response message</returns>
         protected HttpResponseMessage OKResult(string payload = null)
         {
-            if(StringUtils.IsEmpty(payload))
+            if (StringUtils.IsEmpty(payload))
             {
                 return new HttpResponseMessage(HttpStatusCode.NoContent);
             }
 
             string accept = HttpUtils.GetAccept(Request);
-            return new HttpResponseMessage(HttpStatusCode.OK) {
+            return new HttpResponseMessage(HttpStatusCode.OK)
+            {
                 Content = new StringContent(payload, Encoding.UTF8, accept)
             };
         }
+
+        private String getOwnerId(String sessionToken)
+        {
+            return sessionToken;
+        }
     }
 
 }

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,6 @@`
`33`	`33`	`using System.Text;`
`34`	`34`	`using System.Web.Http;`
`35`	`35`	`using System.Linq;`
`36`		`-using Sif.Framework.Model.Settings;`
`37`	`36`
`38`	`37`	`namespace Sif.Framework.Providers`
`39`	`38`	`{`
`@@ -102,12 +101,12 @@ public virtual HttpResponseMessage Post([FromUri] string serviceName, [FromUri]`
`102`	`101`	`{`
`103`	`102`	`return Request.CreateErrorResponse(HttpStatusCode.BadRequest, "Request requires use of advisory id, but none has been supplied.");`
`104`	`103`	`}`
`105`		`-`
	`104`	`+`
`106`	`105`	`Guid id = service.Create(item, zone: (zone == null ? null : zone[0]), context: (context == null ? null : context[0]));`
`107`	`106`
`108`		`- if(SettingsManager.ProviderSettings.JobBinding)`
	`107`	`+ if (SettingsManager.ProviderSettings.JobBinding)`
`109`	`108`	`{`
`110`		`- service.Bind(sessionToken, id);`
	`109`	`+ service.Bind(getOwnerId(sessionToken), id);`
`111`	`110`	`}`
`112`	`111`
`113`	`112`	`jobType job = service.Retrieve(id, zone: (zone == null ? null : zone[0]), context: (context == null ? null : context[0]));`
`@@ -161,7 +160,8 @@ public virtual HttpResponseMessage Post([FromUri] string serviceName, [FromBody]`
`161`	`160`	`List<createType> creates = new List<createType>();`
`162`	`161`	`foreach (jobType job in items.job)`
`163`	`162`	`{`
`164`		`- try {`
	`163`	`+ try`
	`164`	`+ {`
`165`	`165`	`if (!service.AcceptJob(serviceName, job.name))`
`166`	`166`	`{`
`167`	`167`	`throw new ArgumentException("Service " + serviceName + " does not handle jobs named " + job.name);`
`@@ -170,16 +170,17 @@ public virtual HttpResponseMessage Post([FromUri] string serviceName, [FromBody]`
`170`	`170`
`171`	`171`	`if (SettingsManager.ProviderSettings.JobBinding)`
`172`	`172`	`{`
`173`		`- service.Bind(sessionToken, id);`
	`173`	`+ service.Bind(getOwnerId(sessionToken), id);`
`174`	`174`	`}`
`175`	`175`
`176`	`176`	`creates.Add(ProviderUtils.CreateCreate(HttpStatusCode.Created, id.ToString(), job.id));`
`177`		`- } catch(CreateException e)`
	`177`	`+ }`
	`178`	`+ catch (CreateException e)`
`178`	`179`	`{`
`179`	`180`	`ProviderUtils.CreateCreate(HttpStatusCode.Conflict, job.id, error: ProviderUtils.CreateError(HttpStatusCode.Conflict, HttpStatusCode.Conflict.ToString(), e.Message));`
`180`	`181`	`}`
`181`	`182`	`}`
`182`		`-`
	`183`	`+`
`183`	`184`	`createResponseType createResponse = ProviderUtils.CreateCreateResponse(creates.ToArray());`
`184`	`185`
`185`	`186`	`result = Request.CreateResponse<createResponseType>(HttpStatusCode.Created, createResponse);`
`@@ -244,7 +245,7 @@ public virtual ICollection<jobType> Get([FromUri] string serviceName, [MatrixPar`
`244`	`245`	`foreach (jobType job in jobs)`
`245`	`246`	`{`
`246`	`247`	`if (!SettingsManager.ProviderSettings.JobBinding`
`247`		`- \|\| service.IsBound(sessionToken, Guid.Parse(job.id)))`
	`248`	`+ \|\| service.IsBound(getOwnerId(sessionToken), Guid.Parse(job.id)))`
`248`	`249`	`{`
`249`	`250`	`items.Add(job);`
`250`	`251`	`}`
`@@ -283,7 +284,7 @@ public virtual HttpResponseMessage Get([FromUri] string serviceName, [FromUri] G`
`283`	`284`	`item = service.Retrieve(id, zone: (zone == null ? null : zone[0]), context: (context == null ? null : context[0]));`
`284`	`285`
`285`	`286`	`if (SettingsManager.ProviderSettings.JobBinding`
`286`		`- && !service.IsBound(sessionToken, Guid.Parse(item.id)))`
	`287`	`+ && !service.IsBound(getOwnerId(sessionToken), Guid.Parse(item.id)))`
`287`	`288`	`{`
`288`	`289`	`throw new InvalidSessionException("Request failed as one or more jobs referred to in this request do not belong to this consumer.");`
`289`	`290`	`}`
`@@ -343,7 +344,7 @@ public virtual HttpResponseMessage Delete([FromUri] string serviceName, [FromUri`
`343`	`344`	`IFunctionalService service = getService(serviceName);`
`344`	`345`
`345`	`346`	`if (SettingsManager.ProviderSettings.JobBinding`
`346`		`- && !service.IsBound(sessionToken, id))`
	`347`	`+ && !service.IsBound(getOwnerId(sessionToken), id))`
`347`	`348`	`{`
`348`	`349`	`throw new InvalidSessionException("Request failed as one or more jobs referred to in this request do not belong to this consumer.");`
`349`	`350`	`}`
`@@ -383,7 +384,7 @@ public virtual HttpResponseMessage Delete([FromUri] string serviceName, [FromBod`
`383`	`384`	`try`
`384`	`385`	`{`
`385`	`386`	`if (SettingsManager.ProviderSettings.JobBinding`
`386`		`- && !service.IsBound(sessionToken, Guid.Parse(deleteId.id)))`
	`387`	`+ && !service.IsBound(getOwnerId(sessionToken), Guid.Parse(deleteId.id)))`
`387`	`388`	`{`
`388`	`389`	`throw new InvalidSessionException("Request failed as one or more jobs referred to in this request do not belong to this consumer.");`
`389`	`390`	`}`
`@@ -443,7 +444,7 @@ public virtual HttpResponseMessage Post([FromUri] string serviceName, [FromUri]`
`443`	`444`	`{`
`444`	`445`	`IFunctionalService service = getService(serviceName);`
`445`	`446`	`if (SettingsManager.ProviderSettings.JobBinding`
`446`		`- && !service.IsBound(sessionToken, id))`
	`447`	`+ && !service.IsBound(getOwnerId(sessionToken), id))`
`447`	`448`	`{`
`448`	`449`	`throw new InvalidSessionException("Request failed as the job referred to in this request does not belong to this consumer.");`
`449`	`450`	`}`
`@@ -484,7 +485,7 @@ public virtual HttpResponseMessage Get([FromUri] string serviceName, [FromUri] G`
`484`	`485`	`{`
`485`	`486`	`IFunctionalService service = getService(serviceName);`
`486`	`487`	`if (SettingsManager.ProviderSettings.JobBinding`
`487`		`- && !service.IsBound(sessionToken, id))`
	`488`	`+ && !service.IsBound(getOwnerId(sessionToken), id))`
`488`	`489`	`{`
`489`	`490`	`throw new InvalidSessionException("Request failed as the job referred to in this request does not belong to this consumer.");`
`490`	`491`	`}`
`@@ -523,7 +524,7 @@ public virtual HttpResponseMessage Put([FromUri] string serviceName, [FromUri] G`
`523`	`524`	`{`
`524`	`525`	`IFunctionalService service = getService(serviceName);`
`525`	`526`	`if (SettingsManager.ProviderSettings.JobBinding`
`526`		`- && !service.IsBound(sessionToken, id))`
	`527`	`+ && !service.IsBound(getOwnerId(sessionToken), id))`
`527`	`528`	`{`
`528`	`529`	`throw new InvalidSessionException("Request failed as the job referred to in this request does not belong to this consumer.");`
`529`	`530`	`}`
`@@ -564,7 +565,7 @@ public virtual HttpResponseMessage Delete([FromUri] string serviceName, [FromUri`
`564`	`565`	`{`
`565`	`566`	`IFunctionalService service = getService(serviceName);`
`566`	`567`	`if (SettingsManager.ProviderSettings.JobBinding`
`567`		`- && !service.IsBound(sessionToken, id))`
	`568`	`+ && !service.IsBound(getOwnerId(sessionToken), id))`
`568`	`569`	`{`
`569`	`570`	`throw new InvalidSessionException("Request failed as the job referred to in this request does not belong to this consumer.");`
`570`	`571`	`}`
`@@ -608,7 +609,7 @@ public virtual HttpResponseMessage Post([FromUri] string serviceName, [FromUri]`
`608`	`609`	`{`
`609`	`610`	`IFunctionalService service = getService(serviceName);`
`610`	`611`	`if (SettingsManager.ProviderSettings.JobBinding`
`611`		`- && !service.IsBound(sessionToken, id))`
	`612`	`+ && !service.IsBound(getOwnerId(sessionToken), id))`
`612`	`613`	`{`
`613`	`614`	`throw new InvalidSessionException("Request failed as the job referred to in this request does not belong to this consumer.");`
`614`	`615`	`}`
`@@ -634,7 +635,7 @@ public virtual HttpResponseMessage Post([FromUri] string serviceName, [FromUri]`
`634`	`635`	`{`
`635`	`636`	`throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.InternalServerError, "Request failed for creating state for phase " + phaseName + " in job " + id + ".\n " + e.Message));`
`636`	`637`	`}`
`637`		`-`
	`638`	`+`
`638`	`639`	`return result;`
`639`	`640`	`}`
`640`	`641`
`@@ -684,7 +685,7 @@ protected virtual string CheckAuthorisation(string[] zone, string[] context)`
`684`	`685`	`{`
`685`	`686`	`throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.BadRequest, "Request failed as Zone and/or Context are invalid."));`
`686`	`687`	`}`
`687`		`-`
	`688`	`+`
`688`	`689`	`return sessionToken;`
`689`	`690`	`}`
`690`	`691`
`@@ -751,7 +752,7 @@ where s.Type.Equals(ServiceType.FUNCTIONAL.ToString())`
`751`	`752`	`/// <param name="right">The right to search for (the needle)</param>`
`752`	`753`	`private void CheckRights(string serviceName, IDictionary<string, Right> rights, Right right)`
`753`	`754`	`{`
`754`		`-`
	`755`	`+`
`755`	`756`	`}`
`756`	`757`
`757`	`758`	`/// <summary>`
`@@ -772,16 +773,22 @@ protected virtual void preventPagingHeaders()`
`772`	`773`	`/// <returns>A response message</returns>`
`773`	`774`	`protected HttpResponseMessage OKResult(string payload = null)`
`774`	`775`	`{`
`775`		`- if(StringUtils.IsEmpty(payload))`
	`776`	`+ if (StringUtils.IsEmpty(payload))`
`776`	`777`	`{`
`777`	`778`	`return new HttpResponseMessage(HttpStatusCode.NoContent);`
`778`	`779`	`}`
`779`	`780`
`780`	`781`	`string accept = HttpUtils.GetAccept(Request);`
`781`		`- return new HttpResponseMessage(HttpStatusCode.OK) {`
	`782`	`+ return new HttpResponseMessage(HttpStatusCode.OK)`
	`783`	`+ {`
`782`	`784`	`Content = new StringContent(payload, Encoding.UTF8, accept)`
`783`	`785`	`};`
`784`	`786`	`}`
	`787`	`+`
	`788`	`+ private String getOwnerId(String sessionToken)`
	`789`	`+ {`
	`790`	`+ return sessionToken;`
	`791`	`+ }`
`785`	`792`	`}`
`786`	`793`
`787`	`794`	`}`