ProxyPropertyType (JHPropertiesTyped

java.lang.Object
- dk.heick.properties.PropertyType<Proxy>
- - dk.heick.properties.types.ProxyPropertyType

All Implemented Interfaces:: Serializable

public class ProxyPropertyType
extends PropertyType<Proxy>

PropertyType that validates to a Proxy value.
This type convert and validates a string to a java.net.Proxy. Where the string is either "Proxy.TYPE;InetAddress;Port" or "InetAddress;Port" (default type HTTP) or "DIRECT".

IMPORTANT: To validate a proxy a Inet lookup is performed, this can take several seconds, especially if it is invalid.

Where the InetAddress and Port validates to a InetSocketAddress.
The rules is :

the divider is default ";", but can be altered.
Type must either be "DIRECT,HTTP or SOCKS".
Host must be a non empty string.
Port must be a valid integer between 0 and 65535.

Constructor Example			Comments
Property<Proxy> A_PROPERTY = new Property<Proxy>("name", new ProxyPropertyType());			Default value is `null` and using default divider ";".
Property<Proxy> A_PROPERTY = new Property<Proxy>("name", new ProxyPropertyType(new Proxy(Proxy.Type.HTTP,new InetSocketAddress("166.10.166.1", 8080)));			Default value is `new Proxy(Proxy.Type.HTTP,new InetSocketAddress("166.10.166.1", 8080))` and using default divider ";".
Property<Proxy> A_PROPERTY = new Property<Proxy>("name", new ProxyPropertyType(new Proxy(Proxy.Type.HTTP,new InetSocketAddress("166.10.166.1", 8080)),"#");			Default value is `new Proxy(Proxy.Type.HTTP,new InetSocketAddress("166.10.166.1", 8080))`and using divider "#".
Type of value(s)	Examples	Result	Comments
Valid	SOCKS;166.10.166.1;8080	new Proxy(Proxy.Type.SOCKS,new InetSocketAddress("166.10.166.1", 8080))	Validate successfully.
Valid	HTTP;166.10.166.1;8080	new Proxy(Proxy.Type.HTTP,new InetSocketAddress("166.10.166.1", 8080))		Validate successfully.
Valid	166.10.166.1;8080	new Proxy(Proxy.Type.HTTP,new InetSocketAddress("166.10.166.1", 8080))			Validate successfully.
Invalid	«empty string»	`null`	Validate will throw an exception. The resulting value is `null`.
Invalid	«only spaces»	`null`
Invalid		`null`
Invalid	`null`	`defaultValue` OR `null`	Validate will throw an exception. Return default value if set, otherwise `null`.

Since:: 1.9
Author:: Frederik Heick
See Also:: Proxy, Proxy.Type, InetSocketAddress, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_DIVIDER` The divider of the tokens which constitute the Proxy values.
`static String`	`TYPE` The type name string constant of ProxyPropertyType

Constructor Summary

Constructors
Constructor and Description
`ProxyPropertyType()` Returns `ProxyPropertyType` where the default value is `Proxy.NO_PROXY`.
`ProxyPropertyType(Proxy defaultValue)` Returns `ProxyPropertyType` with default value and using the default divider.
`ProxyPropertyType(Proxy defaultValue, String divider)` Returns `ProxyPropertyType` with default value.
`ProxyPropertyType(String divider)` Returns `ProxyPropertyType` where the default value is `Proxy.NO_PROXY`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDivider()` The divider string used between the Proxy tokens.
`List<String>`	`getRestrictions()` Gets a detailed description of the PropertyType with any constraints that might influence the validation.
`String`	`toString(String propertyName, Proxy t)` Converts a typed to the string representation.
`void`	`validateConstraints(String propertyName)` A PropertyType can have some constraints here is where they are validated.
`Proxy`	`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, toType, validate, validateNullType

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

- Field Detail
  - DEFAULT_DIVIDER
```
public static final String DEFAULT_DIVIDER
```
    The divider of the tokens which constitute the Proxy values.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final String TYPE
```
    The type name string constant of ProxyPropertyType
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProxyPropertyType
```
public ProxyPropertyType()
```
    Returns ProxyPropertyType where the default value is Proxy.NO_PROXY.
    
    See Also:
    
    Proxy.NO_PROXY
  - ProxyPropertyType
```
public ProxyPropertyType(String divider)
```
    Returns ProxyPropertyType where the default value is Proxy.NO_PROXY.
    
    Parameters:
    
    divider - the divider between the proxy tokens, must not be empty.
  - ProxyPropertyType
```
public ProxyPropertyType(Proxy defaultValue)
```
    Returns ProxyPropertyType with default value and using the default divider.
    
    Parameters:
    
    defaultValue - default Proxy value returned if property value is undefined.
  - ProxyPropertyType
```
public ProxyPropertyType(Proxy defaultValue,
                         String divider)
```
    Returns ProxyPropertyType with default value.
    
    Parameters:
    
    defaultValue - default Proxy value returned if property value is undefined.
    
    divider - the divider between the proxy tokens, must not be empty.
- Method Detail
  - getDivider
```
public String getDivider()
```
    The divider string used between the Proxy tokens.
    
    Returns:
    
    the divider an not empty string value.
  - 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<Proxy>
    
    Returns:
    
    the restrictions of the PropertyType as a list of strings.
  - validateConstraints
```
public void validateConstraints(String propertyName)
                         throws PropertyException
```
    Description copied from class: PropertyType
    
    A PropertyType can have some constraints here is where they are validated.
    The constraints of a PropertyType is always assumed to be valid, but what if they are not.
    Example: What if you have define the MIN value to be larger than the MAX value. The result will be that no value will ever be validated successfully.
    This is the method where we validate the constraints of a PropertyType before any value is actually validated.
    Any many cases this will not be nessecary.
    This method is call in Property.validate(); Overrides: validateConstraints in class PropertyType<Proxy> Parameters: propertyName - the name of the property used for logging purposes, to identify the unique property which PropertyType has constraint issues. Throws: PropertyException - if the constraints have invalid/conflicting values. See Also: Property.validate()
  validateValue public Proxy 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<Proxy> 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. toString public String toString(String propertyName, Proxy t) throws PropertyException Description copied from class: PropertyType Converts a typed to the string representation. This must be associative, so the string generate here will successful validate. This is enforced, so the converted string is sub sequencetially validate with the validate method. In some of the property sub types, this method is overridden to ensure above rule. Overrides: toString in class PropertyType<Proxy> Parameters: propertyName - the name of the property used for logging purposes. t - the type T. Returns: The string representation of the type. Throws: PropertyException - if conversion failed in validation. See Also: PropertyType.validate(String, String)

Class ProxyPropertyType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class dk.heick.properties.PropertyType

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_DIVIDER

TYPE

Constructor Detail

ProxyPropertyType

ProxyPropertyType

ProxyPropertyType

ProxyPropertyType

Method Detail

getDivider

getRestrictions

validateConstraints

validateValue

toString