EndUserRegistrationFormValidator (Common 1.0.2-dev API)

java.lang.Object
- gr.iccs.isense.circ4life.validation.EndUserRegistrationFormValidator

```
public class EndUserRegistrationFormValidator
extends Object
```
User registration form validator.

Author:

Miltiadis Koutsokeras, miltos.koutsokeras@iccs.gr

Field Summary

Fields
Modifier and Type Field and Description

static Logger logger
Logger.

protected static String USERNAMEREGEX
Allowed usernames regular expression, allowed only A-Z, a-z,0-9.

Fields
Modifier and Type	Field and Description
`static Logger`	`logger` Logger.
`protected static String`	`USERNAMEREGEX` Allowed usernames regular expression, allowed only A-Z, a-z,0-9.

Constructor Summary

Constructors
Constructor and Description

EndUserRegistrationFormValidator()

Constructors
Constructor and Description
`EndUserRegistrationFormValidator()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`isValid(String username, String password, String email, String givenName, String familyName)` Check the validity of required parameters.
`static boolean`	`isValid(String username, String password, String email, String givenName, String familyName, Date birthDate, String addressCountry, String postalCode, String streetAddress, String addressLocality, String addressRegion, String telephone, String userURL, String gender, String organization, String organizationURL, Long recyclebinuserid)` Check the validity of all possible parameters.
`static void`	`validate(Date birthDate, String addressCountry, String postalCode, String streetAddress, String addressLocality, String addressRegion, String telephone, String userURL, String gender, String organization, String organizationURL, Long recyclebinuserid)` Validate the parameters passed and throw `IllegalArgumentException` in case of any error.
`static void`	`validate(String email, String givenName, String familyName, Date birthDate, String addressCountry, String postalCode, String streetAddress, String addressLocality)` Validate the parameters passed and throw `IllegalArgumentException` in case of any error.
`static void`	`validate(String username, String password, String email, String givenName, String familyName)` Validate the parameters passed and throw `IllegalArgumentException` in case of any error.
`static void`	`validateCredentials(String username, String password)` Validate the parameters passed and throw `IllegalArgumentException` in case of any error. CAUTION: You cannot validate password without username, as one of the requirements is for the password to be different from the username.
`static void`	`validateEmail(String email)` Validate the parameters passed and throw `IllegalArgumentException` in case of any error.
`static void`	`validateFamilyName(String familyName)` Validate user's last name.
`static void`	`validateGivenName(String givenName)` Validate user's first name.
`static void`	`validateHTTPURL(String url)` Validate the parameters passed and throw `MalformedURLException` in case of any error.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
public static final Logger logger
```
    Logger.
  - USERNAMEREGEX
```
protected static final String USERNAMEREGEX
```
    Allowed usernames regular expression, allowed only A-Z, a-z,0-9.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EndUserRegistrationFormValidator
```
public EndUserRegistrationFormValidator()
```
- Method Detail
  - isValid
```
public static boolean isValid(String username,
                              String password,
                              String email,
                              String givenName,
                              String familyName)
```
    Check the validity of required parameters.
    
    Parameters:
    
    username - user name. Required. At least 8 characters of length, allowed only A-Z, a-z, 0-9.
    
    password - password. Required. At least 8 characters of length, not equal to username.
    
    email - e-mail. Required. Accepts only valid email addresses according to RFC822, RFC5322. Extra conditions that need to be met for ICT Platform: Local domains not allowed, e.g. user@localhost, user@localhost.localdomain, user@somehost.localdomain, IP addresses not allowed, e.g. user@127.0.0.1, user@10.0.1.1, user@8.8.8.8, user@147.102.5.97, user@192.168.1.245, Number of characters in top level domain must not less than 2 or more than 6, e.g. username@yahoo.c, username@yahoo.corporate.
    
    givenName - first name. Required. At least 2 characters of length, allowed first, last name regular expression, At least 2 and not more than 256 characters of length, allows any character except numbers(0-9) and these (<>, {}, [], !, @, #, $, %, ^, &, *, +, \, |, /, ?, `, ~).
    
    familyName - last name. Required. At least 2 characters of length, allowed first, last name regular expression, At least 2 and not more than 256 characters of length, allows any character except numbers(0-9) and these (<>, {}, [], !, @, #, $, %, ^, &, *, +, \, |, /, ?, `, ~).
    
    Returns:
    
    true if all parameters are valid, false otherwise.
  - isValid
```
public static boolean isValid(String username,
                              String password,
                              String email,
                              String givenName,
                              String familyName,
                              Date birthDate,
                              String addressCountry,
                              String postalCode,
                              String streetAddress,
                              String addressLocality,
                              String addressRegion,
                              String telephone,
                              String userURL,
                              String gender,
                              String organization,
                              String organizationURL,
                              Long recyclebinuserid)
```
    Check the validity of all possible parameters.
    
    Parameters:
    
    username - user name. Required. At least 8 characters of length, allowed only A-Z, a-z,0-9.
    
    password - password. Required. At least 8 characters of length, not equal to username.
    
    email - e-mail. Required. Accepts only valid email addresses according to RFC822, RFC5322. Extra conditions that need to be met for ICT Platform: Local domains not allowed, e.g. user@localhost, user@localhost.localdomain, user@somehost.localdomain, IP addresses not allowed, e.g. user@127.0.0.1, user@10.0.1.1, user@8.8.8.8, user@147.102.5.97, user@192.168.1.245, Number of characters in top level domain must not less than 2 or more than 6, e.g. username@yahoo.c, username@yahoo.corporate.
    
    givenName - first name. Required. At least 2 characters of length, allowed first, last name regular expression, At least 2 and not more than 256 characters of length, allows any character except numbers(0-9) and these (<>, {}, [], !, @, #, $, %, ^, &, *, +, \, |, /, ?, `, ~).
    
    familyName - last name. Required. At least 2 characters of length, allowed first, last name regular expression, At least 2 and not more than 256 characters of length, allows any character except numbers(0-9) and these (<>, {}, [], !, @, #, $, %, ^, &, *, +, \, |, /, ?, `, ~).
    
    birthDate - Date of birth. Optional. Must represent a Date of the past, at least 5 years old.
    
    addressCountry - Country code. Optional. Country 2 letter ISO 639 alpha-2 code
    
    postalCode - Postal code of address area. Optional. Cannot be an empty string.
    
    streetAddress - Street address (street name, number, city, area). Optional. Cannot be an empty string.
    
    addressLocality - The locality/city in which the street address is located. Optional. Cannot be an empty string.
    
    addressRegion - The region in which the city belongs. Optional. Cannot be an empty string.
    
    telephone - Telephone number. Optional. At least 4 characters of length, allowed only + as first character,0-9.
    
    userURL - User's profile URL. Optional. Valid HTTP, HTTPs URL.
    
    gender - Gender. Optional. Free text.
    
    organization - A user's affiliated organization, e.g. Company, University, Club, Team, etc. Optional. Free Text.
    
    organizationURL - User's organization URL. Optional. Valid HTTP, HTTPs URL.
    
    recyclebinuserid - Intelligent Bin User code as an 11 digit integer. Optional. ZIP code is first 5 digits (e.g. 16004), 6 last digits are sequential (e.g. 000001). Minimum = 0, Maximum = 99999999999.
    
    Returns:
    
    true if all parameters are valid, false otherwise.
  - validate
```
public static void validate(String username,
                            String password,
                            String email,
                            String givenName,
                            String familyName)
                     throws IllegalArgumentException
```
    Validate the parameters passed and throw IllegalArgumentException in case of any error.
    
    Parameters:
    
    username - user name. At least 8 characters of length, allowed only A-Z, a-z, 0-9.
    
    password - password. At least 8 characters of length, not equal to username.
    
    email - e-mail.
    
    givenName - first name. Allowed first, last name regular expression, At least 2 and not more than 256 characters of length, allows any character except numbers(0-9) and these (<>, {}, [], !, @, #, $, %, ^, &, *, +, \, |, /, ?, `, ~).
    
    familyName - last name. Allowed first, last name regular expression, At least 2 and not more than 256 characters of length, allows any character except numbers(0-9) and these (<>, {}, [], !, @, #, $, %, ^, &, *, +, \, |, /, ?, `, ~).
    
    Throws:
    
    IllegalArgumentException - thrown if any of the required input parameters is not valid.
  - validate
```
public static void validate(Date birthDate,
                            String addressCountry,
                            String postalCode,
                            String streetAddress,
                            String addressLocality,
                            String addressRegion,
                            String telephone,
                            String userURL,
                            String gender,
                            String organization,
                            String organizationURL,
                            Long recyclebinuserid)
                     throws IllegalArgumentException
```
    Validate the parameters passed and throw IllegalArgumentException in case of any error.
    
    Parameters:
    
    birthDate - birthday date.
    
    addressCountry - 2-letter country code, e.g. GR.
    
    postalCode - Postal code number.
    
    streetAddress - Full street address, name, number, town.
    
    addressLocality - City name.
    
    addressRegion - Address region.
    
    telephone - telephone number.
    
    userURL - user profile URL.
    
    gender - gender.
    
    organization - affiliated organization name.
    
    organizationURL - affiliated organization URL.
    
    recyclebinuserid - recycle bin system user ID.
    
    Throws:
    
    IllegalArgumentException - thrown if any of the required input parameters is not valid.
  - validate
```
public static void validate(String email,
                            String givenName,
                            String familyName,
                            Date birthDate,
                            String addressCountry,
                            String postalCode,
                            String streetAddress,
                            String addressLocality)
                     throws IllegalArgumentException
```
    Validate the parameters passed and throw IllegalArgumentException in case of any error.
    
    Parameters:
    
    email - e-mail.
    
    givenName - first name.
    
    familyName - last name.
    
    birthDate - birthday date.
    
    addressCountry - 2-letter country code, e.g. GR.
    
    postalCode - Postal code number.
    
    streetAddress - Full street address, name, number, town.
    
    addressLocality - City name.
    
    Throws:
    
    IllegalArgumentException - thrown if any of the required input parameters is not valid.
  - validateHTTPURL
```
public static void validateHTTPURL(String url)
                            throws MalformedURLException
```
    Validate the parameters passed and throw MalformedURLException in case of any error.
    
    Parameters:
    
    url - HTTP(s) URL. MUST NOT BE null
    
    Throws:
    
    MalformedURLException - thrown if any of the required input parameters is not valid.
  - validateCredentials
```
public static void validateCredentials(String username,
                                       String password)
                                throws IllegalArgumentException
```
    Validate the parameters passed and throw IllegalArgumentException in case of any error.
    CAUTION: You cannot validate password without username, as one of the requirements is for the password to be different from the username.
    
    Parameters:
    
    username - user name. At least 8 characters of length, allowed only A-Z, a-z, 0-9.
    
    password - password. At least 8 characters of length, not equal to username.
    
    Throws:
    
    IllegalArgumentException - thrown if any of the required input parameters is not valid.
  - validateEmail
```
public static void validateEmail(String email)
                          throws IllegalArgumentException
```
    Validate the parameters passed and throw IllegalArgumentException in case of any error.
    
    Parameters:
    
    email - Email address.
    
    Throws:
    
    IllegalArgumentException - thrown if any of the required input parameters is not valid.
  - validateGivenName
```
public static void validateGivenName(String givenName)
                              throws IllegalArgumentException
```
    Validate user's first name. Allowed first, last name regular expression, At least 2 and not more than 256 characters of length, allows any character except numbers(0-9) and these (<>, {}, [], !, @, #, $, %, ^, &, *, +, \, |, /, ?, `, ~).
    
    Parameters:
    
    givenName - first name.
    
    Throws:
    
    IllegalArgumentException - thrown if any of the required input parameters is not valid.
  - validateFamilyName
```
public static void validateFamilyName(String familyName)
                               throws IllegalArgumentException
```
    Validate user's last name. Allowed first, last name regular expression, At least 2 and not more than 256 characters of length, allows any character except numbers(0-9) and these (<>, {}, [], !, @, #, $, %, ^, &, *, +, \, |, /, ?, `, ~).
    
    Parameters:
    
    familyName - last name.
    
    Throws:
    
    IllegalArgumentException - thrown if any of the required input parameters is not valid.

Class EndUserRegistrationFormValidator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

USERNAMEREGEX

Constructor Detail

EndUserRegistrationFormValidator

Method Detail

isValid

isValid

validate

validate

validate

validateHTTPURL

validateCredentials

validateEmail

validateGivenName

validateFamilyName