org.openmrs.validator

Class UserValidator

java.lang.Object

org.openmrs.validator.UserValidator

All Implemented Interfaces:

org.springframework.validation.Validator

@Handler(supports=User.class,
         order=50)
public class UserValidator
extends Object
implements org.springframework.validation.Validator

Validates attributes on the User object

Since:

1.5

Constructor Summary

Constructors

Constructor and Description
UserValidator()

Method Summary

Modifier and Type	Method and Description
boolean	isUserNameAsEmailValid(String username) Returns true if the given username is a valid e-mail.
boolean	isUserNameValid(String username) Convenience method to check the given username against the regular expression.
boolean	supports(Class<?> clazz) Determines if the command object being submitted is a valid type
void	validate(Object obj, org.springframework.validation.Errors errors) Checks the form object for any inconsistencies/errors

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserValidator

public UserValidator()

Method Detail

supports

public boolean supports(Class<?> clazz)

Determines if the command object being submitted is a valid type

Specified by:

supports in interface org.springframework.validation.Validator

See Also:

Validator.supports(java.lang.Class)

validate

public void validate(Object obj,
                     org.springframework.validation.Errors errors)

Checks the form object for any inconsistencies/errors

Specified by:

validate in interface org.springframework.validation.Validator

See Also:

Should fail validation if retired and retireReason is null Should fail validation if retired and retireReason is empty Should fail validation if retired and retireReason is whitespace Should pass validation if all required fields have proper values Should fail validation if email as username enabled and email invalid Should fail validation if email as username disabled and email provided Should not throw NPE when user is null Should pass validation if field lengths are correct Should fail validation if field lengths are not correct

isUserNameValid

public boolean isUserNameValid(String username)

Convenience method to check the given username against the regular expression.

A valid username will have following:

• Begins with Alphanumeric characters
• only followed by more alphanumeric characters (may include . - _)
• can be at most 50 characters
• minimum 2 chars case-insensitive Examples:
• The following username will pass validation: A123_.-XYZ9

Parameters:

username - the username string to check

Returns:

true if the username is ok Should validate username with only alpha numerics Should validate username with alpha dash and underscore Should validate username with alpha dash underscore and dot Should validate username with exactly max size name Should not validate username with less than minimumLength Should not validate username with invalid character Should not validate username with more than maximum size Should validate when username is null Should validate when username is the empty string Should not validate when username is whitespace only

isUserNameAsEmailValid

public boolean isUserNameAsEmailValid(String username)

Returns true if the given username is a valid e-mail.

Parameters:

username -

Returns:

true if valid Should return false if email invalid Should return true if email valid