LdapNamePropertyType (JHPropertiesTyped

java.lang.Object
- dk.heick.properties.PropertyType<LdapName>
- - dk.heick.properties.types.LdapNamePropertyType

All Implemented Interfaces:: Serializable

public class LdapNamePropertyType
extends PropertyType<LdapName>

PropertyType that validates to a LdapName value.
This type convert and validates a string to a javax.naming.ldap.LdapName.

Constructor Example			Comments
Property<LdapName> A_PROPERTY = new Property<LdapName>("name", new LdapNamePropertyType());			Default value is `null`.
Property<LdapName> A_PROPERTY = new Property<LdapName>("name", new LdapNamePropertyType(new LdapName("cn=Mango,ou=Fruits,o=Food")));			Default value is `new LdapName("cn=Mango,ou=Fruits,o=Food")`.
Property<LdapName> A_PROPERTY = new Property<LdapName>("name", new LdapNamePropertyType(",dc=example,dc=com",new LdapName("cn=Mango,dc=example,dc=com")));			`",dc=example,dc=com"` will be append the value before validation, default value is `new LdapName("cn=Mango,dc=example,dc=com")`.
Type of value(s)	Examples	Result	Comments
Valid	cn=Mango,ou=Fruits,o=Food	new LdapName("cn=Mango,ou=Fruits,o=Food")	Validate successfully.
Valid	cn=WaterMelon,ou=Summer,ou=Fruits,o=Food,o=Resources	new LdapName("cn=WaterMelon,ou=Summer,ou=Fruits,o=Food,o=Resources")
Valid	«empty string»	new LdapName("")
Invalid	cow	`null`	Validate will throw an exception. The resulting value is `null`.
Invalid	«only spaces»	`null`
Invalid	`null`	`defaultValue` OR `null`	Validate will throw an exception. Return default value if set, otherwise `null`.

Since:: 1.3
Author:: Frederik Heick
See Also:: LdapName, Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String TYPE
The type name string constant of LdapNamePropertyType

Fields
Modifier and Type	Field and Description
`static String`	`TYPE` The type name string constant of LdapNamePropertyType

Constructor Summary

Constructors
Constructor and Description
`LdapNamePropertyType()` Returns `LdapNamePropertyType` where the default value is `null`, `baseDN` is `null` and "allowEmptyString" is set to `true` The attribute "allowEmptyString" is set to `true`.
`LdapNamePropertyType(boolean allowEmptyString)` Returns `LdapNamePropertyType` where the default value is `null` and `baseDN` is `null`.
`LdapNamePropertyType(LdapName defaultValue)` Returns `LdapNamePropertyType` with default value.
`LdapNamePropertyType(String baseDN)` Returns `LdapNamePropertyType` with no default value, but with `baseDN` set.
`LdapNamePropertyType(String baseDN, boolean allowEmptyString)` Returns `LdapNamePropertyType` with no default value, but with `baseDN` set.
`LdapNamePropertyType(String baseDN, LdapName defaultValue)` Returns `LdapNamePropertyType` with default value, and with `baseDN` set..
`LdapNamePropertyType(String baseDN, LdapName defaultValue, boolean allowEmptyString)` Returns `LdapNamePropertyType` with default value,with `baseDN` set.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBaseDN()` The string post appended the value before validation.
`List<String>`	`getRestrictions()` Gets a detailed description of the PropertyType with any constraints that might influence the validation.
`boolean`	`isAllowEmptyString()` Normally the class `LdapName` will allow an empty string, fx.
`void`	`setAllowEmptyString(boolean allowEmptyString)` Sets if an empty string is allowed as ldap name value.
`void`	`setBaseDN(String baseDN)` Sets the baseDN
`LdapName`	`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 LdapNamePropertyType
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LdapNamePropertyType
```
public LdapNamePropertyType()
```
    Returns LdapNamePropertyType where the default value is null, baseDN is null and "allowEmptyString" is set to true
    The attribute "allowEmptyString" is set to true.
  - LdapNamePropertyType
```
public LdapNamePropertyType(boolean allowEmptyString)
```
    Returns LdapNamePropertyType where the default value is null and baseDN is null.
    
    Parameters:
    
    allowEmptyString - normally the class LdapName will allow an empty string, fx. new LdapName(""). Set this to false and a exception will be thrown in validate if the value is empty.
  - LdapNamePropertyType
```
public LdapNamePropertyType(LdapName defaultValue)
```
    Returns LdapNamePropertyType with default value. The attribute "allowEmptyString" is set to true and baseDN is null.
    
    Parameters:
    
    defaultValue - default value returned if property value is undefined.
  - LdapNamePropertyType
```
public LdapNamePropertyType(String baseDN)
```
    Returns LdapNamePropertyType with no default value, but with baseDN set. The attribute "allowEmptyString" is set to true.
    
    Parameters:
    
    baseDN - this will append the value if it does not already ends with this value. This is done before validation This is to avoid really long names and to ensure and specific node is used. It will not be used if the value is null or an empty string after trim.
  - LdapNamePropertyType
```
public LdapNamePropertyType(String baseDN,
                            LdapName defaultValue)
```
    Returns LdapNamePropertyType with default value, and with baseDN set.. The attribute "allowEmptyString" is set to true.
    
    Parameters:
    
    baseDN - this will append the value if it does not already ends with this value. This is done before validation This is to avoid really long names and to ensure and specific node is used. It will not be used if the value is null or an empty string after trim.
    
    defaultValue - defaultValue default value returned if property value is undefined.
  - LdapNamePropertyType
```
public LdapNamePropertyType(String baseDN,
                            boolean allowEmptyString)
```
    Returns LdapNamePropertyType with no default value, but with baseDN set.
    
    Parameters:
    
    baseDN - this will append the value if it does not already ends with this value. This is done before validation This is to avoid really long names and to ensure and specific node is used. It will not be used if the value is null or an empty string after trim.
    
    allowEmptyString - normally the class LdapName will allow an empty string, fx. new LdapName(""). Set this to false and a exception will be thrown in validate if the value is empty.
  - LdapNamePropertyType
```
public LdapNamePropertyType(String baseDN,
                            LdapName defaultValue,
                            boolean allowEmptyString)
```
    Returns LdapNamePropertyType with default value,with baseDN set.
    
    Parameters:
    
    baseDN - this will append the value if it does not already ends with this value. This is done before validation This is to avoid really long names and to ensure and specific node is used. It will not be used if the value is null or an empty string after trim.
    
    defaultValue - defaultValue default value returned if property value is undefined.
    
    allowEmptyString - normally the class LdapName will allow an empty string, fx. new LdapName(""). Set this to false and a exception will be thrown in validate if the value is empty.
- 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<LdapName>
    
    Returns:
    
    the restrictions of the PropertyType as a list of strings.
  - validateValue
```
public LdapName 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<LdapName>
    
    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.
  - isAllowEmptyString
```
public boolean isAllowEmptyString()
```
    Normally the class LdapName will allow an empty string, fx. new LdapName(""). Set this to false and a exception will be thrown in validate if the value is empty.
    
    Returns:
    
    true if an emprty string is allowed, otherwise false.
  - getBaseDN
```
public String getBaseDN()
```
    The string post appended the value before validation.
    This will only be used if :
    - the property value not already ends with this value.
    - the postAppend value is not null and not empty.
    - the property value is not null and not empty.
    Returns:
    
    the post append value.
  - setAllowEmptyString
```
public void setAllowEmptyString(boolean allowEmptyString)
```
    Sets if an empty string is allowed as ldap name value.
    
    Parameters:
    
    allowEmptyString - true if it is allowed, otherwise false.
  - setBaseDN
```
public void setBaseDN(String baseDN)
```
    Sets the baseDN
    
    Parameters:
    
    baseDN - the baseDN

Class LdapNamePropertyType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class dk.heick.properties.PropertyType

Methods inherited from class java.lang.Object

Field Detail

TYPE

Constructor Detail

LdapNamePropertyType

LdapNamePropertyType

LdapNamePropertyType

LdapNamePropertyType

LdapNamePropertyType

LdapNamePropertyType

LdapNamePropertyType

Method Detail

getRestrictions

validateValue

isAllowEmptyString

getBaseDN

setAllowEmptyString

setBaseDN