dk.heick.properties.types

Class ConnectionUrlPropertyType

java.lang.Object

dk.heick.properties.PropertyType<String>

dk.heick.properties.types.ConnectionUrlPropertyType

All Implemented Interfaces:

Serializable

public class ConnectionUrlPropertyType
extends PropertyType<String>

PropertyType that validates to a String to be a valid database connection URL it has to be in the form "jdbc:subprotocol:subname".
It use the method DriverManager.getDriver(url) to validate the URL.
This means that the Driver class for has to be registered before hand, for this to work.
If the driver validates, a message about the drivers info is logged as info.

Constructor Example			Comments
Property<String> A_PROPERTY = new Property<String>("name", new ConnectionUrlPropertyType());			Default value is null. It is not possible to set a default value.
Type of value(s)	Examples	Result	Comments
Valid	jdbc:hsqldb:mem:localbatch	"jdbc:hsqldb:mem:localbatch"	Validate successfully.
Valid	jdbc:oracle:thin:Herong/TopSecret@localhost:1521:XE	"jdbc:oracle:thin:Herong/TopSecret@localhost:1521:XE"	Validate successfully.
Invalid	cow	null	Validate will throw an exception. The resulting value is null.
Invalid	«empty string»	null
Invalid	«only spaces»	null
Invalid	null	null

Since:

1.7

Author:

Frederik Heick

See Also:

DriverManager.getDriver(String), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE The type name string constant of ConnectionUrlPropertyType

Constructor Summary

Constructors

Constructor and Description
ConnectionUrlPropertyType()

Method Summary

Modifier and Type	Method and Description
protected String	getDriverInfo(String url, Driver driver) Getting the Driver info as a String.
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
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 ConnectionUrlPropertyType

See Also:

Constant Field Values

Constructor Detail

ConnectionUrlPropertyType

public ConnectionUrlPropertyType()

Method Detail

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.

getDriverInfo

protected String getDriverInfo(String url,
                               Driver driver)

Getting the Driver info as a String.

Parameters:

url - the connection url

driver - the driver instance.

Returns:

Driver infomation, class, majorversion, minorversion, properties in a wellformed string.