EmailPropertyType (JHPropertiesTyped

java.lang.Object
- dk.heick.properties.PropertyType<String>
- - dk.heick.properties.types.EmailPropertyType

All Implemented Interfaces:: Serializable

public class EmailPropertyType
extends PropertyType<String>

PropertyType that validates to a string value into a valid email address.
The string value is trimmed and lower cased before conversion.
Plus you can add that the domain part of the address must contain as certain string.
DNS timeout is 2000 ms, retry count of 1, and DNS url can all be set manually by using static method on this class.
It uses a regex pattern

^[_A-Za-z0-9-]+(\\.[_A-Za-z0-9-]+)*@[A-Za-z0-9]+(\\.[A-Za-z0-9]+)*(\\.[A-Za-z]{2,})$

to validate that the string is a valid email address.

Constructor Example			Comments
Property<String> A_PROPERTY = new Property<String>("name", new EmailPropertyType());			No domain name constraints, default value is null.
Property<String> A_PROPERTY = new Property<String>("name", new EmailPropertyType("domain.com"));			Domain name must be "domain.com", default value is null.
Property<String> A_PROPERTY = new Property<String>("name", new EmailPropertyType("manager@domain.com","domain.com"));			Domain name must be "domain.com", default value is "manager@domain.com".
Property<String> A_PROPERTY = new Property<String>("name", new EmailPropertyType("manager@domain.com",null));			No domain name constraints, default value is "manager@domain.com".
Property<String> A_PROPERTY = new Property<String>("name", new EmailPropertyType(null,null));			No domain name constraints, default value is null.
Type of value(s)	Examples	Result	Comments
Valid	test@test.com	A string validated as an email	Validate successfully.
Invalid	cow	`null`	Validate will throw an exception. The resulting value is `null`.
Invalid	«empty string»	`null`
Invalid	«empty string after trim»	`null`
Invalid	`null`	`defaultValue` OR `null`	Validate will throw an exception. Return default value if set, otherwise `null`.

Since:: 1.0
Author:: Frederik Heick
See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_DNS_TIMEOUT_INITIAL_MS` The default timeout value in milliseconds, when checking the MX record for the domain part in the email address.
`static int`	`DEFAULT_DNS_TIMEOUT_RETRIES` The default retries value, when checking the MX record for the domain part in the email address.
`static String`	`EMAIL_PATTERN` The regular expression pattern that is used check if a string is a valid email.
`static String`	`GOOGLE_PUBLIC_DNS_1` Googles public DNS - "dns://8.8.8.8".
`static String`	`GOOGLE_PUBLIC_DNS_2` Googles public DNS - "dns://8.8.4.4".
`static String`	`TYPE` The type name string constant of EmailPropertyType.

Constructor Summary

Constructors
Constructor and Description
`EmailPropertyType()` Creates a email property type, where the is no domain restrictions.
`EmailPropertyType(String domainMustContain)` Creates a email property type, with no default value.
`EmailPropertyType(String defaultValue, String domainMustContain)` Creates a email property type.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDomainMustContain()` The substring that the 'domain' part of the email must contain.
`protected String`	`getDomainPart(String value)` Gets the domain/hostname part of an email address. Everything after "@".
`static String`	`getOverrideDNSUrl()` Returns the override DNS URL.
`List<String>`	`getRestrictions()` Gets a detailed description of the PropertyType with any constraints that might influence the validation.
`static int`	`getStaticDnsTimeoutInitialMs()` The timeout value in milliseconds, when checking the MX record for the domain part in the email address.
`static int`	`getStaticDnsTimeoutRetries()` The retries value, when checking the MX record for the domain part in the email address.
`boolean`	`isValidatingDomain()` Determines if domain validation shall be performed.
`void`	`setDomainMustContain(String domainMustContain)` Sets the substring that the 'domain' part of the email must contain.
`static void`	`setOverrideDNSUrl(String dnsUrl)` Sets the override DNS URL.
`static void`	`setStaticDnsTimeoutInitialMs(int dnsTimeoutInitialMs)` The timeout value in milliseconds, when checking the MX record for the domain part in the email address.
`static void`	`setStaticDnsTimeoutRetries(int dnsTimeoutRetries)` The retries value, when checking the MX record for the domain part in the email address.
`void`	`setValidatingDomain(boolean validateDomain)` Set if domain validation shall be performed. Default set to `true`.
`protected void`	`validateDomain(String propertyName, String value, String domain)`
`String`	`validateValue(String propertyName, String value)` Converts the string representation of to a typed value.

Methods inherited from class dk.heick.properties.PropertyType
equals, getDefaultValue, getDefaultValueAsString, getDefaultValueDescription, getDescription, getDescription, getInitializationPriority, getIo, getLogger, getTypeName, hasDefaultValue, isDefaultValueValid, postGetValueProcessing, setDefaultValue, setInitializationPriority, setIo, setTypedValue, setTypeName, toString, toType, validate, validateConstraints, validateNullType

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

- Field Detail
  - TYPE
```
public static final String TYPE
```
    The type name string constant of EmailPropertyType.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DNS_TIMEOUT_INITIAL_MS
```
public static int DEFAULT_DNS_TIMEOUT_INITIAL_MS
```
    The default timeout value in milliseconds, when checking the MX record for the domain part in the email address. Current value is "2000".
  - DEFAULT_DNS_TIMEOUT_RETRIES
```
public static int DEFAULT_DNS_TIMEOUT_RETRIES
```
    The default retries value, when checking the MX record for the domain part in the email address. Current value is "1".
  - GOOGLE_PUBLIC_DNS_1
```
public static String GOOGLE_PUBLIC_DNS_1
```
    Googles public DNS - "dns://8.8.8.8".
    See https://developers.google.com/speed/public-dns/
    
    See Also:
    
    setOverrideDNSUrl(String), getOverrideDNSUrl()
  - GOOGLE_PUBLIC_DNS_2
```
public static String GOOGLE_PUBLIC_DNS_2
```
    Googles public DNS - "dns://8.8.4.4".
    See https://developers.google.com/speed/public-dns/
    
    See Also:
    
    setOverrideDNSUrl(String), getOverrideDNSUrl()
  - EMAIL_PATTERN
```
public static final String EMAIL_PATTERN
```
    The regular expression pattern that is used check if a string is a valid email.
    PATTERN:
```
^[_A-Za-z0-9-]+(\\.[_A-Za-z0-9-]+)*@[A-Za-z0-9]+(\\.[A-Za-z0-9]+)*(\\.[A-Za-z]{2,})$
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EmailPropertyType
```
public EmailPropertyType()
```
    Creates a email property type, where the is no domain restrictions.
    The it must contain a valid email, attribute nullAllowed is false.
  - EmailPropertyType
```
public EmailPropertyType(String domainMustContain)
```
    Creates a email property type, with no default value.
    
    Parameters:
    
    domainMustContain - a substring that the 'domain' part of the email must contain. Not case sensitive. If null than not used.
  - EmailPropertyType
```
public EmailPropertyType(String defaultValue,
                         String domainMustContain)
```
    Creates a email property type.
    
    Parameters:
    
    defaultValue - default value returned if property value is undefined.
    
    domainMustContain - the substring that the 'domain' part of the email must contain. Not case sensitive. If null than not used.
- Method Detail
  - getDomainMustContain
```
public String getDomainMustContain()
```
    The substring that the 'domain' part of the email must contain. Not case sensitive.
    
    Returns:
    
    the domain substring part, if null than not used.
  - setDomainMustContain
```
public void setDomainMustContain(String domainMustContain)
```
    Sets the substring that the 'domain' part of the email must contain. Not case sensitive.
    
    Parameters:
    
    domainMustContain - the domain constraints.
  - getRestrictions
```
public List<String> getRestrictions()
```
    Description copied from class: PropertyType
    
    Gets a detailed description of the PropertyType with any constraints that might influence the validation.
    This includes a description for the default value, if the default do not it self parse the validation of the type, the exception is appended to the description.
    
    Specified by:
    
    getRestrictions in class PropertyType<String>
    
    Returns:
    
    the restrictions of the PropertyType as a list of strings.
  - validateValue
```
public String validateValue(String propertyName,
                            String value)
                     throws PropertyException
```
    Description copied from class: PropertyType
    
    Converts the string representation of to a typed value.
    Including validation of any restrictions the PropertyType might have.
    See the individual property type class description for details on how it convert to a typed value.
    
    IMPORTANT: This only validates the value not the constraints of the PropertyType, which is at this point assumed to be valid.
    
    Specified by:
    
    validateValue in class PropertyType<String>
    
    Parameters:
    
    propertyName - the name of the property used for logging purposes. To uniquely identify the Property with validation issues.
    
    value - the string representation of the property
    
    Returns:
    
    the typed converted value.
    
    Throws:
    
    PropertyException - if the conversion failed.
  - getDomainPart
```
protected String getDomainPart(String value)
                        throws NullPointerException
```
    Gets the domain/hostname part of an email address.
    Everything after "@". It is assume that the address a this point alread
    
    Parameters:
    
    value - the email address
    
    Returns:
    
    everything after the "@" character, if that do not exists an empty string is returned.
    
    Throws:
    
    NullPointerException - if value is null.
  - validateDomain
```
protected void validateDomain(String propertyName,
                              String value,
                              String domain)
                       throws PropertyException
```
    Throws:
    
    PropertyException
  - setValidatingDomain
```
public void setValidatingDomain(boolean validateDomain)
```
    Set if domain validation shall be performed.
    Default set to true.
    
    Parameters:
    
    validateDomain - set to true if domain validation shall be performed, otherwise false.
  - isValidatingDomain
```
public boolean isValidatingDomain()
```
    Determines if domain validation shall be performed.
    
    Returns:
    
    true if domain validation shall be performed, otherwise false.
  - getStaticDnsTimeoutInitialMs
```
public static int getStaticDnsTimeoutInitialMs()
```
    The timeout value in milliseconds, when checking the MX record for the domain part in the email address.
    The value used for "com.sun.jndi.dns.timeout.initial".
    
    Returns:
    
    the dnsTimeoutInitialMs the timeout value
    
    Since:
    
    1.9
    
    See Also:
    
    setValidatingDomain(boolean)
  - getStaticDnsTimeoutRetries
```
public static int getStaticDnsTimeoutRetries()
```
    The retries value, when checking the MX record for the domain part in the email address.
    The value used for "com.sun.jndi.dns.timeout.retries".
    
    Returns:
    
    the dnsTimeoutRetries
    
    Since:
    
    1.9
  - setStaticDnsTimeoutInitialMs
```
public static void setStaticDnsTimeoutInitialMs(int dnsTimeoutInitialMs)
```
    The timeout value in milliseconds, when checking the MX record for the domain part in the email address.
    The value used for "com.sun.jndi.dns.timeout.initial".
    
    Parameters:
    
    dnsTimeoutInitialMs - the static dnsTimeoutRetries to set, must greather than 0 otherwise default value of 2000 is used.
    
    Since:
    
    1.9
    
    See Also:
    
    DEFAULT_DNS_TIMEOUT_INITIAL_MS
  - setStaticDnsTimeoutRetries
```
public static void setStaticDnsTimeoutRetries(int dnsTimeoutRetries)
```
    The retries value, when checking the MX record for the domain part in the email address.
    The value used for "com.sun.jndi.dns.timeout.retries".
    
    Parameters:
    
    dnsTimeoutRetries - the static dnsTimeoutRetries to set, must greather than 0 otherwise default value of 1 is used.
    
    Since:
    
    1.9
    
    See Also:
    
    DEFAULT_DNS_TIMEOUT_RETRIES
  - getOverrideDNSUrl
```
public static String getOverrideDNSUrl()
```
    Returns the override DNS URL.
    
    Returns:
    
    the EmailPropertyType.OVERRIDE_DNS_URL
    
    See Also:
    
    OVERRIDE_DNS_URL
  - setOverrideDNSUrl
```
public static void setOverrideDNSUrl(String dnsUrl)
```
    Sets the override DNS URL. Override the DNS server provider URL.
    
    Example : env.put(Context.PROVIDER_URL, "dns://8.8.8.8"); (Google DNS Url : https://developers.google.com/speed/public-dns/)
    Default is null using the standard internal URL.
    This can sometimes cause problems when using an internal DNS at your company which dont verify your own DNS. (From own experience)
    
    Parameters:
    
    dnsUrl - the override DNS URL.
    
    Since:
    
    1.9

Class EmailPropertyType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class dk.heick.properties.PropertyType

Methods inherited from class java.lang.Object

Field Detail

TYPE

DEFAULT_DNS_TIMEOUT_INITIAL_MS

DEFAULT_DNS_TIMEOUT_RETRIES

GOOGLE_PUBLIC_DNS_1

GOOGLE_PUBLIC_DNS_2

EMAIL_PATTERN

Constructor Detail

EmailPropertyType

EmailPropertyType

EmailPropertyType

Method Detail

getDomainMustContain

setDomainMustContain

getRestrictions

validateValue

getDomainPart

validateDomain

setValidatingDomain

isValidatingDomain

getStaticDnsTimeoutInitialMs

getStaticDnsTimeoutRetries

setStaticDnsTimeoutInitialMs

setStaticDnsTimeoutRetries

getOverrideDNSUrl

setOverrideDNSUrl