dk.heick.properties.types

Class URLPropertyType

java.lang.Object

dk.heick.properties.PropertyType<URL>

dk.heick.properties.types.URLPropertyType

All Implemented Interfaces:

MarkerProxyDependent, Serializable

public class URLPropertyType
extends PropertyType<URL>
implements MarkerProxyDependent

PropertyType that validates to a URL value.
This type convert and validates a string to a java.net.URL.
Constraints can be set for valid protocol(s).
Any string value which parses the method new URL(string) and make a regular expression check.
To create a URL for default value etc, you can use the URLUtils.construct, which hides the cheched exception from URL constructor.
There is also possible to set a specific proxy on the instance, otherwise the default proxy from PropertyFrameWorkGlobals is used.

Constructor Example			Comments
Property<URL> A_PROPERTY = new Property<URL>("name", new URLPropertyType());			Creates URLPropertyType with no default value,no protocol restrictions, and using DefaultURLValidator.
Property<URL> A_PROPERTY = new Property<URL>("name", new URLPropertyType("http"));			Creates URLPropertyType with no default value, the protocol must be "http", and using DefaultURLValidator.
Property<URL> A_PROPERTY = new Property<URL>("name", new URLPropertyType(new URL("http://www.jp.dk"),"http"));			Creates URLPropertyType with default value "http://www.jp.dk" and the protocol must be "http"; and using DefaultURLValidator
Property<URL> A_PROPERTY = new Property<URL>("name", new URLPropertyType(new String[]{"http","ftp"}));			Creates URLPropertyType with no default value and the protocol must be either "http" or "ftp", and using DefaultURLValidator
Property<URL> A_PROPERTY = new Property<URL>("name", new URLPropertyType(new URL("http://www.jp.dk"),new String[]{"http","ftp"}));
Type of value(s)	Examples	Result	Comments
Valid	http://www.cnn.com	new URL("http://www.cnn.com")	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	10.0.0.1	null	Validate will throw an exception. The resulting value is null. No Protocol.
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:

URL.URL(String), DefaultURLValidator, URLValidator, URLUtils.construct(String), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static URLValidator	NO_URL_VALIDATOR Static menber instance of NoURLValidator, where no URL validation is performed.
static String	REGEX_URL The regular expression use to validate the URL with.
static String	TYPE The type name string constant of URLPropertyType.

Constructor Summary

Constructors

Constructor and Description
URLPropertyType() Default constructor, no default value and no protocol constraints and DefaultURLValidator used.
URLPropertyType(String protocol) Constructor with protocol constraint and DefaultURLValidator used.
URLPropertyType(String[] protocols) Constructor with DefaultURLValidator used.
URLPropertyType(String[] protocols, URLValidator urlValidator) Constructor.
URLPropertyType(String defaultValue, String[] protocols) Constructor, using URLUtils.construct(String) to construct default URL and using DefaultURLValidator.
URLPropertyType(String defaultValue, String[] protocols, URLValidator urlValidator) Constructor, using URLUtils.construct(String) to construct default URL.
URLPropertyType(String defaultValue, String protocol, URLValidator urlValidator) Constructor, using URLUtils.construct(String) to construct default URL.
URLPropertyType(String protocol, URLValidator urlValidator) Constructor with protocol constraint.
URLPropertyType(URL defaultValue) Constructor.
URLPropertyType(URL defaultValue, String protocol) Constructor with DefaultURLValidator used.
URLPropertyType(URL defaultValue, String[] protocols) Constructor with DefaultURLValidator used.
URLPropertyType(URL defaultValue, String[] protocols, URLValidator urlValidator) Constructor.
URLPropertyType(URL defaultValue, String protocol, URLValidator urlValidator) Constructor.
URLPropertyType(URL defaultValue, URLValidator urlValidator) Constructor.
URLPropertyType(URLValidator urlValidator) Constructor with validation connection constraint.

Method Summary

Modifier and Type	Method and Description
String[]	getProtocols() Gets the valid protocols.
Proxy	getProxy() Gets the proxy setup for this URL, default is null.
protected Proxy	getProxyToUse() Determines what proxy to use in the validation URL Connection.
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
URLValidator	getURLValidator() Gets the implementation of the URLValidator, if null no connection validation is performed.
void	setProtocol(String protocol) Set valid protocol
void	setProtocols(String[] protocols) Set valid protocols.
void	setProxy(Proxy proxy) Set a specific proxy setup for this URL.
void	setURLValidator(URLValidator urlValidator) Sets the implementation of the URLValidator, if null no connection validation is performed.
URL	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 URLPropertyType.

See Also:

Constant Field Values

REGEX_URL

public static final String REGEX_URL

The regular expression use to validate the URL with.

See Also:

Constant Field Values

NO_URL_VALIDATOR

public static final URLValidator NO_URL_VALIDATOR

Static menber instance of NoURLValidator, where no URL validation is performed.

See Also:

NoURLValidator

Constructor Detail

URLPropertyType

public URLPropertyType()

Default constructor, no default value and no protocol constraints and DefaultURLValidator used.

URLPropertyType

public URLPropertyType(URLValidator urlValidator)

Constructor with validation connection constraint.

Parameters:

urlValidator - implementation of the URLVaildator. If null no validation is performed.

See Also:

DefaultURLValidator, NoURLValidator, URLValidator

URLPropertyType

public URLPropertyType(String protocol)

Constructor with protocol constraint and DefaultURLValidator used.

Parameters:

protocol - the protocol which the URL must start with, not case sensitive.

URLPropertyType

public URLPropertyType(String protocol,
                       URLValidator urlValidator)

Constructor with protocol constraint.

Parameters:

protocol - the protocol which the URL must start with, not case sensitive.

urlValidator - implementation of the URLValidator. If null no validation is performed.

See Also:

DefaultURLValidator, NoURLValidator, URLValidator

URLPropertyType

public URLPropertyType(URL defaultValue)

Constructor. No protocols constraints and DefaultURLValidator used.

Parameters:

defaultValue - default value returned if property value is undefined.

URLPropertyType

public URLPropertyType(URL defaultValue,
                       URLValidator urlValidator)

Constructor. No protocols constraints.

Parameters:

defaultValue - default value returned if property value is undefined.

urlValidator - implementation of the URLValidator. If null no validation is performed.

See Also:

DefaultURLValidator, NoURLValidator, URLValidator

URLPropertyType

public URLPropertyType(URL defaultValue,
                       String protocol,
                       URLValidator urlValidator)

Constructor.

Parameters:

defaultValue - default value returned if property value is undefined.

protocol - the protocol which the URL must start with, not case sensitive.

urlValidator - implementation of the URLValidator. If null no validation is performed.

See Also:

DefaultURLValidator, NoURLValidator, URLValidator

URLPropertyType

public URLPropertyType(String[] protocols)

Constructor with DefaultURLValidator used.

Parameters:

protocols - the protocols which the URL must start with one of them, not case sensitive.

URLPropertyType

public URLPropertyType(String[] protocols,
                       URLValidator urlValidator)

Constructor.

Parameters:

protocols - the protocols which the URL must start with one of them, not case sensitive.

urlValidator - implementation of the URLValidator. If null no validation is performed.

See Also:

DefaultURLValidator, NoURLValidator, URLValidator

URLPropertyType

public URLPropertyType(URL defaultValue,
                       String[] protocols)

Constructor with DefaultURLValidator used.

Parameters:

defaultValue - default value returned if property value is undefined, and connection validation is performed.

protocols - the protocols which the URL must start with one of them, not case sensitive.

URLPropertyType

public URLPropertyType(URL defaultValue,
                       String protocol)

Constructor with DefaultURLValidator used.

Parameters:

defaultValue - default value returned if property value is undefined, and connection validation is performed.

protocol - the protocol which the URL must start with, not case sensitive.

URLPropertyType

public URLPropertyType(URL defaultValue,
                       String[] protocols,
                       URLValidator urlValidator)

Constructor.

Parameters:

defaultValue - default value returned if property value is undefined.

protocols - the protocols which the URL must start with one of them, not case sensitive.

urlValidator - implementation of the URLValidator. If null no validation is performed.

See Also:

DefaultURLValidator, NoURLValidator, URLValidator

URLPropertyType

public URLPropertyType(String defaultValue,
                       String[] protocols,
                       URLValidator urlValidator)

Constructor, using URLUtils.construct(String) to construct default URL.

Parameters:

defaultValue - the URL as a string using URLUtils.construct(String) which incapsulate the MalformedURLException

protocols - the protocols which the URL must start with one of them, not case sensitive.

urlValidator - implementation of the URLValidator. If null no validation is performed.

See Also:

URLUtils.construct(String), DefaultURLValidator, NoURLValidator, URLValidator

URLPropertyType

public URLPropertyType(String defaultValue,
                       String[] protocols)

Constructor, using URLUtils.construct(String) to construct default URL and using DefaultURLValidator.

Parameters:

defaultValue - the URL as a string using URLUtils.construct(String) which incapsulate the MalformedURLException

protocols - the protocols which the URL must start with one of them, not case sensitive.

See Also:

URLUtils.construct(String)

URLPropertyType

public URLPropertyType(String defaultValue,
                       String protocol,
                       URLValidator urlValidator)

Constructor, using URLUtils.construct(String) to construct default URL.

Parameters:

defaultValue - the URL as a string using URLUtils.construct(String) which incapsulate the MalformedURLException

protocol - the protocol which the URL must start with, not case sensitive.

urlValidator - implementation of the URLValidator. If null no validation is performed.

See Also:

URLUtils.construct(String), DefaultURLValidator, NoURLValidator, URLValidator

Method Detail

getProtocols

public String[] getProtocols()

Gets the valid protocols.

Returns:

the valid protocols, if null or empty, no restrictions on protocols.

setProtocols

public void setProtocols(String[] protocols)

Set valid protocols.

Parameters:

protocols - the protocols which the URL must start with one of them, not case sensitive. If null or empty, protocols will not be used in the validation.

setProtocol

public void setProtocol(String protocol)

Set valid protocol

Parameters:

protocol - the protocol which the URL must start with, not case sensitive. If null or empty, protocol will not be used in the validation.

getURLValidator

public URLValidator getURLValidator()

Gets the implementation of the URLValidator, if null no connection validation is performed.

Returns:

the URLValidator implementation.

setURLValidator

public void setURLValidator(URLValidator urlValidator)

Sets the implementation of the URLValidator, if null no connection validation is performed.

Parameters:

urlValidator - the URLValidator implementation.

getProxy

public Proxy getProxy()

Gets the proxy setup for this URL, default is null.

Specified by:

getProxy in interface MarkerProxyDependent

Returns:

the proxy if any.

setProxy

public void setProxy(Proxy proxy)

Set a specific proxy setup for this URL.

Parameters:

proxy -

validateValue

public URL 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<URL>

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.

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<URL>

Returns:

the restrictions of the PropertyType as a list of strings.

getProxyToUse

protected Proxy getProxyToUse()

Determines what proxy to use in the validation URL Connection.
If the locally proxy is set than it will use that, if the globally proxy is set than it will use that, otherwise Proxy.NO_PROXY is used.

Returns:

the proxy setting.

Since:

1.8

See Also:

getProxy(), PropertyFrameworkGlobals.getDefaultProxy(), Proxy.NO_PROXY