-
-
Notifications
You must be signed in to change notification settings - Fork 408
/
Copy pathReadOnlyBase.cs
1946 lines (1754 loc) · 63.7 KB
/
ReadOnlyBase.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//-----------------------------------------------------------------------
// <copyright file="ReadOnlyBase.cs" company="Marimer LLC">
// Copyright (c) Marimer LLC. All rights reserved.
// Website: https://cslanet.com
// </copyright>
// <summary>This is a base class from which readonly business classes</summary>
//-----------------------------------------------------------------------
using System.Collections.Concurrent;
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Linq.Expressions;
using System.Reflection;
using Csla.Core;
using Csla.Core.FieldManager;
using Csla.Core.LoadManager;
using Csla.Properties;
using Csla.Reflection;
using Csla.Rules;
using Csla.Security;
using Csla.Serialization.Mobile;
using Csla.Server;
namespace Csla
{
/// <summary>
/// This is a base class from which readonly business classes
/// can be derived.
/// </summary>
/// <remarks>
/// This base class only supports data retrieve, not updating or
/// deleting. Any business classes derived from this base class
/// should only implement readonly properties.
/// </remarks>
/// <typeparam name="T">Type of the business object.</typeparam>
[Serializable]
public abstract class ReadOnlyBase<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
T> : BindableBase,
IDataPortalTarget,
IManageProperties,
IReadOnlyBase,
IUseApplicationContext,
IUseFieldManager,
IUseBusinessRules
where T : ReadOnlyBase<T>
{
#region Object ID Value
/// <summary>
/// Override this method to return a unique identifying
/// value for this object.
/// </summary>
protected virtual object GetIdValue()
{
return null;
}
#endregion
#region System.Object Overrides
/// <summary>
/// Returns a text representation of this object by
/// returning the <see cref="GetIdValue"/> value
/// in text form.
/// </summary>
public override string ToString()
{
object id = GetIdValue();
if (id == null)
return base.ToString();
else
return id.ToString();
}
#endregion
/// <summary>
/// Gets or sets the current ApplicationContext object.
/// </summary>
protected ApplicationContext ApplicationContext { get; set; }
ApplicationContext IUseApplicationContext.ApplicationContext
{
get => ApplicationContext;
set
{
ApplicationContext = value;
Initialize();
InitializeBusinessRules();
}
}
/// <summary>
/// Creates an instance of the type.
/// </summary>
protected ReadOnlyBase()
{
}
#region Initialize
/// <summary>
/// Override this method to set up event handlers so user
/// code in a partial class can respond to events raised by
/// generated code.
/// </summary>
protected virtual void Initialize()
{ /* allows subclass to initialize events before any other activity occurs */ }
#endregion
#region Identity
int IBusinessObject.Identity
{
get { return 0; }
}
#endregion
#region Authorization
/// <summary>
/// Gets or sets if <see cref="CanReadProperty(IPropertyInfo)"/> performs an authorization check or not. <br/>
/// <see langword="true"/> means read is <i>always</i> allowed. <see langword="false"/> means an authorization check is always performed.
/// </summary>
protected virtual bool IsCanReadPropertyAuthorizationCheckDisabled { get; } = false;
[NotUndoable]
[NonSerialized]
private ConcurrentDictionary<string, bool> _readResultCache;
[NotUndoable]
[NonSerialized]
private ConcurrentDictionary<string, bool> _executeResultCache;
[NotUndoable]
[NonSerialized]
private System.Security.Principal.IPrincipal _lastPrincipal;
private void InitializeBusinessRules()
{
var rules = BusinessRuleManager.GetRulesForType(GetType());
if (!rules.Initialized)
lock (rules)
if (!rules.Initialized)
{
try
{
AddBusinessRules();
rules.Initialized = true;
}
catch (Exception)
{
BusinessRuleManager.CleanupRulesForType(GetType());
throw; // and rethrow exception
}
}
}
private BusinessRules _businessRules;
/// <summary>
/// Provides access to the broken rules functionality.
/// </summary>
/// <remarks>
/// This property is used within your business logic so you can
/// easily call the AddRule() method to associate business
/// rules with your object's properties.
/// </remarks>
protected BusinessRules BusinessRules
{
get
{
if (_businessRules == null)
_businessRules = ApplicationContext.CreateInstanceDI<BusinessRules>(ApplicationContext, this);
else if (_businessRules.Target == null)
_businessRules.SetTarget(this);
return _businessRules;
}
}
BusinessRules IUseBusinessRules.BusinessRules => BusinessRules;
void IHostRules.RuleStart(IPropertyInfo property)
{ }
void IHostRules.RuleComplete(IPropertyInfo property)
{ }
void IHostRules.RuleComplete(string property)
{ }
void IHostRules.AllRulesComplete()
{ }
/// <summary>
/// Override this method to add per-type
/// authorization rules for your type's properties.
/// </summary>
/// <remarks>
/// AddSharedAuthorizationRules is automatically called by CSLA .NET
/// when your object should associate per-type authorization roles
/// with its properties.
/// </remarks>
protected virtual void AddBusinessRules()
{ }
/// <summary>
/// Returns true if the user is allowed to read the
/// calling property.
/// </summary>
/// <param name="property">Property to check.</param>
[EditorBrowsable(EditorBrowsableState.Advanced)]
public virtual bool CanReadProperty(IPropertyInfo property)
{
if (IsCanReadPropertyAuthorizationCheckDisabled)
{
return true;
}
bool result = true;
VerifyAuthorizationCache();
if (!_readResultCache.TryGetValue(property.Name, out result))
{
result = BusinessRules.HasPermission(ApplicationContext, AuthorizationActions.ReadProperty, property);
// store value in cache
_readResultCache.AddOrUpdate(property.Name, result, (_, _) => { return result; });
}
return result;
}
/// <summary>
/// Returns true if the user is allowed to read the
/// calling property.
/// </summary>
/// <returns>true if read is allowed.</returns>
/// <param name="property">Property to read.</param>
/// <param name="throwOnFalse">Indicates whether a negative
/// result should cause an exception.</param>
[EditorBrowsable(EditorBrowsableState.Advanced)]
public bool CanReadProperty(IPropertyInfo property, bool throwOnFalse)
{
bool result = CanReadProperty(property);
if (throwOnFalse && result == false)
{
throw new SecurityException($"{Resources.PropertyGetNotAllowed} ({property.Name})");
}
return result;
}
/// <summary>
/// Returns true if the user is allowed to read the
/// specified property.
/// </summary>
/// <param name="propertyName">Name of the property to read.</param>
[EditorBrowsable(EditorBrowsableState.Advanced)]
public bool CanReadProperty(string propertyName)
{
return CanReadProperty(propertyName, false);
}
/// <summary>
/// Returns true if the user is allowed to read the
/// specified property.
/// </summary>
/// <param name="propertyName">Name of the property to read.</param>
/// <param name="throwOnFalse">Indicates whether a negative
/// result should cause an exception.</param>
private bool CanReadProperty(string propertyName, bool throwOnFalse)
{
var propertyInfo = FieldManager.GetRegisteredProperties().FirstOrDefault(p => p.Name == propertyName);
if (propertyInfo == null)
{
#if !(ANDROID || IOS)
Trace.TraceError("CanReadProperty: {0} is not a registered property of {1}.{2}", propertyName, GetType().Namespace, GetType().Name);
#endif
return true;
}
return CanReadProperty(propertyInfo, throwOnFalse);
}
bool IAuthorizeReadWrite.CanWriteProperty(string propertyName)
{
return false;
}
bool IAuthorizeReadWrite.CanWriteProperty(IPropertyInfo property)
{
return false;
}
private void VerifyAuthorizationCache()
{
if (_readResultCache == null)
_readResultCache = new ConcurrentDictionary<string, bool>();
if (_executeResultCache == null)
_executeResultCache = new ConcurrentDictionary<string, bool>();
if (!ReferenceEquals(ApplicationContext.User, _lastPrincipal))
{
// the principal has changed - reset the cache
_readResultCache.Clear();
_executeResultCache.Clear();
_lastPrincipal = ApplicationContext.User;
}
}
/// <summary>
/// Returns true if the user is allowed to execute
/// the specified method.
/// </summary>
/// <param name="method">Method to execute.</param>
/// <returns>true if execute is allowed.</returns>
[EditorBrowsable(EditorBrowsableState.Advanced)]
public virtual bool CanExecuteMethod(IMemberInfo method)
{
bool result = true;
VerifyAuthorizationCache();
if (!_executeResultCache.TryGetValue(method.Name, out result))
{
result = BusinessRules.HasPermission(ApplicationContext, AuthorizationActions.ExecuteMethod, method);
_executeResultCache.AddOrUpdate(method.Name, result, (_, _) => { return result; });
}
return result;
}
/// <summary>
/// Returns true if the user is allowed to execute
/// the specified method.
/// </summary>
/// <returns>true if execute is allowed.</returns>
/// <param name="method">Method to execute.</param>
/// <param name="throwOnFalse">Indicates whether a negative
/// result should cause an exception.</param>
[EditorBrowsable(EditorBrowsableState.Advanced)]
public bool CanExecuteMethod(IMemberInfo method, bool throwOnFalse)
{
bool result = CanExecuteMethod(method);
if (throwOnFalse && result == false)
{
SecurityException ex =
new SecurityException($"{Resources.MethodExecuteNotAllowed} ({method.Name})");
throw ex;
}
return result;
}
/// <summary>
/// Returns true if the user is allowed to execute
/// the specified method.
/// </summary>
/// <param name="methodName">Name of the method to execute.</param>
/// <returns>true if execute is allowed.</returns>
[EditorBrowsable(EditorBrowsableState.Advanced)]
public virtual bool CanExecuteMethod(string methodName)
{
return CanExecuteMethod(methodName, false);
}
private bool CanExecuteMethod(string methodName, bool throwOnFalse)
{
bool result = CanExecuteMethod(new MethodInfo(methodName));
if (throwOnFalse && result == false)
{
throw new SecurityException($"{Resources.MethodExecuteNotAllowed} ({methodName})");
}
return result;
}
#endregion
#region IClonable
object ICloneable.Clone()
{
return GetClone();
}
/// <summary>
/// Creates a clone of the object.
/// </summary>
/// <returns>A new object containing the exact data of the original object.</returns>
[EditorBrowsable(EditorBrowsableState.Advanced)]
public virtual object GetClone()
{
return ObjectCloner.GetInstance(ApplicationContext).Clone(this);
}
/// <summary>
/// Creates a clone of the object.
/// </summary>
/// <returns>
/// A new object containing the exact data of the original object.
/// </returns>
public T Clone()
{
return (T)GetClone();
}
#endregion
#region Data Access
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA1801:ReviewUnusedParameters", MessageId = "criteria")]
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]
private void DataPortal_Create(object criteria)
{
throw new NotSupportedException(Resources.CreateNotSupportedException);
}
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]
private void DataPortal_Update()
{
throw new NotSupportedException(Resources.UpdateNotSupportedException);
}
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA1801:ReviewUnusedParameters", MessageId = "criteria")]
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]
[Delete]
private void DataPortal_Delete(object criteria)
{
throw new NotSupportedException(Resources.DeleteNotSupportedException);
}
/// <summary>
/// Called by the server-side DataPortal prior to calling the
/// requested DataPortal_xyz method.
/// </summary>
/// <param name="e">The DataPortalContext object passed to the DataPortal.</param>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1707:IdentifiersShouldNotContainUnderscores", MessageId = "Member")]
[EditorBrowsable(EditorBrowsableState.Advanced)]
protected virtual void DataPortal_OnDataPortalInvoke(DataPortalEventArgs e)
{
}
/// <summary>
/// Called by the server-side DataPortal after calling the
/// requested DataPortal_xyz method.
/// </summary>
/// <param name="e">The DataPortalContext object passed to the DataPortal.</param>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1707:IdentifiersShouldNotContainUnderscores", MessageId = "Member")]
[EditorBrowsable(EditorBrowsableState.Advanced)]
protected virtual void DataPortal_OnDataPortalInvokeComplete(DataPortalEventArgs e)
{
}
/// <summary>
/// Called by the server-side DataPortal if an exception
/// occurs during data access.
/// </summary>
/// <param name="e">The DataPortalContext object passed to the DataPortal.</param>
/// <param name="ex">The Exception thrown during data access.</param>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1707:IdentifiersShouldNotContainUnderscores", MessageId = "Member")]
[EditorBrowsable(EditorBrowsableState.Advanced)]
protected virtual void DataPortal_OnDataPortalException(DataPortalEventArgs e, Exception ex)
{
}
/// <summary>
/// Called by the server-side DataPortal prior to calling the
/// requested DataPortal_XYZ method.
/// </summary>
/// <param name="e">The DataPortalContext object passed to the DataPortal.</param>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1707:IdentifiersShouldNotContainUnderscores", MessageId = "Member")]
[EditorBrowsable(EditorBrowsableState.Advanced)]
protected virtual void Child_OnDataPortalInvoke(DataPortalEventArgs e)
{
}
/// <summary>
/// Called by the server-side DataPortal after calling the
/// requested DataPortal_XYZ method.
/// </summary>
/// <param name="e">The DataPortalContext object passed to the DataPortal.</param>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1707:IdentifiersShouldNotContainUnderscores", MessageId = "Member")]
[EditorBrowsable(EditorBrowsableState.Advanced)]
protected virtual void Child_OnDataPortalInvokeComplete(DataPortalEventArgs e)
{
}
/// <summary>
/// Called by the server-side DataPortal if an exception
/// occurs during data access.
/// </summary>
/// <param name="e">The DataPortalContext object passed to the DataPortal.</param>
/// <param name="ex">The Exception thrown during data access.</param>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1707:IdentifiersShouldNotContainUnderscores", MessageId = "Member")]
[EditorBrowsable(EditorBrowsableState.Advanced)]
protected virtual void Child_OnDataPortalException(DataPortalEventArgs e, Exception ex)
{
}
#endregion
#region Serialization Notification
void ISerializationNotification.Deserialized()
{
OnDeserializedHandler(new System.Runtime.Serialization.StreamingContext());
}
[System.Runtime.Serialization.OnDeserialized]
private void OnDeserializedHandler(System.Runtime.Serialization.StreamingContext context)
{
if (_fieldManager != null)
FieldManager.SetPropertyList(GetType());
InitializeBusinessRules();
}
#endregion
#region Register Properties
/// <summary>
/// Indicates that the specified property belongs
/// to the type.
/// </summary>
/// <typeparam name="P">
/// Type of property.
/// </typeparam>
/// <param name="objectType">
/// Type of object to which the property belongs.
/// </param>
/// <param name="info">
/// PropertyInfo object for the property.
/// </param>
/// <returns>
/// The provided IPropertyInfo object.
/// </returns>
protected static PropertyInfo<P> RegisterProperty<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
P>(
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
Type objectType, PropertyInfo<P> info)
{
return PropertyInfoManager.RegisterProperty<P>(objectType, info);
}
/// <summary>
/// Indicates that the specified property belongs
/// to the business object type.
/// </summary>
/// <typeparam name="P">
/// Type of property.
/// </typeparam>
/// <param name="info">
/// PropertyInfo object for the property.
/// </param>
/// <returns>
/// The provided IPropertyInfo object.
/// </returns>
protected static PropertyInfo<P> RegisterProperty<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
P>(PropertyInfo<P> info)
{
return PropertyInfoManager.RegisterProperty<P>(typeof(T), info);
}
/// <summary>
/// Indicates that the specified property belongs
/// to the business object type.
/// </summary>
/// <typeparam name="P">Type of property</typeparam>
/// <param name="propertyName">Property name from nameof()</param>
protected static PropertyInfo<P> RegisterProperty<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
P>(string propertyName)
{
return RegisterProperty(PropertyInfoFactory.Factory.Create<P>(typeof(T), propertyName));
}
/// <summary>
/// Indicates that the specified property belongs
/// to the business object type.
/// </summary>
/// <typeparam name="P">Type of property</typeparam>
/// <param name="propertyLambdaExpression">Property Expression</param>
protected static PropertyInfo<P> RegisterProperty<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
P>(Expression<Func<T, object>> propertyLambdaExpression)
{
PropertyInfo reflectedPropertyInfo = Reflect<T>.GetProperty(propertyLambdaExpression);
return RegisterProperty<P>(reflectedPropertyInfo.Name);
}
/// <summary>
/// Indicates that the specified property belongs
/// to the business object type.
/// </summary>
/// <typeparam name="P">Type of property</typeparam>
/// <param name="propertyName">Property name from nameof()</param>
/// <param name="friendlyName">Friendly description for a property to be used in databinding</param>
protected static PropertyInfo<P> RegisterProperty<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
P>(string propertyName, string friendlyName)
{
return RegisterProperty(PropertyInfoFactory.Factory.Create<P>(typeof(T), propertyName, friendlyName));
}
/// <summary>
/// Indicates that the specified property belongs
/// to the business object type.
/// </summary>
/// <typeparam name="P">Type of property</typeparam>
/// <param name="propertyLambdaExpression">Property Expression</param>
/// <param name="friendlyName">Friendly description for a property to be used in databinding</param>
protected static PropertyInfo<P> RegisterProperty<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
P>(Expression<Func<T, object>> propertyLambdaExpression, string friendlyName)
{
PropertyInfo reflectedPropertyInfo = Reflect<T>.GetProperty(propertyLambdaExpression);
return RegisterProperty<P>(reflectedPropertyInfo.Name, friendlyName);
}
/// <summary>
/// Indicates that the specified property belongs
/// to the business object type.
/// </summary>
/// <typeparam name="P">Type of property</typeparam>
/// <param name="propertyName">Property name from nameof()</param>
/// <param name="friendlyName">Friendly description for a property to be used in databinding</param>
/// <param name="defaultValue">Default Value for the property</param>
protected static PropertyInfo<P> RegisterProperty<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
P>(string propertyName, string friendlyName, P defaultValue)
{
return RegisterProperty(PropertyInfoFactory.Factory.Create<P>(typeof(T), propertyName, friendlyName, defaultValue));
}
/// <summary>
/// Indicates that the specified property belongs
/// to the business object type.
/// </summary>
/// <typeparam name="P">Type of property</typeparam>
/// <param name="propertyLambdaExpression">Property Expression</param>
/// <param name="friendlyName">Friendly description for a property to be used in databinding</param>
/// <param name="defaultValue">Default Value for the property</param>
protected static PropertyInfo<P> RegisterProperty<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
P>(Expression<Func<T, object>> propertyLambdaExpression, string friendlyName, P defaultValue)
{
PropertyInfo reflectedPropertyInfo = Reflect<T>.GetProperty(propertyLambdaExpression);
return RegisterProperty<P>(reflectedPropertyInfo.Name, friendlyName, defaultValue);
}
/// <summary>
/// Indicates that the specified property belongs
/// to the business object type.
/// </summary>
/// <typeparam name="P">Type of property</typeparam>
/// <param name="propertyName">Property name from nameof()</param>
/// <param name="relationship">Relationship with property value.</param>
protected static PropertyInfo<P> RegisterProperty<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
P>(string propertyName, RelationshipTypes relationship)
{
return RegisterProperty(PropertyInfoFactory.Factory.Create<P>(typeof(T), propertyName, string.Empty, relationship));
}
/// <summary>
/// Indicates that the specified property belongs
/// to the business object type.
/// </summary>
/// <typeparam name="P">Type of property</typeparam>
/// <param name="propertyLambdaExpression">Property Expression</param>
/// <param name="relationship">Relationship with property value.</param>
protected static PropertyInfo<P> RegisterProperty<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
P>(Expression<Func<T, object>> propertyLambdaExpression, RelationshipTypes relationship)
{
PropertyInfo reflectedPropertyInfo = Reflect<T>.GetProperty(propertyLambdaExpression);
return RegisterProperty<P>(reflectedPropertyInfo.Name, relationship);
}
/// <summary>
/// Indicates that the specified property belongs
/// to the business object type.
/// </summary>
/// <typeparam name="P">Type of property</typeparam>
/// <param name="propertyName">Property name from nameof()</param>
/// <param name="friendlyName">Friendly description for a property to be used in databinding</param>
/// <param name="defaultValue">Default Value for the property</param>
/// <param name="relationship">Relationship with property value.</param>
protected static PropertyInfo<P> RegisterProperty<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
P>(string propertyName, string friendlyName, P defaultValue, RelationshipTypes relationship)
{
return RegisterProperty(PropertyInfoFactory.Factory.Create<P>(typeof(T), propertyName, friendlyName, defaultValue, relationship));
}
/// <summary>
/// Indicates that the specified property belongs
/// to the business object type.
/// </summary>
/// <typeparam name="P">Type of property</typeparam>
/// <param name="propertyLambdaExpression">Property Expression</param>
/// <param name="friendlyName">Friendly description for a property to be used in databinding</param>
/// <param name="defaultValue">Default Value for the property</param>
/// <param name="relationship">Relationship with property value.</param>
protected static PropertyInfo<P> RegisterProperty<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
P>(Expression<Func<T, object>> propertyLambdaExpression, string friendlyName, P defaultValue, RelationshipTypes relationship)
{
PropertyInfo reflectedPropertyInfo = Reflect<T>.GetProperty(propertyLambdaExpression);
return RegisterProperty<P>(reflectedPropertyInfo.Name, friendlyName, defaultValue, relationship);
}
#endregion
#region Register Methods
/// <summary>
/// Indicates that the specified method belongs
/// to the type.
/// </summary>
/// <param name="objectType">
/// Type of object to which the method belongs.
/// </param>
/// <param name="info">
/// IMemberInfo object for the property.
/// </param>
/// <returns>
/// The provided IMemberInfo object.
/// </returns>
protected static IMemberInfo RegisterMethod(Type objectType, IMemberInfo info)
{
var reflected = objectType.GetMethod(info.Name);
if (reflected == null)
throw new ArgumentException(string.Format(Resources.NoSuchMethod, info.Name), nameof(info));
return info;
}
/// <summary>
/// Indicates that the specified method belongs
/// to the type.
/// </summary>
/// <param name="objectType">
/// Type of object to which the method belongs.
/// </param>
/// <param name="methodName">
/// Name of the method.
/// </param>
/// <returns>
/// The provided IMemberInfo object.
/// </returns>
protected static MethodInfo RegisterMethod(Type objectType, string methodName)
{
var info = new MethodInfo(methodName);
RegisterMethod(objectType, info);
return info;
}
/// <summary>
/// Registers a method for use in Authorization.
/// </summary>
/// <param name="methodName">Method name from nameof()</param>
protected static MethodInfo RegisterMethod(string methodName)
{
return RegisterMethod(typeof(T), methodName);
}
/// <summary>
/// Registers the method.
/// </summary>
/// <param name="methodLambdaExpression">The method lambda expression.</param>
protected static MethodInfo RegisterMethod(Expression<Action<T>> methodLambdaExpression)
{
System.Reflection.MethodInfo reflectedMethodInfo = Reflect<T>.GetMethod(methodLambdaExpression);
return RegisterMethod(reflectedMethodInfo.Name);
}
#endregion
#region Get Properties
/// <summary>
/// Gets a property's value, first checking authorization.
/// </summary>
/// <typeparam name="P">
/// Type of the property.
/// </typeparam>
/// <param name="field">
/// The backing field for the property.</param>
/// <param name="propertyName">
/// The name of the property.</param>
/// <param name="defaultValue">
/// Value to be returned if the user is not
/// authorized to read the property.</param>
/// <remarks>
/// If the user is not authorized to read the property
/// value, the defaultValue value is returned as a
/// result.
/// </remarks>
protected P GetProperty<P>(string propertyName, P field, P defaultValue)
{
return GetProperty<P>(propertyName, field, defaultValue, NoAccessBehavior.SuppressException);
}
/// <summary>
/// Gets a property's value, first checking authorization.
/// </summary>
/// <typeparam name="P">
/// Type of the property.
/// </typeparam>
/// <param name="field">
/// The backing field for the property.</param>
/// <param name="propertyName">
/// The name of the property.</param>
/// <param name="defaultValue">
/// Value to be returned if the user is not
/// authorized to read the property.</param>
/// <param name="noAccess">
/// True if an exception should be thrown when the
/// user is not authorized to read this property.</param>
protected P GetProperty<P>(string propertyName, P field, P defaultValue, NoAccessBehavior noAccess)
{
#region Check to see if the property is marked with RelationshipTypes.PrivateField
var propertyInfo = FieldManager.GetRegisteredProperty(propertyName);
if ((propertyInfo.RelationshipType & RelationshipTypes.PrivateField) != RelationshipTypes.PrivateField)
throw new InvalidOperationException(Resources.PrivateFieldException);
#endregion
if (CanReadProperty(propertyInfo, noAccess == NoAccessBehavior.ThrowException))
return field;
return defaultValue;
}
/// <summary>
/// Gets a property's value, first checking authorization.
/// </summary>
/// <typeparam name="P">
/// Type of the property.
/// </typeparam>
/// <param name="field">
/// The backing field for the property.</param>
/// <param name="propertyInfo">
/// PropertyInfo object containing property metadata.</param>
/// <remarks>
/// If the user is not authorized to read the property
/// value, the defaultValue value is returned as a
/// result.
/// </remarks>
protected P GetProperty<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
P>(PropertyInfo<P> propertyInfo, P field)
{
return GetProperty<P>(propertyInfo.Name, field, propertyInfo.DefaultValue, NoAccessBehavior.SuppressException);
}
/// <summary>
/// Gets a property's value, first checking authorization.
/// </summary>
/// <typeparam name="P">
/// Type of the property.
/// </typeparam>
/// <param name="field">
/// The backing field for the property.</param>
/// <param name="propertyInfo">
/// PropertyInfo object containing property metadata.</param>
/// <param name="defaultValue">
/// Value to be returned if the user is not
/// authorized to read the property.</param>
/// <param name="noAccess">
/// True if an exception should be thrown when the
/// user is not authorized to read this property.</param>
protected P GetProperty<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
P>(PropertyInfo<P> propertyInfo, P field, P defaultValue, NoAccessBehavior noAccess)
{
return GetProperty<P>(propertyInfo.Name, field, defaultValue, noAccess);
}
/// <summary>
/// Lazily initializes a property and returns
/// the resulting value.
/// </summary>
/// <typeparam name="P">Type of the property.</typeparam>
/// <param name="property">PropertyInfo object containing property metadata.</param>
/// <param name="valueGenerator">Method returning the new value.</param>
/// <remarks>
/// If the user is not authorized to read the property
/// value, the defaultValue value is returned as a
/// result.
/// </remarks>
protected P LazyGetProperty<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
P>(PropertyInfo<P> property, Func<P> valueGenerator)
{
if (!(FieldManager.FieldExists(property)))
{
var result = valueGenerator();
LoadProperty(property, result);
}
return GetProperty<P>(property);
}
/// <summary>
/// Gets a value indicating whether a lazy loaded
/// property is currently being retrieved.
/// </summary>
/// <param name="propertyInfo">Property to check.</param>
protected bool PropertyIsLoading(IPropertyInfo propertyInfo)
{
return LoadManager.IsLoadingProperty(propertyInfo);
}
/// <summary>
/// Lazily initializes a property and returns
/// the resulting value.
/// </summary>
/// <typeparam name="P">Type of the property.</typeparam>
/// <param name="property">PropertyInfo object containing property metadata.</param>
/// <param name="factory">Async method returning the new value.</param>
/// <remarks>
/// <para>
/// Note that the first value returned is almost certainly
/// the defaultValue because the value is initialized asynchronously.
/// The real value is provided later along with a PropertyChanged
/// event to indicate the value has changed.
/// </para><para>
/// If the user is not authorized to read the property
/// value, the defaultValue value is returned as a
/// result.
/// </para>
/// </remarks>
protected P LazyGetPropertyAsync<
#if NET8_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
#endif
P>(PropertyInfo<P> property, Task<P> factory)
{
if (!(FieldManager.FieldExists(property)) && !PropertyIsLoading(property))
{
LoadPropertyAsync(property, factory);
}
return GetProperty<P>(property);
}
/// <summary>
/// Gets a property's value as
/// a specified type, first checking authorization.
/// </summary>
/// <typeparam name="F">
/// Type of the field.
/// </typeparam>
/// <typeparam name="P">
/// Type of the property.
/// </typeparam>