Write the validation block - Validation block tutorial 3/4

Here i show you another example to use the validation application block
I’ll explain a little bit detail bellow the example

// User.cs
  1. using Common;
  2. using Microsoft.Practices.EnterpriseLibrary.Validation;
  3. using Microsoft.Practices.EnterpriseLibrary.Validation.Validators;
  4. using System;
  5. using System.Collections.Generic;
  6. using System.Linq;
  7. using System.Text;
  8. using System.Text.RegularExpressions;
  9.  
  10. namespace net.de.common.security.access.model
  11. {
  12. ///
  13. /// A property class that represent the User entity
  14. ///
  15. public class User
  16. {
  17. private long userId;
  18. private string username;
  19. private string password;
  20. private string retypePassword;
  21. private string passwordHint;
  22. private string firstName;
  23. private string lastName;
  24. private DateTime birthday;
  25. private string email;
  26. private string phoneNumber;
  27. private string mobilePhoneNumber;
  28. private Address address;
  29. private string userPic;
  30. private bool enabled;
  31. private bool accountExpired;
  32. private bool accountLocked;
  33. private bool credentialExpired;
  34.  
  35. public long UserId {
  36. get { return userId; }
  37. set { this.userId = value; }
  38. }
  39.  
  40. [ValidatorComposition(CompositionType.And, MessageTemplateResourceName = "MsgEmptyUsername", MessageTemplateResourceType = typeof(CommonResources))]
  41. [NotNullValidator]
  42. [StringLengthValidator(6, 20)]
  43. public string Username {
  44. get { return username; }
  45. set { this.username = value; }
  46. }
  47.  
  48. [ValidatorComposition(CompositionType.And, MessageTemplateResourceName = "MessageEmptyPassword", MessageTemplateResourceType = typeof(CommonResources))]
  49. [NotNullValidator]
  50. [StringLengthValidator(6, 20)]
  51. public string Password {
  52. get { return password; }
  53. set { this.password = value; }
  54. }
  55.  
  56. [PropertyComparisonValidator("Password", ComparisonOperator.Equal, MessageTemplateResourceName = "MsgInvalidPassword", MessageTemplateResourceType = typeof(CommonResources))]
  57. public string RetypePassword {
  58. get { return retypePassword; }
  59. set { this.retypePassword = value; }
  60. }
  61.  
  62. public string PasswordHint {
  63. get { return passwordHint; }
  64. set { this.passwordHint = value; }
  65. }
  66.  
  67. [NotNullValidator(MessageTemplateResourceName = "MsgEmptyFirstName", MessageTemplateResourceType = typeof(CommonResources))]
  68. public string FirstName {
  69. get { return firstName; }
  70. set { this.firstName = value; }
  71. }
  72.  
  73. public string LastName {
  74. get { return lastName; }
  75. set { this.lastName = value; }
  76. }
  77.  
  78. [RelativeDateTimeValidator(-120, DateTimeUnit.Year, -18, DateTimeUnit.Year, MessageTemplateResourceName = "MsgInvalidAge", MessageTemplateResourceType = typeof(CommonResources))]
  79. public DateTime Birthday {
  80. get { return birthday; }
  81. set { this.birthday = value; }
  82. }
  83.  
  84. [RegexValidator(@”\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*", MessageTemplateResourceName = "MsgInvalidEmail", MessageTemplateResourceType = typeof(CommonResources))]
  85. public string Email {
  86. get { return email; }
  87. set { this.email = value; }
  88. }
  89.  
  90. [ValidatorComposition(CompositionType.Or, MessageTemplateResourceName = "MsgInvalidPhoneNumber", MessageTemplateResourceType = typeof(CommonResources))]
  91. [StringLengthValidator(0)]
  92. [RegexValidator(@”(\+)?\b\d+\b")]
  93. public string PhoneNumber {
  94. get { return phoneNumber; }
  95. set { this.phoneNumber = value; }
  96. }
  97.  
  98. [ValidatorComposition(CompositionType.Or, MessageTemplateResourceName = "MsgInvalidMobilePhoneNumber", MessageTemplateResourceType = typeof(CommonResources))]
  99. [StringLengthValidator(0)]
  100. [RegexValidator(@”(\+)?\b\d{7,15}\b")]
  101. public string MobilePhoneNumber {
  102. get { return mobilePhoneNumber; }
  103. set { this.mobilePhoneNumber = value; }
  104. }
  105.  
  106. [NotNullValidator]
  107. [ObjectValidator]
  108. public Address Address {
  109. get { return address; }
  110. set { this.address = value; }
  111. }
  112.  
  113. public string UserPic {
  114. get { return userPic; }
  115. set { this.userPic = value; }
  116. }
  117.  
  118. public bool Enabled {
  119. get { return enabled; }
  120. set { this.enabled = value; }
  121. }
  122.  
  123. public bool AccountExpired {
  124. get { return accountExpired; }
  125. set { this.accountExpired = value; }
  126. }
  127.  
  128. public bool AccountLocked {
  129. get { return accountLocked; }
  130. set { this.accountLocked = value; }
  131. }
  132.  
  133. public bool CredentialExpired {
  134. get { return credentialExpired; }
  135. set { this.credentialExpired = value; }
  136. }
  137.  
  138. }
  139. }

And here is the Address.cs class

// Address.cs
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Text;
  5. using Microsoft.Practices.EnterpriseLibrary.Validation;
  6. using Microsoft.Practices.EnterpriseLibrary.Validation.Validators;
  7. using Common;
  8.  
  9. namespace net.de.common.security.access.model
  10. {
  11. ///
  12. /// A property class that represent the common address entity
  13. ///
  14. public class Address
  15. {
  16. private string line1;
  17. private string line2;
  18. private string city;
  19. private string state;
  20. private string postCode;
  21. private string country;
  22.  
  23. [StringLengthValidator(5, 50, MessageTemplateResourceName = "MsgInvalidLine1", MessageTemplateResourceType = typeof(CommonResources))]
  24. public string Line1 {
  25. get { return line1; }
  26. set { line1 = value; }
  27. }
  28.  
  29. [IgnoreNulls]
  30. [ValidatorComposition(CompositionType.Or, MessageTemplateResourceName = "MsgInvalidLine2", MessageTemplateResourceType = typeof(CommonResources))]
  31. [StringLengthValidator(0)]
  32. [StringLengthValidator(5, 50)]
  33. public string Line2 {
  34. get { return line2; }
  35. set { line2 = value; }
  36. }
  37.  
  38. [StringLengthValidator(1, 50, MessageTemplateResourceName = "MsgInvalidCity", MessageTemplateResourceType = typeof(CommonResources))]
  39. public string City {
  40. get { return city; }
  41. set { city = value; }
  42. }
  43.  
  44. [StringLengthValidator(1, 50, MessageTemplateResourceName = "MsgInvalidState", MessageTemplateResourceType = typeof(CommonResources))]
  45. public string State {
  46. get { return state; }
  47. set { state = value; }
  48. }
  49.  
  50. [RegexValidator(@”\b\d+\b", MessageTemplateResourceName = "MsgInvalidPostCode", MessageTemplateResourceType = typeof(CommonResources))]
  51. public string PostCode {
  52. get { return postCode; }
  53. set { postCode = value; }
  54. }
  55.  
  56. public string Country {
  57. get { return country; }
  58. set { country = value; }
  59. }
  60.  
  61. }
  62. }

you can see from the above example there is a few validators used to validate the User.cs and Address.cs classes.

for the Username and Password property i use the Not null validator, String length validator wrapped by And composite validator.
The String length validator check the range between 6-20 character length, And Composite Validator use the message from the project resource. So it must specified the MessageTemplateResourceName as the name of the message in the resource and also specify the MessageTemplateResourceType as the type of the resource name.

// Username property
  1. [ValidatorComposition(CompositionType.And, MessageTemplateResourceName = "MsgEmptyUsername", MessageTemplateResourceType = typeof(CommonResources))]
  2. [NotNullValidator]
  3. [StringLengthValidator(6, 20)]
  4. public string Username {
  5. get { return username; }
  6. set { this.username = value; }
  7. }

The RetypePassword property use the PropertyComparisonValidator to check the value that it is equal with the Password property. The PropertyComparisonValidator take 4 parameters in the example above. 1st is the property name to be compared, 2nd the method used to compare. 3rd is the MessageTemplateResourceName and the last parameter is MessageTemplateResourceType

// RetypePassword property
  1. [PropertyComparisonValidator("Password", ComparisonOperator.Equal, MessageTemplateResourceName = "MsgInvalidPassword", MessageTemplateResourceType = typeof(CommonResources))]
  2. public string RetypePassword {
  3. get { return retypePassword; }
  4. set { this.retypePassword = value; }
  5. }

The following code snippet attaches the RelativeDateTimeValidator attribute to the Birthday property and checks to see if the user is 18 years or older.

// Birthday property
  1. [RelativeDateTimeValidator(-120, DateTimeUnit.Year, -18, DateTimeUnit.Year, MessageTemplateResourceName = "MsgInvalidAge", MessageTemplateResourceType = typeof(CommonResources))]
  2. public DateTime Birthday {
  3. get { return birthday; }
  4. set { this.birthday = value; }
  5. }

The following code example checks that the e-mail address is formed according to the pattern given by the regular expression.

// E-mail property
  1. [RegexValidator(@”\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*", MessageTemplateResourceName = "MsgInvalidEmail", MessageTemplateResourceType = typeof(CommonResources))]
  2. public string Email {
  3. get { return email; }
  4. set { this.email = value; }
  5. }

The following code example use the Or composite validator, String length validator and also Regular Expression Validator to checks that the given phoneNumber is formed according to the pattern given by the regular expression.

// PhoneNumber property
  1. [ValidatorComposition(CompositionType.Or, MessageTemplateResourceName = "MsgInvalidPhoneNumber", MessageTemplateResourceType = typeof(CommonResources))]
  2. [StringLengthValidator(0)]
  3. [RegexValidator(@”(\+)?\b\d+\b")]
  4. public string PhoneNumber {
  5. get { return phoneNumber; }
  6. set { this.phoneNumber = value; }
  7. }

To perform the validation on the User object, you have to create the Validator object then call the validate method on the user object.
here is the example :

//call validate method on the user object
  1. Validator validator = ValidationFactory.CreateValidator();
  2. ValidationResults results = validator.Validate(user);

You can download the complete example of Enterprise Library Validation application block here.
ValidationExample.rar

<< back     next >>

 

Related Articles

Tags: , , , , ,
Posted under .net, C#, Enterprise library, Validation by De' on 04.29.2008

Leave a Reply